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...

	foamChemistryReader (const foamChemistryReader &)=delete
	Disallow default bitwise copy construction. More...

virtual	~foamChemistryReader ()
	Destructor. More...

const wordList &	elementNames () const
	List of elements. More...

const HashTable< label > &	elementIndices () const
	Element indices. More...

const speciesTable &	species () const
	Table of species. More...

const speciesCompositionTable &	specieComposition () const
	Table of species composition. 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...

void	operator= (const foamChemistryReader &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from chemistryReader< ThermoType >
	TypeName ("chemistryReader")
	Runtime type information. More...

	chemistryReader ()
	Construct null. More...

	chemistryReader (const chemistryReader &)=delete
	Disallow default bitwise copy construction. More...

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

virtual	~chemistryReader ()
	Destructor. More...

void	operator= (const chemistryReader &)=delete
	Disallow default bitwise assignment. 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

Definition at line 55 of file foamChemistryReader.H.

Constructor & Destructor Documentation

◆ foamChemistryReader() [1/3]

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

Construct from foamChemistry and thermodynamics file names.

Definition at line 128 of file foamChemistryReader.C.

◆ foamChemistryReader() [2/3]

foamChemistryReader	(	const dictionary &	thermoDict,
		speciesTable &	species
	)

Construct by getting the foamChemistry and thermodynamics file names.

from dictionary

Definition at line 159 of file foamChemistryReader.C.

◆ foamChemistryReader() [3/3]

foamChemistryReader ( const foamChemistryReader< ThermoType > & )

delete

Disallow default bitwise copy construction.

◆ ~foamChemistryReader()

virtual ~foamChemistryReader ( )

inlinevirtual

Destructor.

Definition at line 122 of file foamChemistryReader.H.

Member Function Documentation

◆ TypeName()

TypeName ( "foamChemistryReader< ThermoType >" )

Runtime type information.

◆ elementNames()

const wordList& elementNames ( ) const

inline

List of elements.

Definition at line 129 of file foamChemistryReader.H.

◆ elementIndices()

const HashTable<label>& elementIndices ( ) const

inline

Element indices.

Definition at line 135 of file foamChemistryReader.H.

◆ species()

const speciesTable& species ( ) const

inlinevirtual

Table of species.

Implements chemistryReader< ThermoType >.

Definition at line 141 of file foamChemistryReader.H.

◆ specieComposition()

const speciesCompositionTable& specieComposition ( ) const

inlinevirtual

Table of species composition.

Implements chemistryReader< ThermoType >.

Definition at line 147 of file foamChemistryReader.H.

◆ speciesThermo()

const HashPtrTable<ThermoType>& speciesThermo ( ) const

inlinevirtual

Table of the thermodynamic data given in the foamChemistry file.

Implements chemistryReader< ThermoType >.

Definition at line 153 of file foamChemistryReader.H.

◆ reactions()

const ReactionList<ThermoType>& reactions ( ) const

inlinevirtual

List of the reactions.

Implements chemistryReader< ThermoType >.

Definition at line 159 of file foamChemistryReader.H.

References foamChemistryReader< ThermoType >::operator=().

Here is the call graph for this function:

◆ operator=()

void operator= ( const foamChemistryReader< ThermoType > & )

delete

Disallow default bitwise assignment.

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

Here is the caller graph for this function:

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

Public Member Functions

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ foamChemistryReader() [1/3]

◆ foamChemistryReader() [2/3]

◆ foamChemistryReader() [3/3]

◆ ~foamChemistryReader()

Member Function Documentation

◆ TypeName()

◆ elementNames()

◆ elementIndices()

◆ species()

◆ specieComposition()

◆ speciesThermo()

◆ reactions()

◆ operator=()

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