Public Types | Public Member Functions | Protected Attributes | List of all members
basicMultiComponentMixture Class Reference

Multi-component mixture. More...

Inheritance diagram for basicMultiComponentMixture:
Inheritance graph
[legend]
Collaboration diagram for basicMultiComponentMixture:
Collaboration graph
[legend]

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 speciesTablespecies () 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...
 
volScalarFieldY (const label i)
 Return the mass-fraction field for a specie given by index. More...
 
const volScalarFieldY (const label i) const
 Return the const mass-fraction field for a specie given by index. More...
 
volScalarFieldY (const word &specieName)
 Return the mass-fraction field for a specie given by name. More...
 
const volScalarFieldY (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< volScalarFieldY_
 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

Definition at line 54 of file basicMultiComponentMixture.H.

Member Typedef Documentation

The base class of the mixture.

Definition at line 75 of file basicMultiComponentMixture.H.

Constructor & Destructor Documentation

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 IOobject::AUTO_WRITE, forAll, IOobject::groupName(), mesh, IOobject::MUST_READ, IOobject::NO_READ, IOobject::NO_WRITE, fvMesh::time(), and Time::timeName().

Here is the call graph for this function:

virtual ~basicMultiComponentMixture ( )
inlinevirtual

Destructor.

Definition at line 91 of file basicMultiComponentMixture.H.

References basicMultiComponentMixture::contains(), basicMultiComponentMixture::species(), and basicMultiComponentMixture::Y().

Here is the call graph for this function:

Member Function Documentation

TypeName ( "basicMultiComponentMixture"  )

Run time type information.

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

Return the const mass-fraction fields.

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

References basicMultiComponentMixture::Y(), and basicMultiComponentMixture::Y_.

Here is the call graph for this function:

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.

References basicMultiComponentMixture::Y(), and basicMultiComponentMixture::Y_.

Here is the call graph for this function:

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.

References basicMultiComponentMixture::species_, basicMultiComponentMixture::Y(), and basicMultiComponentMixture::Y_.

Here is the call graph for this function:

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.

References basicMultiComponentMixture::contains(), basicMultiComponentMixture::species_, and basicMultiComponentMixture::Y_.

Here is the call graph for this function:

bool contains ( const word specieName) const
inline

Does the mixture include this specie?

Definition at line 81 of file basicMultiComponentMixtureI.H.

References hashedWordList::contains(), and basicMultiComponentMixture::species_.

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

speciesTable species_
protected
PtrList<volScalarField> Y_
protected

Species mass fractions.

Definition at line 65 of file basicMultiComponentMixture.H.

Referenced by basicMultiComponentMixture::Y().


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