Public Types | Public Member Functions | Static Public Member Functions | List of all members
egrMixture< ThermoType > Class Template Reference

Foam::egrMixture. More...

Inheritance diagram for egrMixture< ThermoType >:
Inheritance graph
[legend]
Collaboration diagram for egrMixture< ThermoType >:
Collaboration graph
[legend]

Public Types

typedef ThermoType thermoType
 The type of thermodynamics this mixture is instantiated for. More...
 
- Public Types inherited from basicCombustionMixture
typedef basicCombustionMixture basicMixtureType
 The base class of the mixture. More...
 
- Public Types inherited from basicMixture
typedef basicMixture basicMixtureType
 The base class of the mixture. More...
 

Public Member Functions

 egrMixture (const dictionary &, const fvMesh &, const word &)
 Construct from dictionary, mesh and phaseName. More...
 
virtual ~egrMixture ()
 Destructor. More...
 
const dimensionedScalar & stoicRatio () const
 
const ThermoType & mixture (const scalar, const scalar, const scalar) const
 
const ThermoType & cellMixture (const label celli) const
 
const ThermoType & patchFaceMixture (const label patchi, const label facei) const
 
const ThermoType & cellReactants (const label celli) const
 
const ThermoType & patchFaceReactants (const label patchi, const label facei) const
 
const ThermoType & cellProducts (const label celli) const
 
const ThermoType & patchFaceProducts (const label patchi, const label facei) const
 
void read (const dictionary &)
 Read dictionary. More...
 
const ThermoType & specieThermo (const label speciei) const
 Return thermo based on index. More...
 
- Public Member Functions inherited from basicCombustionMixture
 TypeName ("basicCombustionMixture")
 Run time type information. More...
 
 basicCombustionMixture (const dictionary &, const wordList &specieNames, const fvMesh &, const word &)
 Construct from dictionary, specie names, mesh and phase name. More...
 
virtual ~basicCombustionMixture ()
 Destructor. More...
 
bool contains (const word &specieName) const
 Does the mixture include this specie? More...
 
volScalarField & Y (const word &specieName)
 Return the mass-fraction field for a specie given by name. More...
 
const volScalarField & Y (const word &specieName) const
 Return the const mass-fraction field for a specie given by name. More...
 
scalar fres (const scalar ft, const scalar stoicRatio) const
 
tmp< volScalarField > fres (const volScalarField &ft, const dimensionedScalar &stoicRatio) const
 
- Public Member Functions inherited from basicMixture
 basicMixture (const dictionary &, const fvMesh &, const word &)
 Construct from dictionary, mesh and phase name. More...
 

Static Public Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from basicCombustionMixture
speciesTable species_
 Table of specie names. More...
 
PtrList< volScalarField > Y_
 Species mass fractions. More...
 

Detailed Description

template<class ThermoType>
class Foam::egrMixture< ThermoType >

Foam::egrMixture.

Source files

Definition at line 49 of file egrMixture.H.

Member Typedef Documentation

◆ thermoType

typedef ThermoType thermoType

The type of thermodynamics this mixture is instantiated for.

Definition at line 82 of file egrMixture.H.

Constructor & Destructor Documentation

◆ egrMixture()

egrMixture ( const dictionary &  thermoDict,
const fvMesh &  mesh,
const word &  phaseName 
)

Construct from dictionary, mesh and phaseName.

Definition at line 39 of file egrMixture.C.

References egrMixture< ThermoType >::mixture().

Here is the call graph for this function:

◆ ~egrMixture()

virtual ~egrMixture ( )
inlinevirtual

Destructor.

Definition at line 92 of file egrMixture.H.

Member Function Documentation

◆ typeName()

static word typeName ( )
inlinestatic

Return the instantiated type name.

Definition at line 99 of file egrMixture.H.

◆ stoicRatio()

const dimensionedScalar& stoicRatio ( ) const
inline

Definition at line 104 of file egrMixture.H.

References egrMixture< ThermoType >::mixture().

Here is the call graph for this function:

◆ mixture()

const ThermoType & mixture ( const scalar  ft,
const scalar  b,
const scalar  egr 
) const

Definition at line 71 of file egrMixture.C.

References Foam::constant::physicoChemical::b.

Referenced by egrMixture< ThermoType >::cellMixture(), egrMixture< ThermoType >::cellProducts(), egrMixture< ThermoType >::cellReactants(), egrMixture< ThermoType >::egrMixture(), egrMixture< ThermoType >::patchFaceMixture(), egrMixture< ThermoType >::patchFaceProducts(), egrMixture< ThermoType >::patchFaceReactants(), and egrMixture< ThermoType >::stoicRatio().

Here is the caller graph for this function:

◆ cellMixture()

const ThermoType& cellMixture ( const label  celli) const
inline

Definition at line 116 of file egrMixture.H.

References egrMixture< ThermoType >::mixture(), and egrMixture< ThermoType >::patchFaceMixture().

Here is the call graph for this function:

◆ patchFaceMixture()

const ThermoType& patchFaceMixture ( const label  patchi,
const label  facei 
) const
inline

Definition at line 122 of file egrMixture.H.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), egrMixture< ThermoType >::mixture(), and patchi.

Referenced by egrMixture< ThermoType >::cellMixture().

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

◆ cellReactants()

const ThermoType& cellReactants ( const label  celli) const
inline

Definition at line 135 of file egrMixture.H.

References egrMixture< ThermoType >::mixture(), and egrMixture< ThermoType >::patchFaceReactants().

Here is the call graph for this function:

◆ patchFaceReactants()

const ThermoType& patchFaceReactants ( const label  patchi,
const label  facei 
) const
inline

Definition at line 141 of file egrMixture.H.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), egrMixture< ThermoType >::mixture(), and patchi.

Referenced by egrMixture< ThermoType >::cellReactants().

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

◆ cellProducts()

const ThermoType& cellProducts ( const label  celli) const
inline

Definition at line 154 of file egrMixture.H.

References egrMixture< ThermoType >::mixture(), and egrMixture< ThermoType >::patchFaceProducts().

Here is the call graph for this function:

◆ patchFaceProducts()

const ThermoType& patchFaceProducts ( const label  patchi,
const label  facei 
) const
inline

Definition at line 160 of file egrMixture.H.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), egrMixture< ThermoType >::mixture(), patchi, egrMixture< ThermoType >::read(), and egrMixture< ThermoType >::specieThermo().

Referenced by egrMixture< ThermoType >::cellProducts().

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

◆ read()

void read ( const dictionary &  thermoDict)

Read dictionary.

Definition at line 102 of file egrMixture.C.

References dictionary::lookup(), egrMixture< ThermoType >::specieThermo(), and dictionary::subDict().

Referenced by egrMixture< ThermoType >::patchFaceProducts().

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

◆ specieThermo()

const ThermoType & specieThermo ( const label  speciei) const

Return thermo based on index.

Definition at line 114 of file egrMixture.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Referenced by egrMixture< ThermoType >::patchFaceProducts(), and egrMixture< ThermoType >::read().

Here is the call graph for this function:
Here is the caller graph for this function:
The documentation for this class was generated from the following files: