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...

typedef ThermoType	thermoMixtureType
	Mixing type for thermodynamic properties. More...

typedef ThermoType	transportMixtureType
	Mixing type for transport properties. 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...

	egrMixture (const egrMixture< ThermoType > &)=delete
	Disallow default bitwise copy construction. More...

virtual	~egrMixture ()
	Destructor. More...

const dimensionedScalar &	stoicRatio () const

const thermoType &	mixture (const scalar, const scalar, const scalar) const

const thermoMixtureType &	cellThermoMixture (const label celli) const

const thermoMixtureType &	patchFaceThermoMixture (const label patchi, const label facei) const

const transportMixtureType &	cellTransportMixture (const label celli) const

const transportMixtureType &	patchFaceTransportMixture (const label patchi, const label facei) const

const transportMixtureType &	cellTransportMixture (const label, const thermoMixtureType &thermoMixture) const

const transportMixtureType &	patchFaceTransportMixture (const label, const label, const thermoMixtureType &thermoMixture) 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...

void	operator= (const egrMixture< ThermoType > &)=delete
	Disallow default bitwise assignment. 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 57 of file egrMixture.H.

◆ thermoMixtureType

typedef ThermoType thermoMixtureType

Mixing type for thermodynamic properties.

Definition at line 60 of file egrMixture.H.

◆ transportMixtureType

typedef ThermoType transportMixtureType

Mixing type for transport properties.

Definition at line 63 of file egrMixture.H.

Constructor & Destructor Documentation

◆ egrMixture() [1/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.

References egrMixture< ThermoType >::mixture().

Here is the call graph for this function:

◆ egrMixture() [2/2]

egrMixture ( const egrMixture< ThermoType > & )

delete

Disallow default bitwise copy construction.

◆ ~egrMixture()

virtual ~egrMixture ( )

inlinevirtual

Destructor.

Definition at line 103 of file egrMixture.H.

Member Function Documentation

◆ typeName()

static word typeName ( )

inlinestatic

Return the instantiated type name.

Definition at line 110 of file egrMixture.H.

◆ stoicRatio()

const dimensionedScalar& stoicRatio ( ) const

inline

Definition at line 115 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 >::cellProducts(), egrMixture< ThermoType >::cellReactants(), egrMixture< ThermoType >::cellThermoMixture(), egrMixture< ThermoType >::egrMixture(), egrMixture< ThermoType >::patchFaceProducts(), egrMixture< ThermoType >::patchFaceReactants(), egrMixture< ThermoType >::patchFaceThermoMixture(), and egrMixture< ThermoType >::stoicRatio().

Here is the caller graph for this function:

◆ cellThermoMixture()

const thermoMixtureType& cellThermoMixture ( const label celli ) const

inline

Definition at line 127 of file egrMixture.H.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ patchFaceThermoMixture()

const thermoMixtureType& patchFaceThermoMixture	(	const label	patchi,
		const label	facei
	)		const

inline

Definition at line 133 of file egrMixture.H.

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

Referenced by egrMixture< ThermoType >::cellThermoMixture(), and egrMixture< ThermoType >::patchFaceTransportMixture().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cellTransportMixture() [1/2]

const transportMixtureType& cellTransportMixture ( const label celli ) const

inline

Definition at line 147 of file egrMixture.H.

References egrMixture< ThermoType >::cellThermoMixture(), and egrMixture< ThermoType >::patchFaceTransportMixture().

Referenced by egrMixture< ThermoType >::patchFaceThermoMixture(), and egrMixture< ThermoType >::patchFaceTransportMixture().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ patchFaceTransportMixture() [1/2]

const transportMixtureType& patchFaceTransportMixture	(	const label	patchi,
		const label	facei
	)		const

inline

Definition at line 155 of file egrMixture.H.

References egrMixture< ThermoType >::cellTransportMixture(), and egrMixture< ThermoType >::patchFaceThermoMixture().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cellTransportMixture() [2/2]

const transportMixtureType& cellTransportMixture	(	const label	,
		const thermoMixtureType &	thermoMixture
	)		const

inline

Definition at line 164 of file egrMixture.H.

References egrMixture< ThermoType >::patchFaceTransportMixture().

Here is the call graph for this function:

◆ patchFaceTransportMixture() [2/2]

const transportMixtureType& patchFaceTransportMixture	(	const label	,
		const label	,
		const thermoMixtureType &	thermoMixture
	)		const

inline

Definition at line 173 of file egrMixture.H.

◆ cellReactants()

const thermoType& cellReactants ( const label celli ) const

inline

Definition at line 182 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 188 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 201 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 207 of file egrMixture.H.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), egrMixture< ThermoType >::mixture(), egrMixture< ThermoType >::operator=(), 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:

◆ operator=()

void operator= ( const egrMixture< ThermoType > & )

delete

Disallow default bitwise assignment.

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

Here is the caller graph for this function:

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

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ thermoType

◆ thermoMixtureType

◆ transportMixtureType

Constructor & Destructor Documentation

◆ egrMixture() [1/2]

◆ egrMixture() [2/2]

◆ ~egrMixture()

Member Function Documentation

◆ typeName()

◆ stoicRatio()

◆ mixture()

◆ cellThermoMixture()

◆ patchFaceThermoMixture()

◆ cellTransportMixture() [1/2]

◆ patchFaceTransportMixture() [1/2]

◆ cellTransportMixture() [2/2]

◆ patchFaceTransportMixture() [2/2]

◆ cellReactants()

◆ patchFaceReactants()

◆ cellProducts()

◆ patchFaceProducts()

◆ read()

◆ specieThermo()

◆ operator=()

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