Loading...
Searching...
No Matches
multiDimPolyFunctions Class Referenceabstract

base class for polynomial functions More...

#include <multiDimPolyFunctions.H>

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

Public Member Functions

 TypeName ("multiDimPolyFunctions")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, multiDimPolyFunctions, word,(const Vector< label > dirs),(dirs))
 multiDimPolyFunctions (const labelVector &dirs)
 Construct with directions.
virtual ~multiDimPolyFunctions ()=default
 Destructor.
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.

Protected Attributes

label nTerms_
 Number of polynomial term.
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 52 of file multiDimPolyFunctions.H.

Constructor & Destructor Documentation

◆ multiDimPolyFunctions()

multiDimPolyFunctions ( const labelVector & dirs)
explicit

Construct with directions.

Definition at line 60 of file multiDimPolyFunctions.C.

References coeffs_, geomCorrection_, geomDir_, nTerms_, Foam::pos0(), termValues_, x, and y.

Referenced by declareRunTimeSelectionTable(), and polyDegree1::polyDegree1().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ~multiDimPolyFunctions()

virtual ~multiDimPolyFunctions ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "multiDimPolyFunctions" )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

References multiDimPolyFunctions().

Here is the call graph for this function:

◆ New()

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

Select a multiDimPolyFunctions.

Definition at line 36 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 126 of file multiDimPolyFunctions.H.

References nTerms_.

◆ coeffs()

scalarField & coeffs ( )
inline

Definition at line 131 of file multiDimPolyFunctions.H.

References coeffs_.

Member Data Documentation

◆ nTerms_

label nTerms_
protected

Number of polynomial term.

Definition at line 61 of file multiDimPolyFunctions.H.

Referenced by multiDimPolyFunctions(), nTerms(), and polyDegree1::polyDegree1().

◆ geomDir_

const labelVector geomDir_
protected

Definition at line 63 of file multiDimPolyFunctions.H.

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

◆ geomCorrection_

vector geomCorrection_
protected

Definition at line 65 of file multiDimPolyFunctions.H.

Referenced by multiDimPolyFunctions().

◆ coeffs_

scalarField coeffs_
protected

Definition at line 67 of file multiDimPolyFunctions.H.

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

◆ termValues_

scalarField termValues_
protected

Definition at line 69 of file multiDimPolyFunctions.H.

Referenced by multiDimPolyFunctions(), polyDegree1::polyDegree1(), and polyDegree1::termValues().

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