Classes | Public Types | Public Member Functions | List of all members
chemkinReader Class Reference

Foam::chemkinReader. More...

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

Classes

struct  specieElement
 species element More...
 

Public Types

enum  phase { solid, liquid, gas }
 
- Public Types inherited from chemistryReader< gasHThermoPhysics >
typedef gasHThermoPhysics thermoType
 The type of thermo package the reader was instantiated for. More...
 

Public Member Functions

 TypeName ("chemkinReader")
 Runtime type information. More...
 
 chemkinReader (const fileName &chemkinFile, speciesTable &species, const fileName &thermoFileName=fileName::null, const bool newFormat=false)
 Construct from CHEMKIN III file name. More...
 
 chemkinReader (const dictionary &thermoDict, speciesTable &species)
 Construct by getting the CHEMKIN III file name from dictionary. More...
 
virtual ~chemkinReader ()
 Destructor. More...
 
const wordListelementNames () const
 List of elements. More...
 
const HashTable< label > & elementIndices () const
 Element indices. More...
 
const HashTable< scalar > & isotopeAtomicWts () const
 Isotope molecular weights. More...
 
const speciesTablespecies () const
 Table of species. More...
 
const HashTable< phase > & speciePhase () const
 Specie phase. More...
 
const HashPtrTable< gasHThermoPhysics > & speciesThermo () const
 Table of the thermodynamic data given in the CHEMKIN file. More...
 
const HashTable< List< specieElement > > & specieComposition () const
 Table of species composition. More...
 
const ReactionList< gasHThermoPhysics > & reactions () const
 List of the reactions. More...
 
- Public Member Functions inherited from chemistryReader< gasHThermoPhysics >
 chemistryReader ()
 Construct null. More...
 
 TypeName ("chemistryReader")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, chemistryReader, dictionary,( const dictionary &thermoDict, speciesTable &species ),(thermoDict, species))
 
virtual ~chemistryReader ()
 Destructor. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from chemistryReader< gasHThermoPhysics >
static autoPtr< chemistryReaderNew (const dictionary &thermoDict, speciesTable &species)
 Select constructed from dictionary. More...
 

Detailed Description

Foam::chemkinReader.

Source files

Definition at line 62 of file chemkinReader.H.

Member Enumeration Documentation

enum phase
Enumerator
solid 
liquid 
gas 

Definition at line 72 of file chemkinReader.H.

Constructor & Destructor Documentation

chemkinReader ( const fileName chemkinFile,
speciesTable species,
const fileName thermoFileName = fileName::null,
const bool  newFormat = false 
)

Construct from CHEMKIN III file name.

Definition at line 832 of file chemkinReader.C.

References Foam::read().

Here is the call graph for this function:

chemkinReader ( const dictionary thermoDict,
speciesTable species 
)

Construct by getting the CHEMKIN III file name from dictionary.

Definition at line 851 of file chemkinReader.C.

References Foam::endl(), Foam::stringOps::expand(), dictionary::found(), Foam::Info, dictionary::lookup(), dictionaryName::name(), fileName::null, fileName::path(), and Foam::read().

Here is the call graph for this function:

virtual ~chemkinReader ( )
inlinevirtual

Destructor.

Definition at line 337 of file chemkinReader.H.

Member Function Documentation

TypeName ( "chemkinReader"  )

Runtime type information.

const wordList& elementNames ( ) const
inline

List of elements.

Definition at line 344 of file chemkinReader.H.

const HashTable<label>& elementIndices ( ) const
inline

Element indices.

Definition at line 350 of file chemkinReader.H.

const HashTable<scalar>& isotopeAtomicWts ( ) const
inline

Isotope molecular weights.

Definition at line 356 of file chemkinReader.H.

const speciesTable& species ( ) const
inlinevirtual

Table of species.

Implements chemistryReader< gasHThermoPhysics >.

Definition at line 362 of file chemkinReader.H.

const HashTable<phase>& speciePhase ( ) const
inline

Specie phase.

Definition at line 368 of file chemkinReader.H.

const HashPtrTable<gasHThermoPhysics>& speciesThermo ( ) const
inlinevirtual

Table of the thermodynamic data given in the CHEMKIN file.

Implements chemistryReader< gasHThermoPhysics >.

Definition at line 374 of file chemkinReader.H.

const HashTable<List<specieElement> >& specieComposition ( ) const
inline

Table of species composition.

Definition at line 380 of file chemkinReader.H.

const ReactionList<gasHThermoPhysics>& reactions ( ) const
inlinevirtual

List of the reactions.

Implements chemistryReader< gasHThermoPhysics >.

Definition at line 386 of file chemkinReader.H.


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