Public Types | Public Member Functions | Static Public Member Functions | List of all members
chemistryReader< ThermoType > Class Template Referenceabstract

Abstract class for reading chemistry. More...

Inheritance diagram for chemistryReader< ThermoType >:
Inheritance graph
[legend]

Public Types

typedef ThermoType thermoType
 The type of thermo package the reader was instantiated for. More...
 

Public Member Functions

 TypeName ("chemistryReader")
 Runtime type information. More...
 
 chemistryReader ()
 Construct null. More...
 
 declareRunTimeSelectionTable (autoPtr, chemistryReader, dictionary,(const dictionary &thermoDict, speciesTable &species),(thermoDict, species))
 
virtual ~chemistryReader ()
 Destructor. More...
 
virtual const speciesTablespecies () const =0
 Return access to the list of species. More...
 
virtual const speciesCompositionTablespecieComposition () const =0
 Table of species composition. More...
 
virtual const HashPtrTable< ThermoType > & speciesThermo () const =0
 Return access to the thermo packages. More...
 
virtual const ReactionList< ThermoType > & reactions () const =0
 Return access to the list of reactions. More...
 

Static Public Member Functions

static autoPtr< chemistryReaderNew (const dictionary &thermoDict, speciesTable &species)
 Select constructed from dictionary. More...
 

Detailed Description

template<class ThermoType>
class Foam::chemistryReader< ThermoType >

Abstract class for reading chemistry.

Source files

Definition at line 56 of file chemistryReader.H.

Member Typedef Documentation

◆ thermoType

typedef ThermoType thermoType

The type of thermo package the reader was instantiated for.

Definition at line 73 of file chemistryReader.H.

Constructor & Destructor Documentation

◆ chemistryReader()

chemistryReader ( )
inline

Construct null.

Definition at line 79 of file chemistryReader.H.

◆ ~chemistryReader()

virtual ~chemistryReader ( )
inlinevirtual

Destructor.

Definition at line 109 of file chemistryReader.H.

Member Function Documentation

◆ TypeName()

TypeName ( "chemistryReader< ThermoType >"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
chemistryReader< ThermoType >  ,
dictionary  ,
(const dictionary &thermoDict, speciesTable &species ,
(thermoDict, species  
)

Referenced by chemistryReader< gasHThermoPhysics >::chemistryReader().

Here is the caller graph for this function:

◆ New()

Foam::autoPtr< Foam::chemistryReader< ThermoType > > New ( const dictionary thermoDict,
speciesTable species 
)
static

Select constructed from dictionary.

Definition at line 33 of file chemistryReader.C.

Referenced by chemistryReader< gasHThermoPhysics >::chemistryReader().

Here is the caller graph for this function:

◆ species()

virtual const speciesTable& species ( ) const
pure virtual

Return access to the list of species.

Implemented in chemkinReader, and foamChemistryReader< ThermoType >.

Referenced by chemistryReader< gasHThermoPhysics >::chemistryReader(), and chemistryReader< gasHThermoPhysics >::~chemistryReader().

Here is the caller graph for this function:

◆ specieComposition()

virtual const speciesCompositionTable& specieComposition ( ) const
pure virtual

Table of species composition.

Implemented in chemkinReader, and foamChemistryReader< ThermoType >.

Referenced by chemistryReader< gasHThermoPhysics >::~chemistryReader().

Here is the caller graph for this function:

◆ speciesThermo()

virtual const HashPtrTable<ThermoType>& speciesThermo ( ) const
pure virtual

Return access to the thermo packages.

Implemented in chemkinReader, and foamChemistryReader< ThermoType >.

Referenced by chemistryReader< gasHThermoPhysics >::~chemistryReader().

Here is the caller graph for this function:

◆ reactions()

virtual const ReactionList<ThermoType>& reactions ( ) const
pure virtual

Return access to the list of reactions.

Implemented in chemkinReader, and foamChemistryReader< ThermoType >.

Referenced by chemistryReader< gasHThermoPhysics >::~chemistryReader().

Here is the caller graph for this function:

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