integratedNonUniformTable Class Reference

Non-uniform tabulated property function that linearly interpolates between the values. More...

Inheritance diagram for integratedNonUniformTable:
Collaboration diagram for integratedNonUniformTable:

Public Member Functions

 TypeName ("integratedNonUniformTable")
 Runtime type information. More...
 
 integratedNonUniformTable (const word &name, const unitConversions &units, const dictionary &dict)
 Construct from entry name and dictionary. More...
 
scalar intfdT (scalar T) const
 Integrate the function and return the result. More...
 
scalar intfByTdT (scalar T) const
 Integrate the function divided by T and return the result. More...
 
void write (Ostream &os, const unitConversions &units) const
 Write the function coefficients. More...
 
- Public Member Functions inherited from NonUniformTable< scalar >
 TypeName ("nonUniformTable")
 Runtime type information. More...
 
 NonUniformTable (const word &name, const Function1s::unitConversions &units, const dictionary &dict)
 Construct from name and dictionary. More...
 
 NonUniformTable (const NonUniformTable< scalar > &nut)
 Copy constructor. More...
 
const List< Tuple2< scalar, scalar > > & values () const
 Return the non-uniform table of values. More...
 
virtual scalar value (scalar x) const
 Evaluate the function and return the result. More...
 
virtual scalar integral (const scalar x1, const scalar x2) const
 Integrate between two scalar values. More...
 
scalar dfdT (scalar T) const
 Evaluate the derivative of the function and return the result. More...
 
void write (Ostream &os, const unitConversions &units) const
 Write the function coefficients. More...
 
void operator= (const NonUniformTable< scalar > &)
 Assignment. More...
 
- Public Member Functions inherited from FieldFunction1< Type, Function1Type >
 FieldFunction1 (const word &name)
 Construct from name. More...
 
virtual tmp< Function1< Type > > clone () const
 Construct and return a clone. More...
 
virtual ~FieldFunction1 ()
 Destructor. More...
 
virtual tmp< Field< Type > > value (const scalarField &x) const
 Return value as a function of one scalar field. More...
 
virtual tmp< Field< Type > > integral (const scalarField &x1, const scalarField &x2) const
 Integrate between two scalar fields. More...
 
- Public Member Functions inherited from Function1< Type >
 TypeName ("Function1")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, Function1, dictionary,(const word &name, const Function1s::unitConversions &units, const dictionary &dict),(name, units, dict))
 
 declareRunTimeSelectionTable (autoPtr, Function1, Istream,(const word &name, const Function1s::unitConversions &units, Istream &is),(name, units, is))
 
 Function1 (const word &name)
 Construct from name. More...
 
 Function1 (const Function1< Type > &f1)
 Copy constructor. More...
 
virtual ~Function1 ()
 Destructor. More...
 
const wordname () const
 Return the name of the entry. More...
 
virtual bool constant () const
 Is this function guaranteed to be constant? More...
 
void operator= (const Function1< Type > &)
 Assignment. 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...
 
void operator= (const refCount &)=delete
 Disallow bitwise assignment. 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 &name, const Function1s::unitConversions &units, const dictionary &dict)
 Select from dictionary. More...
 
static autoPtr< Function1< Type > > New (const word &name, const unitConversion &xUnits, const unitConversion &valueUnits, const dictionary &dict)
 Select from dictionary. More...
 
static autoPtr< Function1< Type > > New (const word &name, const Function1s::unitConversions &units, const word &Function1Type, Istream &is)
 Select from Istream. More...
 
static autoPtr< Function1< Type > > New (const word &name, const unitConversion &xUnits, const unitConversion &valueUnits, const word &Function1Type, Istream &is)
 Select from Istream. More...
 
- Protected Member Functions inherited from NonUniformTable< scalar >
label index (scalar x) const
 Return the lower index of the interval in the table. More...
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 
 refCount (const refCount &)=delete
 Disallow copy. More...
 
- Protected Attributes inherited from Function1< Type >
const word name_
 Name of entry. More...
 

Detailed Description

Non-uniform tabulated property function that linearly interpolates between the values.

To speed-up the search of the non-uniform table a uniform jump-table is created on construction which is used for fast indirect addressing into the table.

Usage
Property Description
values List of value pairs

Example for the density of water between 280 and 350K

    rho
    {
        type    integratedNonUniformTable;

        values
        (
            (280 999.87)
            (300 995.1)
            (350 973.7)
        );
    }

Definition at line 79 of file integratedNonUniformTable1.H.

Constructor & Destructor Documentation

◆ integratedNonUniformTable()

integratedNonUniformTable ( const word name,
const unitConversions units,
const dictionary dict 
)

Member Function Documentation

◆ TypeName()

TypeName ( "integratedNonUniformTable"  )

Runtime type information.

◆ intfdT()

Foam::scalar intfdT ( scalar  T) const

Integrate the function and return the result.

Definition at line 78 of file integratedNonUniformTable1.C.

References lambda(), and Foam::T().

Referenced by integratedNonUniformTable::integratedNonUniformTable().

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

◆ intfByTdT()

Foam::scalar intfByTdT ( scalar  T) const

Integrate the function divided by T and return the result.

Definition at line 95 of file integratedNonUniformTable1.C.

References Foam::log(), and Foam::T().

Referenced by integratedNonUniformTable::integratedNonUniformTable().

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

◆ write()

void write ( Ostream os,
const unitConversions units 
) const
virtual

Write the function coefficients.

Implements Function1< Type >.

Definition at line 111 of file integratedNonUniformTable1.C.

References Foam::units(), and NonUniformTable< Type >::write().

Here is the call graph for this function:

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