egrMixture< ThermoType > Class Template Reference

Foam::egrMixture. More...

Inheritance diagram for egrMixture< ThermoType >:
Collaboration diagram for egrMixture< ThermoType >:

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 basicSpecieMixture
typedef basicSpecieMixture basicMixtureType
 The base class of the mixture. More...
 
- Public Types inherited from basicMultiComponentMixture
typedef basicMultiComponentMixture 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 dimensionedScalarstoicRatio () 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 & getLocalThermo (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...
 
scalar fres (const scalar ft, const scalar stoicRatio) const
 
tmp< volScalarFieldfres (const volScalarField &ft, const dimensionedScalar &stoicRatio) const
 
- Public Member Functions inherited from basicSpecieMixture
 TypeName ("basicSpecieMixture")
 Run time type information. More...
 
 basicSpecieMixture (const dictionary &, const wordList &specieNames, const fvMesh &, const word &)
 Construct from dictionary, species names, mesh and phase name. More...
 
virtual ~basicSpecieMixture ()
 Destructor. More...
 
virtual scalar Wi (const label speciei) const =0
 Molecular weight of the given specie [kg/kmol]. More...
 
virtual scalar Cp (const label speciei, const scalar p, const scalar T) const =0
 Heat capacity at constant pressure [J/kg/K]. More...
 
virtual scalar Cv (const label speciei, const scalar p, const scalar T) const =0
 Heat capacity at constant volume [J/kg/K]. More...
 
virtual scalar Ha (const label speciei, const scalar p, const scalar T) const =0
 Absolute enthalpy [J/kg]. More...
 
virtual scalar Hs (const label speciei, const scalar p, const scalar T) const =0
 Sensible enthalpy [J/kg]. More...
 
virtual scalar Hc (const label speciei) const =0
 Chemical enthalpy [J/kg]. More...
 
virtual scalar S (const label speciei, const scalar p, const scalar T) const =0
 Entropy [J/kg/K]. More...
 
virtual scalar Es (const label speciei, const scalar p, const scalar T) const =0
 Sensible internal energy [J/kg]. More...
 
virtual scalar G (const label speciei, const scalar p, const scalar T) const =0
 Gibbs free energy [J/kg]. More...
 
virtual scalar A (const label speciei, const scalar p, const scalar T) const =0
 Helmholtz free energy [J/kg]. More...
 
virtual scalar mu (const label speciei, const scalar p, const scalar T) const =0
 Dynamic viscosity [kg/m/s]. More...
 
virtual scalar kappa (const label speciei, const scalar p, const scalar T) const =0
 Thermal conductivity [W/m/K]. More...
 
virtual scalar alphah (const label speciei, const scalar p, const scalar T) const =0
 Thermal diffusivity of enthalpy [kg/m/s]. More...
 
virtual scalar rho (const label speciei, const scalar p, const scalar T) const =0
 Density [kg/m^3]. More...
 
- Public Member Functions inherited from basicMultiComponentMixture
 TypeName ("basicMultiComponentMixture")
 Run time type information. More...
 
 basicMultiComponentMixture (const dictionary &, const wordList &specieNames, const fvMesh &, const word &)
 Construct from dictionary, species names, mesh and phase name. More...
 
virtual ~basicMultiComponentMixture ()
 Destructor. More...
 
const speciesTablespecies () const
 Return the table of species. More...
 
bool contains (const word &specieName) const
 Does the mixture include this specie? More...
 
bool active (label speciei) const
 Return true for active species. More...
 
const List< bool > & active () const
 Return the bool list of active species. More...
 
void setActive (label speciei)
 Set speciei active. More...
 
void setInactive (label speciei)
 Set speciei inactive. More...
 
PtrList< volScalarField > & Y ()
 Return the mass-fraction fields. More...
 
const PtrList< volScalarField > & Y () const
 Return the const mass-fraction fields. More...
 
volScalarFieldY (const label i)
 Return the mass-fraction field for a specie given by index. More...
 
const volScalarFieldY (const label i) const
 Return the const mass-fraction field for a specie given by index. More...
 
volScalarFieldY (const word &specieName)
 Return the mass-fraction field for a specie given by name. More...
 
const volScalarFieldY (const word &specieName) const
 Return the const mass-fraction field for a specie given by name. More...
 
- 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 basicMultiComponentMixture
speciesTable species_
 Table of specie names. More...
 
List< bool > active_
 List of specie active flags. More...
 
PtrList< volScalarFieldY_
 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()

◆ 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 >::getLocalThermo(), egrMixture< ThermoType >::mixture(), patchi, and egrMixture< ThermoType >::read().

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 egrMixture< ThermoType >::getLocalThermo(), dictionary::lookup(), and dictionary::subDict().

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

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

◆ getLocalThermo()

const ThermoType & getLocalThermo ( 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: