FreeFOAM The Cross-Platform CFD Toolkit
multiComponentMixture< ThermoType > Class Template Reference

Foam::multiComponentMixture. More...

#include <reactionThermophysicalModels/multiComponentMixture.H>


Detailed Description

+ Inheritance diagram for multiComponentMixture< ThermoType >:
+ Collaboration diagram for multiComponentMixture< ThermoType >:

List of all members.

Public Types

typedef ThermoType thermoType
 The type of thermodynamics this mixture is instantiated for.

Public Member Functions

 multiComponentMixture (const dictionary &, const wordList &specieNames, const HashPtrTable< ThermoType > &specieThermoData, const fvMesh &)
 Construct from dictionary, specie names, thermo database and mesh.
 multiComponentMixture (const dictionary &, const fvMesh &)
 Construct from dictionary and mesh.
virtual ~multiComponentMixture ()
 Destructor.
const ThermoTypecellMixture (const label celli) const
const ThermoTypepatchFaceMixture (const label patchi, const label facei) const
const PtrList< ThermoType > & speciesData () const
 Return the raw specie thermodynamic data.
void read (const dictionary &)
 Read dictionary.
- Public Member Functions inherited from basicMultiComponentMixture
 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

Additional Inherited Members

- Protected Attributes inherited from basicMultiComponentMixture
speciesTable species_
 Table of specie names.
PtrList< volScalarFieldY_
 Species mass fractions.

Member Typedef Documentation

The type of thermodynamics this mixture is instantiated for.

Reimplemented in reactingMixture< ThermoType >.

Definition at line 80 of file multiComponentMixture.H.


Constructor & Destructor Documentation

multiComponentMixture ( const dictionary thermoDict,
const wordList specieNames,
const HashPtrTable< ThermoType > &  specieThermoData,
const fvMesh mesh 
)

Construct from dictionary, specie names, thermo database and mesh.

Definition at line 70 of file multiComponentMixture.C.

References forAll.

multiComponentMixture ( const dictionary thermoDict,
const fvMesh mesh 
)

Construct from dictionary and mesh.

Definition at line 96 of file multiComponentMixture.C.

virtual ~multiComponentMixture ( )
inlinevirtual

Destructor.

Definition at line 99 of file multiComponentMixture.H.


Member Function Documentation

const ThermoType & cellMixture ( const label  celli) const

Definition at line 113 of file multiComponentMixture.C.

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

Definition at line 130 of file multiComponentMixture.C.

References patchi.

const PtrList<ThermoType>& speciesData ( ) const
inline

Return the raw specie thermodynamic data.

Definition at line 114 of file multiComponentMixture.H.

void read ( const dictionary thermoDict)

Read dictionary.

Reimplemented in reactingMixture< ThermoType >.

Definition at line 152 of file multiComponentMixture.C.

References forAll, and dictionary::lookup().


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