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 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 &	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< volScalarField >	fres (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	nMoles (const label speciei) const =0
	Number of moles of the given specie []. More...
virtual scalar	W (const label speciei) const =0
	Molecular weight of the given specie [kg/kmol]. More...
tmp< volScalarField >	W () const
	Molecular weight of the mixture [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/m3]. 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 speciesTable &	species () const
	Return the table of species. More...
PtrList< volScalarField > &	Y ()
	Return the mass-fraction fields. More...
const PtrList< volScalarField > &	Y () const
	Return the const mass-fraction fields. More...
volScalarField &	Y (const label i)
	Return the mass-fraction field for a specie given by index. More...
const volScalarField &	Y (const label i) const
	Return the const mass-fraction field for a specie given by index. 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...
bool	contains (const word &specieName) const
	Does the mixture include this specie? More...

Private Member Functions
	egrMixture (const egrMixture< ThermoType > &)
	Construct as copy (not implemented) More...

Private Attributes
dimensionedScalar	stoicRatio_
ThermoType	fuel_
ThermoType	oxidant_
ThermoType	products_
ThermoType	mixture_
volScalarField &	ft_
	Mixture fraction. More...
volScalarField &	b_
	Regress variable. More...
volScalarField &	egr_
	Residual gases. More...

Static Private Attributes
static const int	nSpecies_ = 3
static const char *	specieNames_ [3] = {"ft", "b", "egr"}

Additional Inherited Members
Protected Attributes inherited from basicMultiComponentMixture
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

• egrMixture.H
• egrMixture.C

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() [1/2]

egrMixture ( const egrMixture< ThermoType > &  )

private

Construct as copy (not implemented)

egrMixture() [2/2]

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

Construct from dictionary, mesh and phaseName.

Definition at line 39 of file egrMixture.C.

~egrMixture()

virtual ~egrMixture ( )

inlinevirtual

Destructor.

Definition at line 92 of file egrMixture.H.

Member Function Documentation

stoicRatio()

const dimensionedScalar& stoicRatio ( ) const

inline

Definition at line 98 of file egrMixture.H.

References egrMixture< ThermoType >::stoicRatio_.

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, and dimensioned::value().

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

Here is the call graph for this function:

Here is the caller graph for this function:

cellMixture()

const ThermoType& cellMixture ( const label  celli ) const

inline

Definition at line 110 of file egrMixture.H.

References egrMixture< ThermoType >::b_, egrMixture< ThermoType >::egr_, egrMixture< ThermoType >::ft_, and egrMixture< ThermoType >::mixture().

Here is the call graph for this function:

patchFaceMixture()

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

inline

Definition at line 116 of file egrMixture.H.

References egrMixture< ThermoType >::b_, GeometricField::boundaryField(), egrMixture< ThermoType >::egr_, egrMixture< ThermoType >::ft_, egrMixture< ThermoType >::mixture(), and patchi.

Here is the call graph for this function:

cellReactants()

const ThermoType& cellReactants ( const label  celli ) const

inline

Definition at line 129 of file egrMixture.H.

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

Here is the call graph for this function:

patchFaceReactants()

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

inline

Definition at line 135 of file egrMixture.H.

References GeometricField::boundaryField(), egrMixture< ThermoType >::egr_, egrMixture< ThermoType >::ft_, egrMixture< ThermoType >::mixture(), and patchi.

Here is the call graph for this function:

cellProducts()

const ThermoType& cellProducts ( const label  celli ) const

inline

Definition at line 148 of file egrMixture.H.

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

Here is the call graph for this function:

patchFaceProducts()

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

inline

Definition at line 154 of file egrMixture.H.

References GeometricField::boundaryField(), egrMixture< ThermoType >::ft_, egrMixture< ThermoType >::mixture(), and patchi.

Here is the call graph for this function:

read()

void read

(

const dictionary &

thermoDict

)

Read dictionary.

Definition at line 102 of file egrMixture.C.

References dictionary::lookup(), and dictionary::subDict().

Here is the call 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.

Here is the call graph for this function:

Field Documentation

nSpecies_

const int nSpecies_ = 3

staticprivate

Definition at line 55 of file egrMixture.H.

specieNames_

const char * specieNames_ = {"ft", "b", "egr"}

staticprivate

Definition at line 56 of file egrMixture.H.

stoicRatio_

dimensionedScalar stoicRatio_

private

Definition at line 58 of file egrMixture.H.

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

fuel_

ThermoType fuel_

private

Definition at line 60 of file egrMixture.H.

oxidant_

ThermoType oxidant_

private

Definition at line 61 of file egrMixture.H.

products_

ThermoType products_

private

Definition at line 62 of file egrMixture.H.

mixture_

ThermoType mixture_

mutableprivate

Definition at line 64 of file egrMixture.H.

ft_

volScalarField& ft_

private

Mixture fraction.

Definition at line 67 of file egrMixture.H.

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

b_

volScalarField& b_

private

Regress variable.

Definition at line 70 of file egrMixture.H.

Referenced by egrMixture< ThermoType >::cellMixture(), and egrMixture< ThermoType >::patchFaceMixture().

egr_

volScalarField& egr_

private

Residual gases.

Definition at line 73 of file egrMixture.H.

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

---

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

• src/thermophysicalModels/reactionThermo/mixtures/egrMixture/egrMixture.H
• src/thermophysicalModels/reactionThermo/mixtures/egrMixture/egrMixture.C