FreeFOAM The Cross-Platform CFD Toolkit
chemkinReader Class Reference

Foam::chemkinReader. More...

#include <reactionThermophysicalModels/chemkinReader.H>


Detailed Description

+ Inheritance diagram for chemkinReader:
+ Collaboration diagram for chemkinReader:

List of all members.

Classes

struct  specieElement
 species element More...

Public Types

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

Public Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from chemistryReader< gasThermoPhysics >
static autoPtr< chemistryReaderNew (const dictionary &thermoDict)
 Select constructed from dictionary.

Member Enumeration Documentation

enum phase
Enumerator:
solid 
liquid 
gas 

Definition at line 72 of file chemkinReader.H.


Constructor & Destructor Documentation

chemkinReader ( const fileName chemkinFile,
const fileName thermoFileName = fileName::null 
)

Construct from CHEMKIN III file name.

Definition at line 851 of file chemkinReader.C.

chemkinReader ( const dictionary thermoDict)

Construct by getting the CHEMKIN III file name from dictionary.

Definition at line 865 of file chemkinReader.C.

References dictionary::found(), dictionary::lookup(), dictionaryName::name(), fileName::null, and fileName::path().

virtual ~chemkinReader ( )
inlinevirtual

Definition at line 330 of file chemkinReader.H.


Member Function Documentation

TypeName ( "chemkinReader"  )

Runtime type information.

const wordList& elementNames ( ) const
inline

List of elements.

Definition at line 337 of file chemkinReader.H.

const HashTable<label>& elementIndices ( ) const
inline

Element indices.

Definition at line 343 of file chemkinReader.H.

const HashTable<scalar>& isotopeAtomicWts ( ) const
inline

Isotope molecular weights.

Definition at line 349 of file chemkinReader.H.

const speciesTable& species ( ) const
inlinevirtual

Table of species.

Implements chemistryReader< gasThermoPhysics >.

Definition at line 355 of file chemkinReader.H.

const HashTable<phase>& speciePhase ( ) const
inline

Specie phase.

Definition at line 361 of file chemkinReader.H.

const HashPtrTable<gasThermoPhysics>& speciesThermo ( ) const
inlinevirtual

Table of the thermodynamic data given in the CHEMKIN file.

Implements chemistryReader< gasThermoPhysics >.

Definition at line 367 of file chemkinReader.H.

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

Table of species composition.

Definition at line 373 of file chemkinReader.H.

const SLPtrList<gasReaction>& reactions ( ) const
inlinevirtual

List of the reactions.

Implements chemistryReader< gasThermoPhysics >.

Definition at line 379 of file chemkinReader.H.


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