foamChemistryReader< ThermoType > Class Template Reference

Chemistry reader for OpenFOAM format. More...

#include <foamChemistryReader.H>

Inheritance diagram for foamChemistryReader< ThermoType >:

Collaboration diagram for foamChemistryReader< ThermoType >:

Public Member Functions
	TypeName ("foamChemistryReader")
	Runtime type information.
	foamChemistryReader (const fileName &reactionsFileName, speciesTable &species, const fileName &thermoFileName)
	Construct from foamChemistry and thermodynamics file names.
	foamChemistryReader (const dictionary &thermoDict, speciesTable &species)
	Construct by getting foamChemistry and thermodynamics file names from dictionary.
virtual	~foamChemistryReader ()=default
	Destructor.
const wordList &	elementNames () const
	List of elements.
const HashTable< label > &	elementIndices () const
	Element indices.
const speciesTable &	species () const
	Table of species.
const speciesCompositionTable &	specieComposition () const
	Table of species composition.
const ReactionTable< ThermoType > &	speciesThermo () const
	Table of the thermodynamic data given in the foamChemistry file.
const ReactionList< ThermoType > &	reactions () const
	List of the reactions.
Public Member Functions inherited from chemistryReader< ThermoType >
	TypeName ("chemistryReader")
	Runtime type information.
	chemistryReader ()
	Default construct.
	declareRunTimeSelectionTable (autoPtr, chemistryReader, dictionary,(const dictionary &thermoDict, speciesTable &species),(thermoDict, species))
virtual	~chemistryReader ()=default
	Destructor.

Additional Inherited Members
Public Types inherited from chemistryReader< ThermoType >
typedef ThermoType	thermoType
	The type of thermo package the reader was instantiated for.
Static Public Member Functions inherited from chemistryReader< ThermoType >
static autoPtr< chemistryReader >	New (const dictionary &thermoDict, speciesTable &species)
	Select constructed from dictionary.

Detailed Description

template<class ThermoType>
class Foam::foamChemistryReader< ThermoType >

Chemistry reader for OpenFOAM format.

Source files

• foamChemistryReader.H
• foamChemistryReader.C

Definition at line 55 of file foamChemistryReader.H.

Constructor & Destructor Documentation

foamChemistryReader() [1/2]

template<class ThermoType>

foamChemistryReader	(	const fileName &	reactionsFileName,
		speciesTable &	species,
		const fileName &	thermoFileName )

Construct from foamChemistry and thermodynamics file names.

Definition at line 108 of file foamChemistryReader.C.

References chemistryReader< ThermoType >::chemistryReader(), and species().

Here is the call graph for this function:

foamChemistryReader() [2/2]

template<class ThermoType>

foamChemistryReader	(	const dictionary &	thermoDict,
		speciesTable &	species )

Construct by getting foamChemistry and thermodynamics file names from dictionary.

Definition at line 139 of file foamChemistryReader.C.

References chemistryReader< ThermoType >::chemistryReader(), species(), and thermoDict.

Here is the call graph for this function:

~foamChemistryReader()

template<class ThermoType>

virtual ~foamChemistryReader ( )

virtualdefault

Destructor.

Member Function Documentation

TypeName()

template<class ThermoType>

TypeName

(

"foamChemistryReader< ThermoType >"

)

Runtime type information.

References species(), and thermoDict.

Here is the call graph for this function:

elementNames()

template<class ThermoType>

const wordList & elementNames ( ) const

inline

List of elements.

Definition at line 165 of file foamChemistryReader.H.

elementIndices()

template<class ThermoType>

const HashTable< label > & elementIndices ( ) const

inline

Element indices.

Definition at line 173 of file foamChemistryReader.H.

species()

template<class ThermoType>

const speciesTable & species ( ) const

inlinevirtual

Table of species.

Implements chemistryReader< ThermoType >.

Definition at line 181 of file foamChemistryReader.H.

Referenced by foamChemistryReader(), foamChemistryReader(), and TypeName().

Here is the caller graph for this function:

specieComposition()

template<class ThermoType>

const speciesCompositionTable & specieComposition ( ) const

inlinevirtual

Table of species composition.

Implements chemistryReader< ThermoType >.

Definition at line 189 of file foamChemistryReader.H.

speciesThermo()

template<class ThermoType>

const ReactionTable< ThermoType > & speciesThermo ( ) const

inlinevirtual

Table of the thermodynamic data given in the foamChemistry file.

Implements chemistryReader< ThermoType >.

Definition at line 197 of file foamChemistryReader.H.

reactions()

template<class ThermoType>

const ReactionList< ThermoType > & reactions ( ) const

inlinevirtual

List of the reactions.

Implements chemistryReader< ThermoType >.

Definition at line 205 of file foamChemistryReader.H.

---

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

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