Public Member Functions | Static Public Member Functions | Friends | List of all members
SRIFallOffFunction Class Reference

The SRI fall-off function. More...

Public Member Functions

 SRIFallOffFunction (const scalar a, const scalar b, const scalar c, const scalar d, const scalar e)
 Construct from components. More...
 
 SRIFallOffFunction (const dictionary &dict)
 Construct from dictionary. More...
 
scalar operator() (const scalar T, const scalar Pr) const
 
scalar ddT (const scalar T, const scalar Pr, const scalar F) const
 
scalar ddPr (const scalar T, const scalar Pr, const scalar F) const
 
void write (Ostream &os) const
 Write to stream. More...
 

Static Public Member Functions

static word type ()
 Return the type name. More...
 

Friends

Ostream & operator<< (Ostream &, const SRIFallOffFunction &)
 

Detailed Description

The SRI fall-off function.

Source files

Definition at line 54 of file SRIFallOffFunction.H.

Constructor & Destructor Documentation

◆ SRIFallOffFunction() [1/2]

SRIFallOffFunction ( const scalar  a,
const scalar  b,
const scalar  c,
const scalar  d,
const scalar  e 
)
inline

Construct from components.

Definition at line 29 of file SRIFallOffFunctionI.H.

◆ SRIFallOffFunction() [2/2]

SRIFallOffFunction ( const dictionary &  dict)
inline

Construct from dictionary.

Definition at line 45 of file SRIFallOffFunctionI.H.

Member Function Documentation

◆ type()

static word type ( )
inlinestatic

Return the type name.

Definition at line 82 of file SRIFallOffFunction.H.

References SRIFallOffFunction::ddPr(), SRIFallOffFunction::ddT(), Foam::constant::physicoChemical::F, SRIFallOffFunction::operator<<, Foam::T(), and SRIFallOffFunction::write().

Here is the call graph for this function:

◆ operator()()

Foam::scalar operator() ( const scalar  T,
const scalar  Pr 
) const
inline

Definition at line 58 of file SRIFallOffFunctionI.H.

References SRIFallOffFunction::ddT(), Foam::exp(), Foam::log10(), Foam::max(), Foam::pow(), psi, Foam::sqr(), and Foam::T().

Here is the call graph for this function:

◆ ddT()

Foam::scalar ddT ( const scalar  T,
const scalar  Pr,
const scalar  F 
) const
inline

Definition at line 74 of file SRIFallOffFunctionI.H.

References SRIFallOffFunction::ddPr(), Foam::exp(), Foam::log10(), Foam::max(), psi, Foam::sqr(), and Foam::T().

Referenced by SRIFallOffFunction::operator()(), and SRIFallOffFunction::type().

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

◆ ddPr()

Foam::scalar ddPr ( const scalar  T,
const scalar  Pr,
const scalar  F 
) const
inline

Definition at line 92 of file SRIFallOffFunctionI.H.

References Foam::exp(), Foam::log(), Foam::log10(), Foam::max(), psi, and Foam::sqr().

Referenced by SRIFallOffFunction::ddT(), and SRIFallOffFunction::type().

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

◆ write()

void write ( Ostream &  os) const
inline

Write to stream.

Definition at line 112 of file SRIFallOffFunctionI.H.

References Foam::writeEntry().

Referenced by SRIFallOffFunction::type().

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

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<< ( Ostream &  ,
const SRIFallOffFunction &   
)
friend

Referenced by SRIFallOffFunction::type().

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