Public Member Functions | Static Public Member Functions | Private Attributes | Friends
TroeFallOffFunction Class Reference

The Troe fall-off function. More...

Public Member Functions

 TroeFallOffFunction (const scalar alpha, const scalar Tsss, const scalar Ts, const scalar Tss)
 Construct from components. More...
 
 TroeFallOffFunction (Istream &)
 Construct from Istream. More...
 
 TroeFallOffFunction (const dictionary &dict)
 Construct from dictionary. More...
 
scalar operator() (const scalar T, const scalar Pr) const
 
void write (Ostream &os) const
 Write to stream. More...
 

Static Public Member Functions

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

Private Attributes

scalar alpha_
 
scalar Tsss_
 
scalar Ts_
 
scalar Tss_
 

Friends

Ostreamoperator<< (Ostream &, const TroeFallOffFunction &)
 

Detailed Description

The Troe fall-off function.

Source files

Definition at line 54 of file TroeFallOffFunction.H.

Constructor & Destructor Documentation

◆ TroeFallOffFunction() [1/3]

TroeFallOffFunction ( const scalar  alpha,
const scalar  Tsss,
const scalar  Ts,
const scalar  Tss 
)
inline

Construct from components.

Definition at line 29 of file TroeFallOffFunctionI.H.

◆ TroeFallOffFunction() [2/3]

TroeFallOffFunction ( Istream is)
inline

Construct from Istream.

Definition at line 43 of file TroeFallOffFunctionI.H.

References Istream::readEnd().

Here is the call graph for this function:

◆ TroeFallOffFunction() [3/3]

TroeFallOffFunction ( const dictionary dict)
inline

Construct from dictionary.

Definition at line 54 of file TroeFallOffFunctionI.H.

Member Function Documentation

◆ type()

static word type ( )
inlinestatic

Return the type name.

Definition at line 85 of file TroeFallOffFunction.H.

◆ operator()()

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

Definition at line 66 of file TroeFallOffFunctionI.H.

References Foam::constant::universal::c, Foam::exp(), Foam::log10(), Foam::max(), n, Foam::pow(), Pr(), Foam::sqr(), and Foam::T().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
inline

Write to stream.

Definition at line 89 of file TroeFallOffFunctionI.H.

References token::END_STATEMENT, Foam::nl, and Ostream::writeKeyword().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

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

Field Documentation

◆ alpha_

scalar alpha_
private

Definition at line 58 of file TroeFallOffFunction.H.

◆ Tsss_

scalar Tsss_
private

Definition at line 59 of file TroeFallOffFunction.H.

◆ Ts_

scalar Ts_
private

Definition at line 59 of file TroeFallOffFunction.H.

◆ Tss_

scalar Tss_
private

Definition at line 59 of file TroeFallOffFunction.H.


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