topOInterpolationFunction Class Referenceabstract
Inheritance diagram for topOInterpolationFunction:
Collaboration diagram for topOInterpolationFunction:

Public Member Functions

 TypeName ("topOInterpolationFunction")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, topOInterpolationFunction, dictionary,(const fvMesh &mesh, const dictionary &dict),(mesh, dict))
 
 topOInterpolationFunction (const fvMesh &mesh, const dictionary &dict)
 Construct from components. More...
 
virtual ~topOInterpolationFunction ()=default
 Destructor. More...
 
virtual void interpolate (const scalarField &arg, scalarField &res) const =0
 Interpolate argument to result. More...
 
virtual tmp< scalarFieldderivative (const scalarField &arg) const =0
 Return of function with respect to the argument field. More...
 
virtual void setLengthScaleParam (const scalar lengthScale)
 Set the parameter determining length scale. More...
 

Static Public Member Functions

static autoPtr< topOInterpolationFunctionNew (const fvMesh &mesh, const dictionary &dict)
 Return an autoPtr to the selected interpolation type. More...
 

Protected Attributes

const fvMeshmesh_
 
dictionary dict_
 

Detailed Description

Definition at line 50 of file topOInterpolationFunction.H.

Constructor & Destructor Documentation

◆ topOInterpolationFunction()

topOInterpolationFunction ( const fvMesh mesh,
const dictionary dict 
)

Construct from components.

Definition at line 37 of file topOInterpolationFunction.C.

◆ ~topOInterpolationFunction()

virtual ~topOInterpolationFunction ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "topOInterpolationFunction"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
topOInterpolationFunction  ,
dictionary  ,
(const fvMesh &mesh, const dictionary &dict ,
(mesh, dict  
)

◆ New()

Foam::autoPtr< Foam::topOInterpolationFunction > New ( const fvMesh mesh,
const dictionary dict 
)
static

Return an autoPtr to the selected interpolation type.

Definition at line 51 of file topOInterpolationFunction.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, and mesh.

Here is the call graph for this function:

◆ interpolate()

virtual void interpolate ( const scalarField arg,
scalarField res 
) const
pure virtual

◆ derivative()

◆ setLengthScaleParam()

void setLengthScaleParam ( const scalar  lengthScale)
virtual

Set the parameter determining length scale.

Warning if the selected interpolation function has no such param

Reimplemented in tanhInterpolation.

Definition at line 80 of file topOInterpolationFunction.C.

References Foam::endl(), and WarningInFunction.

Here is the call graph for this function:

Member Data Documentation

◆ mesh_

◆ dict_

dictionary dict_
protected

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