implicitFunction Class Reference

Base class for implicit functions. More...

#include <implicitFunction.H>

Inheritance diagram for implicitFunction:

Public Member Functions
	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.
virtual scalar	value (const vector &p) const
virtual vector	grad (const vector &p) const
virtual scalar	distanceToSurfaces (const vector &p) const

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

Detailed Description

Base class for implicit functions.

Original code supplied by Henning Scheufler, DLR (2019)

Source files

• implicitFunction.H
• implicitFunction.C

Definition at line 52 of file implicitFunction.H.

Constructor & Destructor Documentation

implicitFunction()

implicitFunction ( )

default

Default construct.

Referenced by declareRunTimeSelectionTable().

Here is the caller graph for this function:

~implicitFunction()

virtual ~implicitFunction ( )

virtualdefault

Destructor.

Member Function Documentation

TypeName()

TypeName

(

"implicitFunction"

)

Runtime type information.

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		implicitFunction	,
		dict	,
		(const dictionary &dict)	,
		(dict)	)

Declare run-time constructor selection table.

References dict, and implicitFunction().

Here is the call graph for this function:

New()

autoPtr< implicitFunction > New ( const word & implicitFunctionType, const dictionary & dict )

static

Return a reference to the selected implicitFunction.

References dict.

value()

virtual scalar value ( const vector & p ) const

inlinevirtual

Reimplemented in composedFunctionImplicitFunction, cylinderImplicitFunction, ellipsoidImplicitFunction, paraboloidImplicitFunction, planeImplicitFunction, sinImplicitFunction, and sphereImplicitFunction.

Definition at line 102 of file implicitFunction.H.

References p.

grad()

virtual vector grad ( const vector & p ) const

inlinevirtual

Reimplemented in composedFunctionImplicitFunction, cylinderImplicitFunction, ellipsoidImplicitFunction, paraboloidImplicitFunction, planeImplicitFunction, sinImplicitFunction, and sphereImplicitFunction.

Definition at line 107 of file implicitFunction.H.

References VectorSpace< Form, Cmpt, Ncmpts >::max, and p.

distanceToSurfaces()

virtual scalar distanceToSurfaces ( const vector & p ) const

inlinevirtual

Reimplemented in composedFunctionImplicitFunction, cylinderImplicitFunction, ellipsoidImplicitFunction, paraboloidImplicitFunction, planeImplicitFunction, sinImplicitFunction, and sphereImplicitFunction.

Definition at line 112 of file implicitFunction.H.

References p.

---

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

• applications/utilities/preProcessing/setAlphaField/alphaFieldFunctions/implicitFunctions/implicitFunction.H