foamChemistryReader< ThermoType > Class Template Reference

Chemistry reader for OpenFOAM format. More...

Inheritance diagram for foamChemistryReader< ThermoType >:

Collaboration diagram for foamChemistryReader< ThermoType >:

Public Member Functions
	TypeName ("foamChemistryReader")
	Runtime type information. More...
	foamChemistryReader (const fileName &reactionsFileName, speciesTable &species, const fileName &thermoFileName)
	Construct from foamChemistry and thermodynamics file names. More...
	foamChemistryReader (const dictionary &thermoDict, speciesTable &species)
	Construct by getting the foamChemistry and thermodynamics file names. More...
virtual	~foamChemistryReader ()
	Destructor. More...
const speciesTable &	species () const
	Table of species. More...
const HashPtrTable< ThermoType > &	speciesThermo () const
	Table of the thermodynamic data given in the foamChemistry file. More...
const ReactionList< ThermoType > &	reactions () const
	List of the reactions. More...
Public Member Functions inherited from chemistryReader< ThermoType >
	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...

Private Member Functions
speciesTable &	setSpecies (const dictionary &dict, speciesTable &species)
	Set the species list. More...
	foamChemistryReader (const foamChemistryReader &)
	Disallow default bitwise copy construct. More...
void	operator= (const foamChemistryReader &)
	Disallow default bitwise assignment. More...

Private Attributes
dictionary	chemDict_
	Chemistry/reactions dictionary. More...
dictionary	thermoDict_
	Thermo properties dictionary. More...
HashPtrTable< ThermoType >	speciesThermo_
	Table of the thermodynamic data given in the foamChemistry file. More...
speciesTable &	speciesTable_
	Table of species. More...
ReactionList< ThermoType >	reactions_
	List of the reactions. More...

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

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/3]

foamChemistryReader ( const foamChemistryReader< ThermoType > &  )

private

Disallow default bitwise copy construct.

foamChemistryReader() [2/3]

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

Construct from foamChemistry and thermodynamics file names.

Definition at line 49 of file foamChemistryReader.C.

foamChemistryReader() [3/3]

foamChemistryReader	(	const dictionary &	thermoDict,
		speciesTable &	species
	)

Construct by getting the foamChemistry and thermodynamics file names.

from dictionary

Definition at line 78 of file foamChemistryReader.C.

~foamChemistryReader()

virtual ~foamChemistryReader ( )

inlinevirtual

Destructor.

Definition at line 113 of file foamChemistryReader.H.

Member Function Documentation

setSpecies()

Foam::speciesTable & setSpecies ( const dictionary &  dict, speciesTable &  species  )

private

Set the species list.

Definition at line 34 of file foamChemistryReader.C.

References dict, s(), and hashedWordList::transfer().

Here is the call graph for this function:

operator=()

void operator= ( const foamChemistryReader< ThermoType > &  )

private

Disallow default bitwise assignment.

TypeName()

TypeName

(

"foamChemistryReader< ThermoType >"

)

Runtime type information.

species()

const speciesTable& species ( ) const

inlinevirtual

Table of species.

Implements chemistryReader< ThermoType >.

Definition at line 120 of file foamChemistryReader.H.

References foamChemistryReader< ThermoType >::speciesTable_.

speciesThermo()

const HashPtrTable<ThermoType>& speciesThermo ( ) const

inlinevirtual

Table of the thermodynamic data given in the foamChemistry file.

Implements chemistryReader< ThermoType >.

Definition at line 126 of file foamChemistryReader.H.

References foamChemistryReader< ThermoType >::speciesThermo_.

reactions()

const ReactionList<ThermoType>& reactions ( ) const

inlinevirtual

List of the reactions.

Implements chemistryReader< ThermoType >.

Definition at line 132 of file foamChemistryReader.H.

References foamChemistryReader< ThermoType >::reactions_.

Field Documentation

chemDict_

dictionary chemDict_

private

Chemistry/reactions dictionary.

Definition at line 60 of file foamChemistryReader.H.

thermoDict_

dictionary thermoDict_

private

Thermo properties dictionary.

Definition at line 63 of file foamChemistryReader.H.

speciesThermo_

HashPtrTable<ThermoType> speciesThermo_

private

Table of the thermodynamic data given in the foamChemistry file.

Definition at line 66 of file foamChemistryReader.H.

Referenced by foamChemistryReader< ThermoType >::speciesThermo().

speciesTable_

speciesTable& speciesTable_

private

Table of species.

Definition at line 69 of file foamChemistryReader.H.

Referenced by foamChemistryReader< ThermoType >::species().

reactions_

ReactionList<ThermoType> reactions_

private

List of the reactions.

Definition at line 72 of file foamChemistryReader.H.

Referenced by foamChemistryReader< ThermoType >::reactions().

---

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