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

Base-class for all Xi generation models used by the b-Xi combustion model. See Technical Report SH/RE/01R for details on the PDR modelling. For details on the use of XiGModel see XiModel.H. The model available is instabilityG.H. More...

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

Public Member Functions

 TypeName ("XiGModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, XiGModel, dictionary,(const dictionary &XiGProperties, const psiuMulticomponentThermo &thermo, const compressible::RASModel &turbulence, const volScalarField &Su),(XiGProperties, thermo, turbulence, Su))
 
 XiGModel (const dictionary &XiGProperties, const psiuMulticomponentThermo &thermo, const compressible::RASModel &turbulence, const volScalarField &Su)
 Construct from components. More...
 
 XiGModel (const XiGModel &)
 Disallow default bitwise copy construction. More...
 
virtual ~XiGModel ()
 Destructor. More...
 
virtual tmp< volScalarField > G () const =0
 Return the flame-wrinkling generation rate. More...
 
virtual tmp< volScalarField > Db () const
 Return the flame diffusivity. More...
 
virtual bool read (const dictionary &XiGProperties)=0
 Update properties from given dictionary. More...
 
void operator= (const XiGModel &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Member Functions

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

Protected Attributes

dictionary XiGModelCoeffs_
 
const psiuMulticomponentThermo & thermo_
 
const compressible::RASModel & turbulence_
 
const volScalarField & Su_
 

Detailed Description

Base-class for all Xi generation models used by the b-Xi combustion model. See Technical Report SH/RE/01R for details on the PDR modelling. For details on the use of XiGModel see XiModel.H. The model available is instabilityG.H.

Source files

Definition at line 54 of file XiGModel.H.

Constructor & Destructor Documentation

◆ XiGModel() [1/2]

XiGModel ( const dictionary &  XiGProperties,
const psiuMulticomponentThermo &  thermo,
const compressible::RASModel &  turbulence,
const volScalarField &  Su 
)

Construct from components.

Definition at line 39 of file XiGModel.C.

◆ XiGModel() [2/2]

XiGModel ( const XiGModel &  )

Disallow default bitwise copy construction.

◆ ~XiGModel()

~XiGModel ( )
virtual

Destructor.

Definition at line 62 of file XiGModel.C.

Member Function Documentation

◆ TypeName()

TypeName ( "XiGModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ New()

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

Return a reference to the selected XiG model.

Definition at line 30 of file XiGModelNew.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:

◆ G()

virtual tmp<volScalarField> G ( ) const
pure virtual

Return the flame-wrinkling generation rate.

Implemented in KTS, instabilityG, and basicSubGrid.

◆ Db()

virtual tmp<volScalarField> Db ( ) const
inlinevirtual

Return the flame diffusivity.

Reimplemented in instabilityG, and basicSubGrid.

Definition at line 133 of file XiGModel.H.

References GeometricField< Type, PatchField, GeoMesh >::New(), and XiGModel::turbulence_.

Here is the call graph for this function:

◆ read()

bool read ( const dictionary &  XiGProperties)
pure virtual

Update properties from given dictionary.

Implemented in KTS, instabilityG, and basicSubGrid.

Definition at line 68 of file XiGModel.C.

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

Referenced by basicSubGrid::read(), instabilityG::read(), and KTS::read().

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

◆ operator=()

void operator= ( const XiGModel &  )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ XiGModelCoeffs_

dictionary XiGModelCoeffs_
protected

Definition at line 61 of file XiGModel.H.

◆ thermo_

const psiuMulticomponentThermo& thermo_
protected

Definition at line 63 of file XiGModel.H.

◆ turbulence_

const compressible::RASModel& turbulence_
protected

Definition at line 64 of file XiGModel.H.

Referenced by XiGModel::Db().

◆ Su_

const volScalarField& Su_
protected

Definition at line 65 of file XiGModel.H.

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