basicMultiComponentMixture Class Reference

Multi-component mixture. More...

Inheritance diagram for basicMultiComponentMixture:

Collaboration diagram for basicMultiComponentMixture:

Public Types
typedef basicMultiComponentMixture	basicMixtureType
	The base class of the mixture. More...

Public Member Functions
	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...

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

Detailed Description

Multi-component mixture.

Provides a list of mass fraction fields and helper functions to query mixture composition.

Source files

• basicMultiComponentMixture.H
• basicMultiComponentMixture.C

Definition at line 54 of file basicMultiComponentMixture.H.

Member Typedef Documentation

basicMixtureType

typedef basicMultiComponentMixture basicMixtureType

The base class of the mixture.

Definition at line 75 of file basicMultiComponentMixture.H.

Constructor & Destructor Documentation

basicMultiComponentMixture()

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

Construct from dictionary, species names, mesh and phase name.

Definition at line 39 of file basicMultiComponentMixture.C.

References forAll, IOobject::headerOk(), and mesh.

Here is the call graph for this function:

~basicMultiComponentMixture()

virtual ~basicMultiComponentMixture ( )

inlinevirtual

Destructor.

Definition at line 91 of file basicMultiComponentMixture.H.

Member Function Documentation

TypeName()

TypeName

(

"basicMultiComponentMixture"

)

Run time type information.

species()

const Foam::speciesTable & species ( ) const

inline

Return the table of species.

Definition at line 27 of file basicMultiComponentMixtureI.H.

References basicMultiComponentMixture::species_.

Referenced by ReactingParcel::calc(), and SLGThermo::SLGThermo().

Here is the caller graph for this function:

Y() [1/6]

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

inline

Return the mass-fraction fields.

Definition at line 34 of file basicMultiComponentMixtureI.H.

Referenced by basicSpecieMixture::W().

Here is the caller graph for this function:

Y() [2/6]

const PtrList<volScalarField>& Y ( ) const

inline

Return the const mass-fraction fields.

Y() [3/6]

Foam::volScalarField & Y ( const label  i )

inline

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

Definition at line 47 of file basicMultiComponentMixtureI.H.

Y() [4/6]

const Foam::volScalarField & Y ( const label  i ) const

inline

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

Definition at line 54 of file basicMultiComponentMixtureI.H.

Y() [5/6]

Foam::volScalarField & Y ( const word &  specieName )

inline

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

Definition at line 63 of file basicMultiComponentMixtureI.H.

Y() [6/6]

const Foam::volScalarField & Y ( const word &  specieName ) const

inline

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

Definition at line 72 of file basicMultiComponentMixtureI.H.

contains()

bool contains ( const word &  specieName ) const

inline

Does the mixture include this specie?

Definition at line 81 of file basicMultiComponentMixtureI.H.

Field Documentation

species_

speciesTable species_

protected

Table of specie names.

Definition at line 62 of file basicMultiComponentMixture.H.

Referenced by basicMultiComponentMixture::species().

Y_

PtrList<volScalarField> Y_

protected

Species mass fractions.

Definition at line 65 of file basicMultiComponentMixture.H.

---

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