basicMultiComponentMixture Class Reference

combustion mixture More...

Inheritance diagram for basicMultiComponentMixture:

[legend]

Collaboration diagram for basicMultiComponentMixture:

[legend]

List of all members.

Public Member Functions
	basicMultiComponentMixture (const dictionary &, const wordList &specieNames, const fvMesh &)
	Construct from dictionary and mesh.
virtual	~basicMultiComponentMixture ()
	Destructor.
const speciesTable &	species () const
	Return the table of species.
PtrList< volScalarField > &	Y ()
	Return the mass-fraction fields.
const PtrList< volScalarField > &	Y () const
	Return the const mass-fraction fields.
volScalarField &	Y (const label i)
	Return the mass-fraction field for a specie given by index.
const volScalarField &	Y (const label i) const
	Return the const mass-fraction field for a specie given by index.
volScalarField &	Y (const word &specieName)
	Return the mass-fraction field for a specie given by name.
const volScalarField &	Y (const word &specieName) const
	Return the const mass-fraction field for a specie given by name.
bool	contains (const word &specieName) const
	Does the mixture include this specie?
scalar	fres (const scalar ft, const scalar stoicRatio) const
tmp< volScalarField >	fres (const volScalarField &ft, const dimensionedScalar &stoicRatio) const
Protected Attributes
speciesTable	species_
	Table of specie names.
PtrList< volScalarField >	Y_
	Species mass fractions.

---

Detailed Description

combustion mixture

Source files

• basicMultiComponentMixture.H
• basicMultiComponentMixture.C

Definition at line 46 of file basicMultiComponentMixture.H.

---

Constructor & Destructor Documentation

basicMultiComponentMixture	(	const dictionary &	thermoDict,
		const wordList &	specieNames,
		const fvMesh &	mesh
	)

Construct from dictionary and mesh.

Definition at line 23 of file basicMultiComponentMixture.C.

References IOobject::AUTO_WRITE, forAll, IOobject::MUST_READ, IOobject::NO_READ, IOobject::NO_WRITE, PtrList< T >::set(), basicMultiComponentMixture::species_, fvMesh::time(), Time::timeName(), and basicMultiComponentMixture::Y_.

Here is the call graph for this function:

virtual ~basicMultiComponentMixture

(

)

[inline, virtual]

Destructor.

Definition at line 74 of file basicMultiComponentMixture.H.

---

Member Function Documentation

const speciesTable& species

(

)

const [inline]

Return the table of species.

Definition at line 81 of file basicMultiComponentMixture.H.

Foam::PtrList< Foam::volScalarField > & Y

(

)

[inline]

Return the mass-fraction fields.

Definition at line 19 of file basicMultiComponentMixtureI.H.

const Foam::PtrList< Foam::volScalarField > & Y

(

)

const [inline]

Return the const mass-fraction fields.

Definition at line 26 of file basicMultiComponentMixtureI.H.

References basicMultiComponentMixture::Y_.

Foam::volScalarField & Y

(

const label

i

)

[inline]

Return the mass-fraction field for a specie given by index.

Definition at line 32 of file basicMultiComponentMixtureI.H.

References basicMultiComponentMixture::Y_.

const Foam::volScalarField & Y

(

const label

i

)

const [inline]

Return the const mass-fraction field for a specie given by index.

Definition at line 39 of file basicMultiComponentMixtureI.H.

References basicMultiComponentMixture::Y_.

Foam::volScalarField & Y

(

const word &

specieName

)

[inline]

Return the mass-fraction field for a specie given by name.

Definition at line 48 of file basicMultiComponentMixtureI.H.

const Foam::volScalarField & Y

(

const word &

specieName

)

const [inline]

Return the const mass-fraction field for a specie given by name.

Definition at line 57 of file basicMultiComponentMixtureI.H.

bool contains

(

const word &

specieName

)

const [inline]

Does the mixture include this specie?

Definition at line 66 of file basicMultiComponentMixtureI.H.

Foam::scalar fres	(	const scalar	ft,
		const scalar	stoicRatio
	)			const [inline]

Definition at line 75 of file basicMultiComponentMixtureI.H.

Referenced by dieselMixture< ThermoType >::patchFaceProducts(), and veryInhomogeneousMixture< ThermoType >::patchFaceProducts().

Here is the caller graph for this function:

Foam::tmp< Foam::volScalarField > fres	(	const volScalarField &	ft,
		const dimensionedScalar &	stoicRatio
	)			const [inline]

Definition at line 85 of file basicMultiComponentMixtureI.H.

References Foam::max().

Here is the call graph for this function:

---

Member Data Documentation

speciesTable species_ [protected]

Table of specie names.

Definition at line 54 of file basicMultiComponentMixture.H.

Referenced by basicMultiComponentMixture::basicMultiComponentMixture().

PtrList<volScalarField> Y_ [protected]

Species mass fractions.

Definition at line 57 of file basicMultiComponentMixture.H.

Referenced by basicMultiComponentMixture::basicMultiComponentMixture(), and basicMultiComponentMixture::Y().

---

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

• src/thermophysicalModels/reactionThermo/mixtures/basicMultiComponentMixture/basicMultiComponentMixture.H
• src/thermophysicalModels/reactionThermo/mixtures/basicMultiComponentMixture/basicMultiComponentMixture.C
• src/thermophysicalModels/reactionThermo/mixtures/basicMultiComponentMixture/basicMultiComponentMixtureI.H