FreeFOAM The Cross-Platform CFD Toolkit
basicMultiComponentMixture Class Reference

combustion mixture More...

#include <reactionThermophysicalModels/basicMultiComponentMixture.H>


Detailed Description

+ Inheritance diagram for basicMultiComponentMixture:
+ Collaboration diagram for basicMultiComponentMixture:

List of all members.

Public Member Functions

 basicMultiComponentMixture (const dictionary &, const wordList &specieNames, const fvMesh &)
 Construct from dictionary and mesh.
virtual ~basicMultiComponentMixture ()
 Destructor.
const speciesTablespecies () 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.
volScalarFieldY (const label i)
 Return the mass-fraction field for a specie given by index.
const volScalarFieldY (const label i) const
 Return the const mass-fraction field for a specie given by index.
volScalarFieldY (const word &specieName)
 Return the mass-fraction field for a specie given by name.
const volScalarFieldY (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< volScalarFieldfres (const volScalarField &ft, const dimensionedScalar &stoicRatio) const

Protected Attributes

speciesTable species_
 Table of specie names.
PtrList< volScalarFieldY_
 Species mass fractions.

Constructor & Destructor Documentation

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

Construct from dictionary and mesh.

Definition at line 31 of file basicMultiComponentMixture.C.

References forAll, mesh, fvMesh::time(), and Time::timeName().

virtual ~basicMultiComponentMixture ( )
inlinevirtual

Destructor.

Definition at line 79 of file basicMultiComponentMixture.H.


Member Function Documentation

const speciesTable& species ( ) const
inline

Return the table of species.

Definition at line 86 of file basicMultiComponentMixture.H.

References basicMultiComponentMixture::species_.

Return the mass-fraction fields.

Definition at line 27 of file basicMultiComponentMixtureI.H.

References basicMultiComponentMixture::Y_.

Referenced by parcel::move().

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

Return the const mass-fraction fields.

Definition at line 34 of file basicMultiComponentMixtureI.H.

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

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

Definition at line 40 of file basicMultiComponentMixtureI.H.

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

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

Definition at line 47 of file basicMultiComponentMixtureI.H.

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

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

Definition at line 56 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 65 of file basicMultiComponentMixtureI.H.

bool contains ( const word specieName) const
inline

Does the mixture include this specie?

Definition at line 74 of file basicMultiComponentMixtureI.H.

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

Definition at line 93 of file basicMultiComponentMixtureI.H.

References Foam::max(), and dimensioned< Type >::value().


Member Data Documentation

speciesTable species_
protected

Table of specie names.

Definition at line 59 of file basicMultiComponentMixture.H.

Referenced by basicMultiComponentMixture::species().

PtrList<volScalarField> Y_
protected

Species mass fractions.

Definition at line 62 of file basicMultiComponentMixture.H.

Referenced by basicMultiComponentMixture::Y().


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