Simple extension of ThermoType to handle reaction kinetics in addition to the equilibrium thermodynamics already handled. More...

Inheritance diagram for Reaction< ThermoType >:

[legend]

Collaboration diagram for Reaction< ThermoType >:

[legend]

Public Member Functions
	TypeName ("Reaction")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, Reaction, dictionary,(const speciesTable &species, const PtrList< ThermoType > &speciesThermo, const dictionary &dict),(species, speciesThermo, dict))

	declareRunTimeSelectionTable (autoPtr, Reaction, objectRegistry,(const speciesTable &species, const PtrList< ThermoType > &speciesThermo, const objectRegistry &ob, const dictionary &dict),(species, speciesThermo, ob, dict))

	Reaction (const speciesTable &species, const PtrList< ThermoType > &speciesThermo, const List< specieCoeffs > &lhs, const List< specieCoeffs > &rhs)
	Construct from components. More...

	Reaction (const Reaction< ThermoType > &, const speciesTable &species)
	Construct as copy given new speciesTable. More...

	Reaction (const speciesTable &species, const PtrList< ThermoType > &speciesThermo, const dictionary &dict)
	Construct from dictionary. More...

virtual autoPtr< Reaction< ThermoType > >	clone () const =0
	Construct and return a clone. More...

virtual autoPtr< Reaction< ThermoType > >	clone (const speciesTable &species) const =0
	Construct and return a clone with new speciesTable. More...

virtual	~Reaction ()
	Destructor. More...

scalar	Tlow () const
	Return the lower temperature limit for the reaction. More...

scalar	Thigh () const
	Return the upper temperature limit for the reaction. More...

virtual void	preEvaluate () const =0
	Pre-evaluation hook. More...

virtual void	postEvaluate () const =0
	Post-evaluation hook. More...

dimensionSet	kfDims () const
	Dimensions of the forward rate. More...

dimensionSet	krDims () const
	Dimensions of the reverse rate. More...

void	C (const scalar p, const scalar T, const scalarField &c, const label li, scalar &Cf, scalar &Cr) const
	Concentration powers. More...

scalar	omega (const scalar p, const scalar T, const scalarField &c, const label li, scalar &omegaf, scalar &omegar) const
	Net reaction rate. More...

void	dNdtByV (const scalar p, const scalar T, const scalarField &c, const label li, scalarField &dNdtByV, const bool reduced, const List< label > &c2s, const label Nsi0) const
	The net reaction rate for each species involved. More...

virtual scalar	kf (const scalar p, const scalar T, const scalarField &c, const label li) const =0
	Forward rate constant. More...

virtual scalar	kr (const scalar kf, const scalar p, const scalar T, const scalarField &c, const label li) const =0
	Reverse rate constant from the given forward rate constant. More...

virtual scalar	kr (const scalar p, const scalar T, const scalarField &c, const label li) const =0
	Reverse rate constant. More...

virtual scalar	dkfdT (const scalar p, const scalar T, const scalarField &c, const label li) const =0
	Temperature derivative of forward rate. More...

virtual scalar	dkrdT (const scalar p, const scalar T, const scalarField &c, const label li, const scalar dkfdT, const scalar kr) const =0
	Temperature derivative of reverse rate. More...

virtual bool	hasDkdc () const =0
	Does this reaction have concentration-dependent rate constants? More...

virtual void	dkfdc (const scalar p, const scalar T, const scalarField &c, const label li, scalarField &dkfdc) const =0
	Concentration derivative of forward rate. More...

virtual void	dkrdc (const scalar p, const scalar T, const scalarField &c, const label li, const scalarField &dkfdc, const scalar kr, scalarField &dkrdc) const =0
	Concentration derivative of reverse rate. More...

void	ddNdtByVdcTp (const scalar p, const scalar T, const scalarField &c, const label li, scalarField &dNdtByV, scalarSquareMatrix &ddNdtByVdcTp, const bool reduced, const List< label > &c2s, const label csi0, const label Tsi, scalarField &cTpWork0, scalarField &cTpWork1) const
	Derivative of the net reaction rate for each species involved. More...

virtual void	write (Ostream &) const
	Write. More...

void	operator= (const Reaction< ThermoType > &)=delete
	Disallow default bitwise assignment. More...

const word &	name () const
	Return the name of the reaction. More...

Public Member Functions inherited from reaction
	reaction (const speciesTable &species, const List< specieCoeffs > &lhs, const List< specieCoeffs > &rhs)
	Construct from components. More...

	reaction (const reaction &, const speciesTable &species)
	Construct as copy given new speciesTable. More...

	reaction (const speciesTable &species, const dictionary &dict)
	Construct from dictionary. More...

	~reaction ()
	Destructor. More...

const word &	name () const
	Return the name of the reaction. More...

const List< specieCoeffs > &	lhs () const
	Return the components of the left hand side. More...

const List< specieCoeffs > &	rhs () const
	Return the components of the right hand side. More...

const speciesTable &	species () const
	Return the specie list. More...

void	write (Ostream &) const
	Write. More...

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

Static Public Member Functions
static autoPtr< Reaction< ThermoType > >	New (const speciesTable &species, const PtrList< ThermoType > &speciesThermo, const dictionary &dict)
	Return a pointer to new reaction created from a dictionary. More...

static autoPtr< Reaction< ThermoType > >	New (const speciesTable &species, const PtrList< ThermoType > &speciesThermo, const objectRegistry &ob, const dictionary &dict)
	Return a pointer to new reaction created from an objectRegistry and. More...

Static Public Attributes
static scalar	TlowDefault
	Default temperature limits of applicability of reaction rates. More...

static scalar	ThighDefault

Static Public Attributes inherited from reaction
static label	nUnNamedReactions
	Number of un-named reactions. More...

Friends
Ostream &	operator (Ostream &, const Reaction< ThermoType > &)

Detailed Description

template<class ThermoType>
class Foam::Reaction< ThermoType >

Simple extension of ThermoType to handle reaction kinetics in addition to the equilibrium thermodynamics already handled.

Source files

Definition at line 68 of file Reaction.H.

Constructor & Destructor Documentation

◆ Reaction() [1/3]

Reaction	(	const speciesTable &	species,
		const PtrList< ThermoType > &	speciesThermo,
		const List< specieCoeffs > &	lhs,
		const List< specieCoeffs > &	rhs
	)

Construct from components.

Definition at line 93 of file Reaction.C.

◆ Reaction() [2/3]

Reaction	(	const Reaction< ThermoType > &	r,
		const speciesTable &	species
	)

Construct as copy given new speciesTable.

Definition at line 111 of file Reaction.C.

◆ Reaction() [3/3]

Reaction	(	const speciesTable &	species,
		const PtrList< ThermoType > &	speciesThermo,
		const dictionary &	dict
	)

Construct from dictionary.

Definition at line 125 of file Reaction.C.

◆ ~Reaction()

virtual ~Reaction ( )

inlinevirtual

Destructor.

Definition at line 190 of file Reaction.H.

Member Function Documentation

◆ TypeName()

TypeName ( "Reaction< ThermoType >" )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable	(	autoPtr	,
		Reaction< ThermoType >	,
		dictionary	,
		(const speciesTable &species, const PtrList< ThermoType > &speciesThermo, const dictionary &dict)	,
		(species, speciesThermo, dict)
	)

◆ declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable	(	autoPtr	,
		Reaction< ThermoType >	,
		objectRegistry	,
		(const speciesTable &species, const PtrList< ThermoType > &speciesThermo, const objectRegistry &ob, const dictionary &dict)	,
		(species, speciesThermo, ob, dict)
	)

◆ clone() [1/2]

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

pure virtual

Construct and return a clone.

Implemented in ReversibleReaction< ThermoType, ReactionRate >, NonEquilibriumReversibleReaction< ThermoType, ReactionRate >, IrreversibleReaction< ThermoType, ReactionRate >, and ReactionProxy< ThermoType >.

◆ clone() [2/2]

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

pure virtual

Construct and return a clone with new speciesTable.

Implemented in ReversibleReaction< ThermoType, ReactionRate >, NonEquilibriumReversibleReaction< ThermoType, ReactionRate >, IrreversibleReaction< ThermoType, ReactionRate >, and ReactionProxy< ThermoType >.

◆ New() [1/2]

Foam::autoPtr< Foam::Reaction< ThermoType > > New	(	const speciesTable &	species,
		const PtrList< ThermoType > &	speciesThermo,
		const dictionary &	dict
	)

static

Return a pointer to new reaction created from a dictionary.

Definition at line 145 of file Reaction.C.

References dict, Foam::exit(), Foam::FatalError, FatalErrorInFunction, dictionary::lookup(), Foam::nl, and string::removeTrailing().

Here is the call graph for this function:

◆ New() [2/2]

Foam::autoPtr< Foam::Reaction< ThermoType > > New	(	const speciesTable &	species,
		const PtrList< ThermoType > &	speciesThermo,
		const objectRegistry &	ob,
		const dictionary &	dict
	)

static

Return a pointer to new reaction created from an objectRegistry and.

a dictionary

Definition at line 189 of file Reaction.C.

References dict, Foam::exit(), Foam::FatalError, FatalErrorInFunction, dictionary::lookup(), Foam::New(), Foam::nl, and string::removeTrailing().

Here is the call graph for this function:

◆ Tlow()

Foam::scalar Tlow

inline

Return the lower temperature limit for the reaction.

Definition at line 31 of file ReactionI.H.

◆ Thigh()

Foam::scalar Thigh

inline

Return the upper temperature limit for the reaction.

Definition at line 38 of file ReactionI.H.

◆ preEvaluate()

virtual void preEvaluate ( ) const

pure virtual

Pre-evaluation hook.

Implemented in ReversibleReaction< ThermoType, ReactionRate >, NonEquilibriumReversibleReaction< ThermoType, ReactionRate >, IrreversibleReaction< ThermoType, ReactionRate >, and ReactionProxy< ThermoType >.

◆ postEvaluate()

virtual void postEvaluate ( ) const

pure virtual

Post-evaluation hook.

Implemented in ReversibleReaction< ThermoType, ReactionRate >, NonEquilibriumReversibleReaction< ThermoType, ReactionRate >, IrreversibleReaction< ThermoType, ReactionRate >, and ReactionProxy< ThermoType >.

◆ kfDims()

Foam::dimensionSet kfDims

Dimensions of the forward rate.

Definition at line 259 of file Reaction.C.

References Foam::dimMoles, Foam::dimTime, Foam::dimVolume, forAll, Foam::order(), and Foam::pow().

Here is the call graph for this function:

◆ krDims()

Foam::dimensionSet krDims

Dimensions of the reverse rate.

Definition at line 271 of file Reaction.C.

References Foam::dimMoles, Foam::dimTime, Foam::dimVolume, forAll, Foam::order(), and Foam::pow().

Here is the call graph for this function:

◆ C()

void C	(	const scalar	p,
		const scalar	T,
		const scalarField &	c,
		const label	li,
		scalar &	Cf,
		scalar &	Cr
	)		const

Concentration powers.

Definition at line 283 of file Reaction.C.

References Foam::constant::universal::c, forAll, Foam::max(), and Foam::pow().

Here is the call graph for this function:

◆ omega()

Foam::scalar omega	(	const scalar	p,
		const scalar	T,
		const scalarField &	c,
		const label	li,
		scalar &	omegaf,
		scalar &	omegar
	)		const

Net reaction rate.

Definition at line 312 of file Reaction.C.

References Foam::constant::universal::c, C, Foam::max(), Foam::min(), p, and Foam::T().

Here is the call graph for this function:

◆ dNdtByV()

void dNdtByV	(	const scalar	p,
		const scalar	T,
		const scalarField &	c,
		const label	li,
		scalarField &	dNdtByV,
		const bool	reduced,
		const List< label > &	c2s,
		const label	Nsi0
	)		const

The net reaction rate for each species involved.

Definition at line 340 of file Reaction.C.

References Foam::constant::universal::c, forAll, omega, and Foam::T().

Here is the call graph for this function:

◆ kf()

virtual scalar kf	(	const scalar	p,
		const scalar	T,
		const scalarField &	c,
		const label	li
	)		const

pure virtual

Forward rate constant.

Implemented in ReversibleReaction< ThermoType, ReactionRate >, NonEquilibriumReversibleReaction< ThermoType, ReactionRate >, IrreversibleReaction< ThermoType, ReactionRate >, and ReactionProxy< ThermoType >.

◆ kr() [1/2]

virtual scalar kr	(	const scalar	kf,
		const scalar	p,
		const scalar	T,
		const scalarField &	c,
		const label	li
	)		const

pure virtual

Reverse rate constant from the given forward rate constant.

Implemented in ReversibleReaction< ThermoType, ReactionRate >, NonEquilibriumReversibleReaction< ThermoType, ReactionRate >, IrreversibleReaction< ThermoType, ReactionRate >, and ReactionProxy< ThermoType >.

◆ kr() [2/2]

virtual scalar kr	(	const scalar	p,
		const scalar	T,
		const scalarField &	c,
		const label	li
	)		const

pure virtual

Reverse rate constant.

Implemented in ReversibleReaction< ThermoType, ReactionRate >, NonEquilibriumReversibleReaction< ThermoType, ReactionRate >, IrreversibleReaction< ThermoType, ReactionRate >, and ReactionProxy< ThermoType >.

◆ dkfdT()

virtual scalar dkfdT	(	const scalar	p,
		const scalar	T,
		const scalarField &	c,
		const label	li
	)		const

pure virtual

Temperature derivative of forward rate.

Implemented in ReversibleReaction< ThermoType, ReactionRate >, NonEquilibriumReversibleReaction< ThermoType, ReactionRate >, IrreversibleReaction< ThermoType, ReactionRate >, and ReactionProxy< ThermoType >.

◆ dkrdT()

virtual scalar dkrdT	(	const scalar	p,
		const scalar	T,
		const scalarField &	c,
		const label	li,
		const scalar	dkfdT,
		const scalar	kr
	)		const

pure virtual

Temperature derivative of reverse rate.

Implemented in ReversibleReaction< ThermoType, ReactionRate >, NonEquilibriumReversibleReaction< ThermoType, ReactionRate >, IrreversibleReaction< ThermoType, ReactionRate >, and ReactionProxy< ThermoType >.

◆ hasDkdc()

virtual bool hasDkdc ( ) const

pure virtual

Does this reaction have concentration-dependent rate constants?

Implemented in ReversibleReaction< ThermoType, ReactionRate >, NonEquilibriumReversibleReaction< ThermoType, ReactionRate >, IrreversibleReaction< ThermoType, ReactionRate >, and ReactionProxy< ThermoType >.

◆ dkfdc()

virtual void dkfdc	(	const scalar	p,
		const scalar	T,
		const scalarField &	c,
		const label	li,
		scalarField &	dkfdc
	)		const

pure virtual

Concentration derivative of forward rate.

Implemented in ReversibleReaction< ThermoType, ReactionRate >, NonEquilibriumReversibleReaction< ThermoType, ReactionRate >, IrreversibleReaction< ThermoType, ReactionRate >, and ReactionProxy< ThermoType >.

◆ dkrdc()

virtual void dkrdc	(	const scalar	p,
		const scalar	T,
		const scalarField &	c,
		const label	li,
		const scalarField &	dkfdc,
		const scalar	kr,
		scalarField &	dkrdc
	)		const

pure virtual

Concentration derivative of reverse rate.

Implemented in ReversibleReaction< ThermoType, ReactionRate >, NonEquilibriumReversibleReaction< ThermoType, ReactionRate >, IrreversibleReaction< ThermoType, ReactionRate >, and ReactionProxy< ThermoType >.

◆ ddNdtByVdcTp()

void ddNdtByVdcTp	(	const scalar	p,
		const scalar	T,
		const scalarField &	c,
		const label	li,
		scalarField &	dNdtByV,
		scalarSquareMatrix &	ddNdtByVdcTp,
		const bool	reduced,
		const List< label > &	c2s,
		const label	csi0,
		const label	Tsi,
		scalarField &	cTpWork0,
		scalarField &	cTpWork1
	)		const

Derivative of the net reaction rate for each species involved.

w.r.t. the concentration and temperature

Definition at line 371 of file Reaction.C.

References Foam::constant::universal::c, C, forAll, Foam::max(), omega, p, Foam::pow(), and Foam::T().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented in ReversibleReaction< ThermoType, ReactionRate >, NonEquilibriumReversibleReaction< ThermoType, ReactionRate >, and IrreversibleReaction< ThermoType, ReactionRate >.

Definition at line 550 of file Reaction.C.

References reaction::write().

Referenced by IrreversibleReaction< ThermoType, ReactionRate >::write(), NonEquilibriumReversibleReaction< ThermoType, ReactionRate >::write(), ReversibleReaction< ThermoType, ReactionRate >::write(), and ReactionList< ThermoType >::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const Reaction< ThermoType > & )

delete

Disallow default bitwise assignment.

◆ name()

const Foam::word & name

inline

Return the name of the reaction.

Definition at line 123 of file reactionI.H.

Referenced by ReactionList< ThermoType >::write().

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator

Ostream& operator	(	Ostream &	,
		const Reaction< ThermoType > &
	)

friend

Member Data Documentation

◆ TlowDefault

Foam::scalar TlowDefault

static

Default temperature limits of applicability of reaction rates.

Definition at line 79 of file Reaction.H.

◆ ThighDefault

Foam::scalar ThighDefault

static

Definition at line 79 of file Reaction.H.

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

src/thermophysicalModels/specie/reaction/Reactions/Reaction/Reaction.H
src/thermophysicalModels/specie/reaction/Reactions/Reaction/Reaction.C
src/thermophysicalModels/specie/reaction/Reactions/Reaction/ReactionI.H

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

template<class ThermoType> class Foam::Reaction< ThermoType >

Constructor & Destructor Documentation

◆ Reaction() [1/3]

◆ Reaction() [2/3]

◆ Reaction() [3/3]

◆ ~Reaction()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable() [1/2]

◆ declareRunTimeSelectionTable() [2/2]

◆ clone() [1/2]

◆ clone() [2/2]

◆ New() [1/2]

◆ New() [2/2]

◆ Tlow()

◆ Thigh()

◆ preEvaluate()

◆ postEvaluate()

◆ kfDims()

◆ krDims()

◆ C()

◆ omega()

◆ dNdtByV()

◆ kf()

◆ kr() [1/2]

◆ kr() [2/2]

◆ dkfdT()

◆ dkrdT()

◆ hasDkdc()

◆ dkfdc()

◆ dkrdc()

◆ ddNdtByVdcTp()

◆ write()

◆ operator=()

◆ name()

Friends And Related Function Documentation

◆ operator

Member Data Documentation

◆ TlowDefault

◆ ThighDefault

template<class ThermoType>
class Foam::Reaction< ThermoType >