Polynomial< Type > Class Template Reference
Inheritance diagram for Polynomial< Type >:
[legend]
Collaboration diagram for Polynomial< Type >:
[legend]

Public Member Functions

 TypeName ("polynomial")
 Runtime type information. More...
 
 Polynomial (const word &entryName, const dictionary &dict)
 Construct from entry name and dictionary. More...
 
 Polynomial (const word &entryName, const List< Tuple2< Type, Type >> &coeffs)
 Construct from components. More...
 
 Polynomial (const Polynomial &poly)
 Copy constructor. More...
 
virtual tmp< Function1< Type > > clone () const
 Construct and return a clone. More...
 
virtual ~Polynomial ()=default
 Destructor. More...
 
virtual void convertTimeBase (const Time &t)
 Convert time. More...
 
virtual Type value (const scalar x) const
 Return Polynomial value. More...
 
virtual Type integrate (const scalar x1, const scalar x2) const
 Integrate between two (scalar) values. More...
 
virtual void writeData (Ostream &os) const
 Write in dictionary format. More...
 
- Public Member Functions inherited from Function1< Type >
 TypeName ("Function1") declareRunTimeSelectionTable(autoPtr
 Runtime type information. More...
 
 Function1 (const word &entryName)
 Construct from entry name. More...
 
 Function1 (const word &entryName, const dictionary &dict)
 Construct from entry name and dictionary. More...
 
 Function1 (const Function1< Type > &rhs)
 Copy construct. More...
 
virtual ~Function1 ()=default
 Destructor. More...
 
virtual tmp< Field< Type > > value (const scalarField &x) const
 Return value as a function of (scalar) independent variable. More...
 
virtual tmp< Field< Type > > integrate (const scalarField &x1, const scalarField &x2) const
 Integrate between two (scalar) values. More...
 
void writeEntries (Ostream &os) const
 Write coefficient entries in dictionary format. More...
 

Additional Inherited Members

- Public Types inherited from Function1< Type >
typedef Type returnType
 
- Static Public Member Functions inherited from Function1< Type >
static autoPtr< Function1< Type > > New (const word &entryName, const dictionary &dict, const word &redirectType, const bool mandatory=true)
 Selector, with fallback redirection. More...
 
static autoPtr< Function1< Type > > NewCompat (const word &entryName, std::initializer_list< std::pair< const char *, int >> compat, const dictionary &dict, const word &redirectType=word::null, const bool mandatory=true)
 Compatibility selector, with fallback redirection. More...
 
static autoPtr< Function1< Type > > New (const word &entryName, const dictionary &dict, const bool mandatory=true)
 Selector, without fallback redirection. More...
 
static autoPtr< Function1< Type > > NewIfPresent (const word &entryName, const dictionary &dict, const word &redirectType=word::null)
 An optional selector. More...
 
- Public Attributes inherited from Function1< Type >
 Function1
 
 dictionary
 
const wordentryName
 
const word const dictionarydict
 
const word const dictionary entryName
 
const word const dictionary dict
 
- Protected Member Functions inherited from Function1< Type >
void operator= (const Function1< Type > &)=delete
 No copy assignment. More...
 

Detailed Description

template<class Type>
class Foam::Function1Types::Polynomial< Type >

Definition at line 65 of file PolynomialEntry.H.

Constructor & Destructor Documentation

◆ Polynomial() [1/3]

Polynomial ( const word entryName,
const dictionary dict 
)

Construct from entry name and dictionary.

Definition at line 35 of file PolynomialEntry.C.

References Foam::expressions::patchExpr::debug, dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::mag(), Foam::name(), Foam::nl, and WarningInFunction.

Here is the call graph for this function:

◆ Polynomial() [2/3]

Polynomial ( const word entryName,
const List< Tuple2< Type, Type >> &  coeffs 
)

Construct from components.

Definition at line 80 of file PolynomialEntry.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::mag(), Foam::name(), Foam::nl, and WarningInFunction.

Here is the call graph for this function:

◆ Polynomial() [3/3]

Polynomial ( const Polynomial< Type > &  poly)
explicit

Copy constructor.

Definition at line 119 of file PolynomialEntry.C.

◆ ~Polynomial()

virtual ~Polynomial ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "polynomial"  )

Runtime type information.

◆ clone()

virtual tmp<Function1<Type> > clone ( ) const
inlinevirtual

Construct and return a clone.

Implements Function1< Type >.

Definition at line 106 of file PolynomialEntry.H.

◆ convertTimeBase()

void convertTimeBase ( const Time t)
virtual

Convert time.

Definition at line 130 of file PolynomialEntry.C.

References Foam::component(), forAll, Foam::setComponent(), and TimeState::userTimeToTime().

Here is the call graph for this function:

◆ value()

Type value ( const scalar  x) const
virtual

Return Polynomial value.

Reimplemented from Function1< Type >.

Definition at line 145 of file PolynomialEntry.C.

References Foam::cmptMultiply(), Foam::cmptPow(), forAll, x, y, and Foam::Zero.

Here is the call graph for this function:

◆ integrate()

Type integrate ( const scalar  x1,
const scalar  x2 
) const
virtual

Integrate between two (scalar) values.

Reimplemented from Function1< Type >.

Definition at line 163 of file PolynomialEntry.C.

References Foam::cmptDivide(), Foam::cmptMultiply(), Foam::cmptPow(), forAll, and Foam::Zero.

Here is the call graph for this function:

◆ writeData()

void writeData ( Ostream os) const
virtual

Write in dictionary format.

Reimplemented from Function1< Type >.

Definition at line 200 of file PolynomialEntry.C.

References token::END_STATEMENT, Foam::indent(), Foam::nl, and Function1< Type >::writeData().

Here is the call graph for this function:

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