Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
multiDimPolyFunctions Class Referenceabstract

base class for polynomial functions More...

Inheritance diagram for multiDimPolyFunctions:
[legend]
Collaboration diagram for multiDimPolyFunctions:
[legend]

Public Member Functions

 TypeName ("multiDimPolyFunctions")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, multiDimPolyFunctions, word,(const Vector< label > dirs),(dirs))
 
 multiDimPolyFunctions (const labelVector &dirs)
 Construct with directions. More...
 
virtual ~multiDimPolyFunctions ()=default
 Destructor. More...
 
virtual scalar value (const vector &vec)=0
 
virtual const scalarField & termValues (const vector &vec)=0
 
label & nTerms ()
 
scalarField & coeffs ()
 

Static Public Member Functions

static autoPtr< multiDimPolyFunctions > New (const word &multiDimPolyFunctionsType, const labelVector &dirs)
 Select a multiDimPolyFunctions. More...
 

Protected Attributes

label nTerms_
 Number of polynomial term. More...
 
const labelVector geomDir_
 
vector geomCorrection_
 
scalarField coeffs_
 
scalarField termValues_
 

Detailed Description

base class for polynomial functions

Original code supplied by Henning Scheufler, DLR (2019)

Source files

Definition at line 56 of file multiDimPolyFunctions.H.

Constructor & Destructor Documentation

◆ multiDimPolyFunctions()

multiDimPolyFunctions ( const labelVector &  dirs)
explicit

Construct with directions.

Definition at line 67 of file multiDimPolyFunctions.C.

◆ ~multiDimPolyFunctions()

virtual ~multiDimPolyFunctions ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "multiDimPolyFunctions"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
multiDimPolyFunctions  ,
word  ,
(const Vector< label > dirs)  ,
(dirs)   
)

◆ New()

Foam::autoPtr< Foam::multiDimPolyFunctions > New ( const word &  multiDimPolyFunctionsType,
const labelVector &  dirs 
)
static

Select a multiDimPolyFunctions.

Definition at line 44 of file multiDimPolyFunctions.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInLookup.

Here is the call graph for this function:

◆ value()

virtual scalar value ( const vector &  vec)
pure virtual

Implemented in polyDegree1.

◆ termValues()

virtual const scalarField& termValues ( const vector &  vec)
pure virtual

Implemented in polyDegree1.

◆ nTerms()

label& nTerms ( )
inline

Definition at line 120 of file multiDimPolyFunctions.H.

References multiDimPolyFunctions::nTerms_.

◆ coeffs()

scalarField& coeffs ( )
inline

Definition at line 125 of file multiDimPolyFunctions.H.

References multiDimPolyFunctions::coeffs_.

Member Data Documentation

◆ nTerms_

label nTerms_
protected

Number of polynomial term.

Definition at line 63 of file multiDimPolyFunctions.H.

Referenced by multiDimPolyFunctions::nTerms().

◆ geomDir_

const labelVector geomDir_
protected

Definition at line 65 of file multiDimPolyFunctions.H.

Referenced by polyDegree1::value().

◆ geomCorrection_

vector geomCorrection_
protected

Definition at line 67 of file multiDimPolyFunctions.H.

◆ coeffs_

scalarField coeffs_
protected

Definition at line 69 of file multiDimPolyFunctions.H.

Referenced by multiDimPolyFunctions::coeffs(), and polyDegree1::value().

◆ termValues_

scalarField termValues_
protected

Definition at line 71 of file multiDimPolyFunctions.H.

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