Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
XiEqModel Class Referenceabstract

Base-class for all XiEq models used by the b-XiEq combustion model. The available models are : basicXiSubXiEq.H Gulder.H instabilityXiEq.H SCOPEBlendXiEq.H SCOPEXiEq.H. More...

Inheritance diagram for XiEqModel:
Inheritance graph
[legend]
Collaboration diagram for XiEqModel:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("XiEqModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, XiEqModel, dictionary,(const dictionary &XiEqProperties, const psiuMulticomponentThermo &thermo, const compressible::RASModel &turbulence, const volScalarField &Su),(XiEqProperties, thermo, turbulence, Su))
 
 XiEqModel (const dictionary &XiEqProperties, const psiuMulticomponentThermo &thermo, const compressible::RASModel &turbulence, const volScalarField &Su)
 Construct from components. More...
 
 XiEqModel (const XiEqModel &)
 Disallow default bitwise copy construction. More...
 
virtual ~XiEqModel ()
 Destructor. More...
 
virtual tmp< volScalarField > XiEq () const =0
 Return the flame-wrinkling XiEq. More...
 
tmp< volScalarField > calculateSchelkinEffect (const scalar) const
 Return the sub-grid Schelkin effect. More...
 
virtual bool read (const dictionary &XiEqProperties)=0
 Update properties from given dictionary. More...
 
void writeFields () const
 Write fields. More...
 
void operator= (const XiEqModel &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Member Functions

static autoPtr< XiEqModel > New (const dictionary &XiEqProperties, const psiuMulticomponentThermo &thermo, const compressible::RASModel &turbulence, const volScalarField &Su)
 Return a reference to the selected XiEq model. More...
 

Protected Attributes

dictionary XiEqModelCoeffs_
 Dictionary. More...
 
const psiuMulticomponentThermo & thermo_
 Thermo. More...
 
const compressible::RASModel & turbulence_
 Turbulence. More...
 
const volScalarField & Su_
 Laminar burning velocity. More...
 

Detailed Description

Base-class for all XiEq models used by the b-XiEq combustion model. The available models are : basicXiSubXiEq.H Gulder.H instabilityXiEq.H SCOPEBlendXiEq.H SCOPEXiEq.H.

Source files

Definition at line 57 of file XiEqModel.H.

Constructor & Destructor Documentation

◆ XiEqModel() [1/2]

XiEqModel ( const dictionary &  XiEqProperties,
const psiuMulticomponentThermo &  thermo,
const compressible::RASModel &  turbulence,
const volScalarField &  Su 
)

Construct from components.

Definition at line 39 of file XiEqModel.C.

◆ XiEqModel() [2/2]

XiEqModel ( const XiEqModel &  )

Disallow default bitwise copy construction.

◆ ~XiEqModel()

~XiEqModel ( )
virtual

Destructor.

Definition at line 62 of file XiEqModel.C.

Member Function Documentation

◆ TypeName()

TypeName ( "XiEqModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
XiEqModel  ,
dictionary  ,
(const dictionary &XiEqProperties, const psiuMulticomponentThermo &thermo, const compressible::RASModel &turbulence, const volScalarField &Su)  ,
(XiEqProperties, thermo, turbulence, Su)   
)

◆ New()

Foam::autoPtr< Foam::XiEqModel > New ( const dictionary &  XiEqProperties,
const psiuMulticomponentThermo &  thermo,
const compressible::RASModel &  turbulence,
const volScalarField &  Su 
)
static

Return a reference to the selected XiEq model.

Definition at line 30 of file XiEqModelNew.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, dictionary::lookup(), Foam::nl, Foam::fvc::Su(), thermo, and turbulence().

Here is the call graph for this function:

◆ XiEq()

virtual tmp<volScalarField> XiEq ( ) const
pure virtual

Return the flame-wrinkling XiEq.

Implemented in SCOPEXiEq, SCOPEBlend, instability, Gulder, and basicSubGrid.

◆ calculateSchelkinEffect()

Foam::tmp< Foam::volScalarField > calculateSchelkinEffect ( const scalar  uPrimeCoef) const

Return the sub-grid Schelkin effect.

Definition at line 89 of file XiEqModel.C.

References Foam::e, objectRegistry::lookupObject(), Foam::mag(), Foam::max(), dimensioned< Type >::name(), GeometricField< Type, PatchField, GeoMesh >::New(), IOobject::NO_READ, IOobject::NO_WRITE, Foam::pow(), GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), GeometricField< Type, PatchField, GeoMesh >::ref(), Foam::sqrt(), fvMesh::time(), U, fvMesh::V(), and Foam::Zero.

Here is the call graph for this function:

◆ read()

bool read ( const dictionary &  XiEqProperties)
pure virtual

Update properties from given dictionary.

Implemented in SCOPEXiEq, SCOPEBlend, instability, Gulder, and basicSubGrid.

Definition at line 68 of file XiEqModel.C.

References dictionary::optionalSubDict(), and Foam::type().

Referenced by basicSubGrid::read(), Gulder::read(), instability::read(), and SCOPEXiEq::read().

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

◆ writeFields()

void writeFields ( ) const

Write fields.

Definition at line 76 of file XiEqModel.C.

References B.

◆ operator=()

void operator= ( const XiEqModel &  )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ XiEqModelCoeffs_

dictionary XiEqModelCoeffs_
protected

Dictionary.

Definition at line 65 of file XiEqModel.H.

◆ thermo_

const psiuMulticomponentThermo& thermo_
protected

Thermo.

Definition at line 68 of file XiEqModel.H.

◆ turbulence_

const compressible::RASModel& turbulence_
protected

Turbulence.

Definition at line 71 of file XiEqModel.H.

◆ Su_

const volScalarField& Su_
protected

Laminar burning velocity.

Definition at line 74 of file XiEqModel.H.

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