sinImplicitFunction Class Reference

Original code supplied by Henning Scheufler, DLR (2019) More...

Inheritance diagram for sinImplicitFunction:

Collaboration diagram for sinImplicitFunction:

Public Member Functions
	TypeName ("sin")
	Runtime type information. More...
	sinImplicitFunction (const scalar period, const scalar phase, const scalar amplitude, const vector &direction, const vector &up, const vector &origin)
	Construct from components. More...
	sinImplicitFunction (const dictionary &dict)
	Construct from dictionary (used by implicitFunctions) More...
virtual	~sinImplicitFunction ()=default
	Destructor. More...
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. More...
	declareRunTimeSelectionTable (autoPtr, implicitFunction, dict,(const dictionary &dict),(dict))
	Declare run-time constructor selection table. More...
	implicitFunction ()=default
	Default construct. More...
virtual	~implicitFunction ()=default
	Destructor. More...
virtual scalar	value (const vector &p) const
virtual vector	grad (const vector &p) const
virtual scalar	distanceToSurfaces (const vector &p) const

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. More...

Detailed Description

Original code supplied by Henning Scheufler, DLR (2019)

Source files

• sinImplicitFunction.H
• sinImplicitFunction.C

Definition at line 55 of file sinImplicitFunction.H.

Constructor & Destructor Documentation

sinImplicitFunction() [1/2]

sinImplicitFunction	(	const scalar	period,
		const scalar	phase,
		const scalar	amplitude,
		const vector &	direction,
		const vector &	up,
		const vector &	origin
	)

Construct from components.

sinImplicitFunction() [2/2]

sinImplicitFunction ( const dictionary &  dict )

explicit

Construct from dictionary (used by implicitFunctions)

~sinImplicitFunction()

virtual ~sinImplicitFunction ( )

virtualdefault

Destructor.

Member Function Documentation

TypeName()

TypeName

(

"sin"

)

Runtime type information.

value()

virtual scalar value ( const vector &  p ) const

inlinevirtual

Reimplemented from implicitFunction.

Definition at line 107 of file sinImplicitFunction.H.

References p, Foam::constant::mathematical::pi(), Foam::sin(), and x.

Here is the call graph for this function:

grad()

virtual vector grad ( const vector &  p ) const

inlinevirtual

Reimplemented from implicitFunction.

Definition at line 118 of file sinImplicitFunction.H.

References NotImplemented, and Foam::Zero.

distanceToSurfaces()

virtual scalar distanceToSurfaces ( const vector &  p ) const

inlinevirtual

Reimplemented from implicitFunction.

Definition at line 124 of file sinImplicitFunction.H.

References NotImplemented.

---

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

• applications/utilities/preProcessing/setAlphaField/alphaFieldFunctions/implicitFunctions/sin/sinImplicitFunction.H