chemistryReader< ThermoType > Class Template Reference

Abstract class for reading chemistry. More...

#include <chemistryReader.H>

Inheritance diagram for chemistryReader< ThermoType >:

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

Public Member Functions
	TypeName ("chemistryReader")
	Runtime type information.
	chemistryReader ()
	Default construct.
	declareRunTimeSelectionTable (autoPtr, chemistryReader, dictionary,(const dictionary &thermoDict, speciesTable &species),(thermoDict, species))
virtual	~chemistryReader ()=default
	Destructor.
virtual const speciesTable &	species () const =0
	Return access to the list of species.
virtual const speciesCompositionTable &	specieComposition () const =0
	Table of species composition.
virtual const ReactionTable< ThermoType > &	speciesThermo () const =0
	Return access to the thermo packages.
virtual const ReactionList< ThermoType > &	reactions () const =0
	Return access to the list of reactions.

Static Public Member Functions
static autoPtr< chemistryReader >	New (const dictionary &thermoDict, speciesTable &species)
	Select constructed from dictionary.

Detailed Description

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

Abstract class for reading chemistry.

Source files

• chemistryReader.H
• chemistryReader.C

Definition at line 57 of file chemistryReader.H.

Member Typedef Documentation

thermoType

template<class ThermoType>

typedef ThermoType thermoType

The type of thermo package the reader was instantiated for.

Definition at line 69 of file chemistryReader.H.

Constructor & Destructor Documentation

chemistryReader()

template<class ThermoType>

chemistryReader ( )

inline

Default construct.

Definition at line 77 of file chemistryReader.H.

Referenced by declareRunTimeSelectionTable(), foamChemistryReader< ThermoType >::foamChemistryReader(), and foamChemistryReader< ThermoType >::foamChemistryReader().

Here is the caller graph for this function:

~chemistryReader()

template<class ThermoType>

virtual ~chemistryReader ( )

virtualdefault

Destructor.

Member Function Documentation

TypeName()

template<class ThermoType>

TypeName

(

"chemistryReader< ThermoType >"

)

Runtime type information.

declareRunTimeSelectionTable()

template<class ThermoType>

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

References chemistryReader(), species(), and thermoDict.

Here is the call graph for this function:

New()

template<class ThermoType>

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

static

Select constructed from dictionary.

Definition at line 28 of file chemistryReader.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, species(), and thermoDict.

Here is the call graph for this function:

species()

template<class ThermoType>

virtual const speciesTable & species ( ) const

pure virtual

Return access to the list of species.

Implemented in chemkinReader, and foamChemistryReader< ThermoType >.

Referenced by declareRunTimeSelectionTable(), and New().

Here is the caller graph for this function:

specieComposition()

template<class ThermoType>

virtual const speciesCompositionTable & specieComposition ( ) const

pure virtual

Table of species composition.

Implemented in chemkinReader, and foamChemistryReader< ThermoType >.

speciesThermo()

template<class ThermoType>

virtual const ReactionTable< ThermoType > & speciesThermo ( ) const

pure virtual

Return access to the thermo packages.

Implemented in chemkinReader, and foamChemistryReader< ThermoType >.

reactions()

template<class ThermoType>

virtual const ReactionList< ThermoType > & reactions ( ) const

pure virtual

Return access to the list of reactions.

Implemented in chemkinReader, and foamChemistryReader< ThermoType >.

---

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

• src/thermophysicalModels/reactionThermo/chemistryReaders/chemistryReader/chemistryReader.H
• src/thermophysicalModels/reactionThermo/chemistryReaders/chemistryReader/chemistryReader.C