Read solid reactions of the type S1 = S2 + G1. More...

#include <solidReaction.H>

Inheritance diagram for solidReaction< ReactionThermo >:

[legend]

Collaboration diagram for solidReaction< ReactionThermo >:

Public Member Functions
	TypeName ("SolidReaction")
	Runtime type information.
	solidReaction (const Reaction< ReactionThermo > &reaction, const speciesTable &pyrolisisGases, const List< specieCoeffs > &glhs, const List< specieCoeffs > &grhs)
	Construct from components.
	solidReaction (const solidReaction< ReactionThermo > &, const speciesTable &pyrolisisGases)
	Construct as copy given new speciesTable.
	solidReaction (const speciesTable &species, const ReactionTable< ReactionThermo > &thermoDatabase, const dictionary &dict)
	Construct from dictionary.
virtual autoPtr< Reaction< ReactionThermo > >	clone () const
	Construct and return a clone.
virtual autoPtr< Reaction< ReactionThermo > >	clone (const speciesTable &species) const
	Construct and return a clone with new speciesTable.
virtual	~solidReaction ()=default
	Destructor.
virtual const List< specieCoeffs > &	grhs () const
	Access to gas components of the reaction.
virtual const List< specieCoeffs > &	glhs () const
virtual const speciesTable &	gasSpecies () const
	Access to gas specie list.
virtual void	write (Ostream &os) const
	Write.
Public Member Functions inherited from Reaction< ReactionThermo >
	TypeName ("Reaction")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, Reaction, dictionary,(const speciesTable &species, const ReactionTable< ReactionThermo > &thermoDatabase, const dictionary &dict),(species, thermoDatabase, dict))
	Reaction (const speciesTable &species, const List< specieCoeffs > &lhs, const List< specieCoeffs > &rhs, const ReactionTable< ReactionThermo > &thermoDatabase, bool initReactionThermo=true)
	Construct from components.
	Reaction (const Reaction< ReactionThermo > &, const speciesTable &species)
	Construct as copy given new speciesTable.
	Reaction (const speciesTable &species, const ReactionTable< ReactionThermo > &thermoDatabase, const dictionary &dict, bool initReactionThermo=true, bool failUnknownSpecie=true)
	Construct from dictionary.
virtual	~Reaction ()=default
	Destructor.
const word &	name () const noexcept
	Name of reaction.
const speciesTable &	species () const noexcept
	Access to specie list.
const List< specieCoeffs > &	lhs () const noexcept
	Specie info for the left-hand-side of the reaction.
const List< specieCoeffs > &	rhs () const noexcept
	Specie info for the right-hand-side of the reaction.
void	setLRhs (Istream &, const speciesTable &, List< specieCoeffs > &lhs, List< specieCoeffs > &rhs, bool failUnknownSpecie=true)
	Construct the left- and right-hand-side reaction coefficients.
virtual scalar	kf (const scalar p, const scalar T, const scalarField &c) const
	Forward rate constant.
virtual scalar	kr (const scalar kfwd, const scalar p, const scalar T, const scalarField &c) const
	Reverse rate constant from the given forward rate constant.
virtual scalar	kr (const scalar p, const scalar T, const scalarField &c) const
	Reverse rate constant.

Friends
Ostream &	operator<< (Ostream &os, const solidReaction< ReactionThermo > &r)

Additional Inherited Members
Static Public Member Functions inherited from Reaction< ReactionThermo >
static autoPtr< Reaction< ReactionThermo > >	New (const speciesTable &species, const ReactionTable< ReactionThermo > &thermoDatabase, const dictionary &dict)
	Return a pointer to new patchField created on freestore from dict.
Static Public Attributes inherited from Reaction< ReactionThermo >
static label	nUnNamedReactions = 0
	Number of un-named reactions.
Protected Member Functions inherited from Reaction< ReactionThermo >
void	reactionStrLeft (OStringStream &reaction) const
	Add string representation of the left of the reaction.
void	reactionStrRight (OStringStream &reaction) const
	Add string representation of the right of the reaction.
Static Protected Member Functions inherited from Reaction< ReactionThermo >
static void	reactionStr (OStringStream &reaction, const speciesTable &species, const List< specieCoeffs > &reactCoeffs)
	Add string representation for given species reaction coeffs.

Detailed Description

template<class ReactionThermo>
class Foam::solidReaction< ReactionThermo >

Read solid reactions of the type S1 = S2 + G1.

Source files

Definition at line 57 of file solidReaction.H.

Constructor & Destructor Documentation

◆ solidReaction() [1/3]

template<class ReactionThermo>

solidReaction	(	const Reaction< ReactionThermo > &	reaction,
		const speciesTable &	pyrolisisGases,
		const List< specieCoeffs > &	glhs,
		const List< specieCoeffs > &	grhs )

Construct from components.

Definition at line 28 of file solidReaction.C.

References glhs(), grhs(), Reaction< ReactionThermo >::Reaction(), and reaction.

Referenced by solidReaction< hConstSolidThermoPhysics >::clone(), solidReaction< hConstSolidThermoPhysics >::clone(), operator<<, and solidReaction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ solidReaction() [2/3]

template<class ReactionThermo>

solidReaction	(	const solidReaction< ReactionThermo > &	r,
		const speciesTable &	pyrolisisGases )

Construct as copy given new speciesTable.

Definition at line 44 of file solidReaction.C.

References Reaction< ReactionThermo >::Reaction(), and solidReaction().

Here is the call graph for this function:

◆ solidReaction() [3/3]

template<class ReactionThermo>

solidReaction	(	const speciesTable &	species,
		const ReactionTable< ReactionThermo > &	thermoDatabase,
		const dictionary &	dict )

Construct from dictionary.

Definition at line 58 of file solidReaction.C.

References dict, hashedWordList::push_uniq(), Reaction< ReactionThermo >::Reaction(), ICharStream::rewind(), Reaction< ReactionThermo >::setLRhs(), and Reaction< ReactionThermo >::species().

Here is the call graph for this function:

◆ ~solidReaction()

template<class ReactionThermo>

virtual ~solidReaction ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

template<class ReactionThermo>

TypeName ( "SolidReaction" )

Runtime type information.

◆ clone() [1/2]

template<class ReactionThermo>

virtual autoPtr< Reaction< ReactionThermo > > clone ( ) const

inlinevirtual

Construct and return a clone.

Reimplemented from Reaction< ReactionThermo >.

Reimplemented in IrreversibleReaction< solidReaction, hConstSolidThermoPhysics, solidArrheniusReactionRate >, IrreversibleReaction< solidReaction, hConstSolidThermoPhysics, solidIsothermalReactionRate >, IrreversibleReaction< solidReaction, hExpKappaConstSolidThermoPhysics, solidArrheniusReactionRate >, IrreversibleReaction< solidReaction, hExpKappaConstSolidThermoPhysics, solidIsothermalReactionRate >, IrreversibleReaction< solidReaction, hPowerSolidThermoPhysics, solidArrheniusReactionRate >, and IrreversibleReaction< solidReaction, hPowerSolidThermoPhysics, solidIsothermalReactionRate >.

Definition at line 150 of file solidReaction.H.

◆ clone() [2/2]

template<class ReactionThermo>

virtual autoPtr< Reaction< ReactionThermo > > clone ( const speciesTable & species ) const

inlinevirtual

Construct and return a clone with new speciesTable.

Reimplemented from Reaction< ReactionThermo >.

Reimplemented in IrreversibleReaction< solidReaction, hConstSolidThermoPhysics, solidArrheniusReactionRate >, IrreversibleReaction< solidReaction, hConstSolidThermoPhysics, solidIsothermalReactionRate >, IrreversibleReaction< solidReaction, hExpKappaConstSolidThermoPhysics, solidArrheniusReactionRate >, IrreversibleReaction< solidReaction, hExpKappaConstSolidThermoPhysics, solidIsothermalReactionRate >, IrreversibleReaction< solidReaction, hPowerSolidThermoPhysics, solidArrheniusReactionRate >, and IrreversibleReaction< solidReaction, hPowerSolidThermoPhysics, solidIsothermalReactionRate >.

Definition at line 161 of file solidReaction.H.

◆ grhs()

template<class ReactionThermo>

const Foam::List< typename Foam::Reaction< ReactionThermo >::specieCoeffs > & grhs ( ) const

virtual

Access to gas components of the reaction.

Reimplemented from Reaction< ReactionThermo >.

Definition at line 121 of file solidReaction.C.

Referenced by solidReaction().

Here is the caller graph for this function:

◆ glhs()

template<class ReactionThermo>

const Foam::List< typename Foam::solidReaction< ReactionThermo >::specieCoeffs > & glhs ( ) const

virtual

Reimplemented from Reaction< ReactionThermo >.

Definition at line 113 of file solidReaction.C.

Referenced by solidReaction().

Here is the caller graph for this function:

◆ gasSpecies()

template<class ReactionThermo>

const Foam::speciesTable & gasSpecies ( ) const

virtual

Access to gas specie list.

Reimplemented from Reaction< ReactionThermo >.

Definition at line 128 of file solidReaction.C.

◆ write()

template<class ReactionThermo>

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from Reaction< ReactionThermo >.

Reimplemented in IrreversibleReaction< solidReaction, hConstSolidThermoPhysics, solidArrheniusReactionRate >, IrreversibleReaction< solidReaction, hConstSolidThermoPhysics, solidIsothermalReactionRate >, IrreversibleReaction< solidReaction, hExpKappaConstSolidThermoPhysics, solidArrheniusReactionRate >, IrreversibleReaction< solidReaction, hExpKappaConstSolidThermoPhysics, solidIsothermalReactionRate >, IrreversibleReaction< solidReaction, hPowerSolidThermoPhysics, solidArrheniusReactionRate >, and IrreversibleReaction< solidReaction, hPowerSolidThermoPhysics, solidIsothermalReactionRate >.

Definition at line 136 of file solidReaction.C.

References os(), and reaction.

Here is the call graph for this function:

◆ operator<<

template<class ReactionThermo>

Ostream & operator<<	(	Ostream &	os,
		const solidReaction< ReactionThermo > &	r )

friend

Definition at line 31 of file solidReactionI.H.

References os(), reaction, and solidReaction().

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

src/thermophysicalModels/solidSpecie/reaction/Reactions/solidReaction/solidReaction.H
src/thermophysicalModels/solidSpecie/reaction/Reactions/solidReaction/solidReaction.C

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ solidReaction() [1/3]

◆ solidReaction() [2/3]

◆ solidReaction() [3/3]

◆ ~solidReaction()

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ grhs()

◆ glhs()

◆ gasSpecies()

◆ write()

Friends And Related Symbol Documentation

◆ operator<<