Public Member Functions | Static Public Member Functions | Friends | List of all members
thermophysicalFunction Class Referenceabstract

Abstract base class for thermo-physical functions. More...

Inheritance diagram for thermophysicalFunction:
Inheritance graph
[legend]

Public Member Functions

 TypeName ("thermophysicalFunction")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, thermophysicalFunction, dictionary,(const dictionary &dict),(dict))
 
 thermophysicalFunction ()
 Construct null. More...
 
virtual ~thermophysicalFunction ()
 Destructor. More...
 
virtual scalar f (scalar p, scalar T) const =0
 Evaluate the function and return the result. More...
 
virtual void write (Ostream &os) const =0
 Write the function coefficients. More...
 
virtual void write (Ostream &os, const word &name) const
 Write the function coefficients within the property sub-dictionary. More...
 

Static Public Member Functions

static autoPtr< thermophysicalFunction > New (const dictionary &dict, const word &name)
 Return pointer to new thermophysicalFunction created from dict. More...
 

Friends

Ostream & operator<< (Ostream &os, const thermophysicalFunction &f)
 

Detailed Description

Abstract base class for thermo-physical functions.

Definition at line 54 of file thermophysicalFunction.H.

Constructor & Destructor Documentation

◆ thermophysicalFunction()

thermophysicalFunction ( )
inline

Construct null.

Definition at line 78 of file thermophysicalFunction.H.

References Foam::name(), and thermophysicalFunction::New().

Here is the call graph for this function:

◆ ~thermophysicalFunction()

virtual ~thermophysicalFunction ( )
inlinevirtual

Destructor.

Definition at line 90 of file thermophysicalFunction.H.

References thermophysicalFunction::f(), p, Foam::T(), and thermophysicalFunction::write().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "thermophysicalFunction"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
thermophysicalFunction  ,
dictionary  ,
(const dictionary &dict)  ,
(dict)   
)

◆ New()

Foam::autoPtr< Foam::thermophysicalFunction > New ( const dictionary &  dict,
const word &  name 
)
static

Return pointer to new thermophysicalFunction created from dict.

Definition at line 41 of file thermophysicalFunction.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, InfoInFunction, dictionary::isDict(), dictionaryName::name(), Foam::name(), Foam::nl, and dictionary::subDict().

Referenced by thermophysicalFunction::thermophysicalFunction().

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

◆ f()

virtual scalar f ( scalar  p,
scalar  T 
) const
pure virtual

Evaluate the function and return the result.

Implemented in nonUniformTable, table, NSRDS0, NSRDS6, NSRDS1, NSRDS14, NSRDS4, NSRDS7, NSRDS2, NSRDS3, NSRDS5, APIdiffCoef, constant, and none.

Referenced by thermophysicalFunction::~thermophysicalFunction().

Here is the caller graph for this function:

◆ write() [1/2]

virtual void write ( Ostream &  os) const
pure virtual

Write the function coefficients.

Implemented in nonUniformTable, table, NSRDS14, NSRDS6, NSRDS0, NSRDS1, NSRDS4, NSRDS7, NSRDS2, NSRDS3, NSRDS5, integratedNonUniformTable, APIdiffCoef, constant, and none.

Referenced by NSRDS2::f(), NSRDS3::f(), NSRDS5::f(), NSRDS7::f(), NSRDS1::f(), NSRDS14::f(), NSRDS4::f(), NSRDS0::f(), NSRDS6::f(), Foam::operator<<(), and thermophysicalFunction::~thermophysicalFunction().

Here is the caller graph for this function:

◆ write() [2/2]

void write ( Ostream &  os,
const word &  name 
) const
virtual

Write the function coefficients within the property sub-dictionary.

Definition at line 87 of file thermophysicalFunction.C.

References token::BEGIN_BLOCK, Foam::decrIndent(), token::END_BLOCK, Foam::endl(), Foam::incrIndent(), Foam::indent(), Foam::nl, Foam::vtkWriteOps::write(), and Foam::writeKeyword().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<< ( Ostream &  os,
const thermophysicalFunction &  f 
)
friend
The documentation for this class was generated from the following files: