UniformTable< Type > Class Template Reference

Tabulated property function that linearly interpolates between the UniformTable values. More...

Inheritance diagram for UniformTable< Type >:
Collaboration diagram for UniformTable< Type >:

Public Member Functions

 TypeName ("uniformTable")
 Runtime type information. More...
 
 UniformTable (const word &name, const dictionary &dict)
 Construct from name and dictionary. More...
 
virtual Type value (scalar x) const
 Evaluate the function and return the result. More...
 
virtual Type integral (const scalar x1, const scalar x2) const
 Integrate between two scalar values. More...
 
void write (Ostream &os) const
 Write the function coefficients. More...
 
- Public Member Functions inherited from FieldFunction1< Type, UniformTable< Type > >
 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 dictionary &dict),(name, dict))
 Declare runtime constructor selection table. More...
 
 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...
 
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...
 

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 dictionary &dict)
 Selector. More...
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 
- Protected Attributes inherited from Function1< Type >
const word name_
 Name of entry. More...
 

Detailed Description

template<class Type>
class Foam::Function1s::UniformTable< Type >

Tabulated property function that linearly interpolates between the UniformTable values.

Usage
Property Description
low Lower limit of the table
high Upper limit of the table
values Values, assumed uniformly distributed

Example for the density of water between 280 and 350K

    rho
    {
        type    uniformTable;

        low    280;
        high   350;

        values
        (
            999.87
            991.53
            973.7
        );
    }

Definition at line 87 of file UniformTable1.H.

Constructor & Destructor Documentation

◆ UniformTable()

UniformTable ( const word name,
const dictionary dict 
)

Construct from name and dictionary.

Definition at line 32 of file UniformTable1.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "uniformTable"  )

Runtime type information.

◆ value()

Type value ( scalar  x) const
virtual

Evaluate the function and return the result.

Implements FieldFunction1< Type, UniformTable< Type > >.

Definition at line 61 of file UniformTable1.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, UniformTable< Type >::integral(), lambda(), and Foam::nl.

Here is the call graph for this function:

◆ integral()

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

Integrate between two scalar values.

Implements FieldFunction1< Type, UniformTable< Type > >.

Definition at line 84 of file UniformTable1.C.

References NotImplemented, and Foam::Zero.

Referenced by UniformTable< Type >::value().

Here is the caller graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write the function coefficients.

Implements Function1< Type >.

Definition at line 95 of file UniformTable1.C.

References Foam::writeEntry().

Here is the call graph for this function:

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