OpenFOAM logo
Open Source CFD Toolkit

speciesTable Class Reference

Inheritance diagram for speciesTable:

Inheritance graph
[legend]
Collaboration diagram for speciesTable:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 speciesTable (const wordList &specieNames)
 Construct from list of specie names.
 speciesTable (const label nSpecies, const char **specieNames)
 Construct from number of species and list of specie names.
 speciesTable (Istream &)
 Construct from Istream.
bool contains (const word &specieName) const
 Does the table contain the given specie.
const wordoperator[] (const label) const
 Return a specie's name.
label operator[] (const word &) const
 Lookup a specie's name and return it's index.

Friends

Istreamoperator>> (Istream &, speciesTable &)

Constructor & Destructor Documentation

speciesTable const wordList specieNames  ) 
 

Construct from list of specie names.

speciesTable const label  nSpecies,
const char **  specieNames
 

Construct from number of species and list of specie names.

speciesTable Istream  ) 
 

Construct from Istream.


Member Function Documentation

bool contains const word specieName  )  const [inline]
 

Does the table contain the given specie.

Definition at line 39 of file speciesTableI.H.

References Foam::label.

Referenced by combustionMixture::Y().

Foam::label operator[] const word  )  const [inline]
 

Lookup a specie's name and return it's index.

Definition at line 56 of file speciesTableI.H.

const Foam::word & operator[] const   label  )  const [inline]
 

Return a specie's name.

Reimplemented from UList< word >.

Definition at line 48 of file speciesTableI.H.


Friends And Related Function Documentation

Istream& operator>> Istream ,
speciesTable
[friend]
 


The documentation for this class was generated from the following files:
For further information go to www.openfoam.org