Public Member Functions | Private Member Functions | Private Attributes
consumptionSpeed Class Reference

Public Member Functions

 TypeName ("consumptionSpeed")
 Runtime type information. More...
 
 consumptionSpeed (const dictionary &dict)
 Construct from dictionary. More...
 
virtual ~consumptionSpeed ()
 Destructor. More...
 
tmp< volScalarFieldomega0Sigma (const volScalarField &sigma)
 Return speed consumption rate temp. More...
 
scalar omega0 () const
 
scalar eta () const
 
scalar sigmaExt () const
 
scalar omegaMin () const
 
void read (const dictionary &dict)
 Update properties. More...
 

Private Member Functions

scalar omega0Sigma (scalar sigma, scalar a) const
 Return consumption rate. More...
 
 consumptionSpeed (const consumptionSpeed &)
 Disallow copy construct. More...
 
void operator= (const consumptionSpeed &)
 Disallow default bitwise assignment. More...
 

Private Attributes

scalar omega0_
 Maximum consumption speed. More...
 
scalar eta_
 Exponential factor. More...
 
scalar sigmaExt_
 Extinction strain. More...
 
scalar omegaMin_
 Minimum consumption speed. More...
 

Detailed Description

Definition at line 49 of file consumptionSpeed.H.

Constructor & Destructor Documentation

◆ consumptionSpeed() [1/2]

consumptionSpeed ( const consumptionSpeed )
private

Disallow copy construct.

◆ consumptionSpeed() [2/2]

consumptionSpeed ( const dictionary dict)

Construct from dictionary.

Definition at line 39 of file consumptionSpeed.C.

◆ ~consumptionSpeed()

~consumptionSpeed ( )
virtual

Destructor.

Definition at line 51 of file consumptionSpeed.C.

Member Function Documentation

◆ omega0Sigma() [1/2]

Foam::scalar omega0Sigma ( scalar  sigma,
scalar  a 
) const
private

Return consumption rate.

Definition at line 58 of file consumptionSpeed.C.

References Foam::exp(), Foam::max(), and Foam::constant::physicoChemical::sigma.

Here is the call graph for this function:

◆ operator=()

void operator= ( const consumptionSpeed )
private

Disallow default bitwise assignment.

◆ TypeName()

TypeName ( "consumptionSpeed"  )

Runtime type information.

◆ omega0Sigma() [2/2]

Foam::tmp< Foam::volScalarField > omega0Sigma ( const volScalarField sigma)

Return speed consumption rate temp.

Definition at line 79 of file consumptionSpeed.C.

References GeometricField::boundaryField(), forAll, GeometricField::internalField(), IOobject::NO_READ, IOobject::NO_WRITE, patchi, and Foam::constant::physicoChemical::sigma.

Here is the call graph for this function:

◆ omega0()

scalar omega0 ( ) const
inline

Definition at line 102 of file consumptionSpeed.H.

References consumptionSpeed::omega0_.

◆ eta()

scalar eta ( ) const
inline

Definition at line 107 of file consumptionSpeed.H.

References consumptionSpeed::eta_.

◆ sigmaExt()

scalar sigmaExt ( ) const
inline

Definition at line 112 of file consumptionSpeed.H.

References consumptionSpeed::sigmaExt_.

◆ omegaMin()

scalar omegaMin ( ) const
inline

Definition at line 117 of file consumptionSpeed.H.

References consumptionSpeed::omegaMin_.

◆ read()

void read ( const dictionary dict)

Update properties.

Definition at line 133 of file consumptionSpeed.C.

References dict, and dictionary::lookup().

Here is the call graph for this function:

Field Documentation

◆ omega0_

scalar omega0_
private

Maximum consumption speed.

Definition at line 54 of file consumptionSpeed.H.

Referenced by consumptionSpeed::omega0().

◆ eta_

scalar eta_
private

Exponential factor.

Definition at line 57 of file consumptionSpeed.H.

Referenced by consumptionSpeed::eta().

◆ sigmaExt_

scalar sigmaExt_
private

Extinction strain.

Definition at line 60 of file consumptionSpeed.H.

Referenced by consumptionSpeed::sigmaExt().

◆ omegaMin_

scalar omegaMin_
private

Minimum consumption speed.

Definition at line 63 of file consumptionSpeed.H.

Referenced by consumptionSpeed::omegaMin().


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