Public Member Functions | List of all members
Polynomial< Type > Class Template Reference
Inheritance diagram for Polynomial< Type >:
Inheritance graph
[legend]
Collaboration diagram for Polynomial< Type >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("polynomial")
 Runtime type information. More...
 
 Polynomial (const word &entryName, const dictionary &dict)
 
 Polynomial (const word &entryName, const List< Tuple2< Type, Type >> &)
 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 ()
 Destructor. More...
 
virtual void convertTimeBase (const Time &t)
 Convert time. More...
 
Type value (const scalar x) const
 Return Polynomial value. More...
 
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 Function1< Type > &de)
 Copy constructor. More...
 
virtual ~Function1 ()
 Destructor. More...
 
const wordname () const
 Return the name of the entry. 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...
 
- Public Member Functions inherited from refCount
int count () const
 Return the current reference count. More...
 
bool unique () const
 Return true if the reference count is zero. More...
 
void operator++ ()
 Increment the reference count. More...
 
void operator++ (int)
 Increment the reference count. More...
 
void operator-- ()
 Decrement the reference count. More...
 
void operator-- (int)
 Decrement the reference count. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Function1< Type >
static autoPtr< Function1< Type > > New (const word &entryName, const dictionary &dict)
 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 refCount
 refCount ()
 Construct null initializing count to 0. More...
 
- Protected Attributes inherited from Function1< Type >
const word name_
 Name of entry. More...
 

Detailed Description

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

Definition at line 63 of file PolynomialEntry.H.

Constructor & Destructor Documentation

◆ Polynomial() [1/3]

Polynomial ( const word entryName,
const dictionary dict 
)

Definition at line 32 of file PolynomialEntry.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, dictionary::lookup(), Foam::mag(), Foam::nl, and WarningInFunction.

Referenced by Polynomial< Type >::clone().

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

◆ Polynomial() [2/3]

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

Construct from components.

Definition at line 76 of file PolynomialEntry.C.

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

Here is the call graph for this function:

◆ Polynomial() [3/3]

Polynomial ( const Polynomial< Type > &  poly)

Copy constructor.

Definition at line 114 of file PolynomialEntry.C.

◆ ~Polynomial()

~Polynomial ( )
virtual

Destructor.

Definition at line 125 of file PolynomialEntry.C.

Referenced by Polynomial< Type >::clone().

Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "polynomial"  )

Runtime type information.

◆ clone()

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

◆ convertTimeBase()

void convertTimeBase ( const Time t)
virtual

Convert time.

Reimplemented from Function1< Type >.

Definition at line 132 of file PolynomialEntry.C.

References Foam::component(), forAll, Foam::setComponent(), TimeState::userTimeToTime(), and Polynomial< Type >::value().

Referenced by Polynomial< Type >::clone().

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

◆ value()

Type value ( const scalar  x) const
virtual

Return Polynomial value.

Reimplemented from Function1< Type >.

Definition at line 147 of file PolynomialEntry.C.

References Foam::cmptMultiply(), Foam::cmptPow(), forAll, Polynomial< Type >::integrate(), y, and Foam::Zero.

Referenced by Polynomial< Type >::clone(), and Polynomial< Type >::convertTimeBase().

Here is the call graph for this function:
Here is the caller 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 165 of file PolynomialEntry.C.

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

Referenced by Polynomial< Type >::clone(), and Polynomial< Type >::value().

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

◆ writeData()

void writeData ( Ostream os) const
virtual

Write in dictionary format.

Reimplemented from Function1< Type >.

Definition at line 202 of file PolynomialEntry.C.

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

Referenced by Polynomial< Type >::clone().

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

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