planeImplicitFunction Class Reference

creates a plane More...

#include <planeImplicitFunction.H>

Inheritance diagram for planeImplicitFunction:

Collaboration diagram for planeImplicitFunction:

Public Member Functions
	TypeName ("plane")
	Runtime type information.
	planeImplicitFunction (const vector &origin, const vector &normal)
	Construct from components.
	planeImplicitFunction (const dictionary &dict)
	Construct from dictionary (used by implicitFunctions).
virtual	~planeImplicitFunction ()=default
	Destructor.
virtual scalar	value (const vector &p) const
virtual vector	grad (const vector &p) const
virtual scalar	distanceToSurfaces (const vector &p) const
Public Member Functions inherited from implicitFunction
	TypeName ("implicitFunction")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, implicitFunction, dict,(const dictionary &dict),(dict))
	Declare run-time constructor selection table.
	implicitFunction ()=default
	Default construct.
virtual	~implicitFunction ()=default
	Destructor.

Additional Inherited Members
Static Public Member Functions inherited from implicitFunction
static autoPtr< implicitFunction >	New (const word &implicitFunctionType, const dictionary &dict)
	Return a reference to the selected implicitFunction.

Detailed Description

creates a plane

Original code supplied by Henning Scheufler, DLR (2019)

Source files

• planeImplicitFunction.H
• planeImplicitFunction.C

Definition at line 53 of file planeImplicitFunction.H.

Constructor & Destructor Documentation

planeImplicitFunction() [1/2]

planeImplicitFunction	(	const vector &	origin,
		const vector &	normal )

Construct from components.

planeImplicitFunction() [2/2]

planeImplicitFunction ( const dictionary & dict )

explicit

Construct from dictionary (used by implicitFunctions).

References dict.

~planeImplicitFunction()

virtual ~planeImplicitFunction ( )

virtualdefault

Destructor.

Member Function Documentation

TypeName()

TypeName

(

"plane"

)

Runtime type information.

value()

virtual scalar value ( const vector & p ) const

inlinevirtual

Reimplemented from implicitFunction.

Definition at line 99 of file planeImplicitFunction.H.

References p.

grad()

virtual vector grad ( const vector & p ) const

inlinevirtual

Reimplemented from implicitFunction.

Definition at line 104 of file planeImplicitFunction.H.

References p.

distanceToSurfaces()

virtual scalar distanceToSurfaces ( const vector & p ) const

inlinevirtual

Reimplemented from implicitFunction.

Definition at line 110 of file planeImplicitFunction.H.

References Foam::mag(), and p.

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• applications/utilities/preProcessing/setAlphaField/alphaFieldFunctions/implicitFunctions/plane/planeImplicitFunction.H