Proxy version of Reaction which provides dummy implementations of the abstract virtual functions. More...

Inheritance diagram for ReactionProxy< ReactionThermo >:

Collaboration diagram for ReactionProxy< ReactionThermo >:

Public Member Functions
	ReactionProxy (const speciesTable &species, const List< specieCoeffs > &lhs, const List< specieCoeffs > &rhs, const HashPtrTable< ReactionThermo > &thermoDatabase)
	Construct from components. More...

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

	ReactionProxy (const speciesTable &species, const HashPtrTable< ReactionThermo > &thermoDatabase, const dictionary &dict)
	Construct from dictionary. More...

virtual autoPtr< Reaction< ReactionThermo > >	clone () const
	Construct and return a clone. More...

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

virtual	~ReactionProxy ()
	Destructor. More...

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

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

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

virtual scalar	kr (const scalar kfwd, const scalar p, const scalar T, const scalarField &c, const label li) const
	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
	Reverse rate constant. More...

virtual scalar	dkfdT (const scalar p, const scalar T, const scalarField &c, const label li) const
	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
	Temperature derivative of reverse rate. More...

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

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

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

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

	declareRunTimeSelectionTable (autoPtr, Reaction, dictionary,(const speciesTable &species, const HashPtrTable< ReactionThermo > &thermoDatabase, const dictionary &dict),(species, thermoDatabase, dict))

	declareRunTimeSelectionTable (autoPtr, Reaction, objectRegistry,(const speciesTable &species, const HashPtrTable< ReactionThermo > &thermoDatabase, const objectRegistry &ob, const dictionary &dict),(species, thermoDatabase, ob, dict))

	Reaction (const speciesTable &species, const List< specieCoeffs > &lhs, const List< specieCoeffs > &rhs, const HashPtrTable< ReactionThermo > &thermoDatabase)
	Construct from components. More...

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

	Reaction (const speciesTable &species, const HashPtrTable< ReactionThermo > &thermoDatabase, const dictionary &dict)
	Construct from dictionary. 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...

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

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< ReactionThermo > &)=delete
	Disallow default bitwise assignment. 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...

Additional Inherited Members
Static Public Member Functions inherited from Reaction< ReactionThermo >
static autoPtr< Reaction< ReactionThermo > >	New (const speciesTable &species, const HashPtrTable< ReactionThermo > &thermoDatabase, const dictionary &dict)
	Return a pointer to new patchField created on freestore. More...

static autoPtr< Reaction< ReactionThermo > >	New (const speciesTable &species, const HashPtrTable< ReactionThermo > &thermoDatabase, const objectRegistry &ob, const dictionary &dict)
	Return a pointer to new patchField created on freestore. More...

static autoPtr< Reaction< ReactionThermo > >	New (const speciesTable &species, const PtrList< ReactionThermo > &speciesThermo, const dictionary &dict)
	Return a pointer to new patchField created on freestore from dict. More...

Static Public Attributes inherited from Reaction< ReactionThermo >
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...

Detailed Description

template<class ReactionThermo>
class Foam::ReactionProxy< ReactionThermo >

Proxy version of Reaction which provides dummy implementations of the abstract virtual functions.

Used for read-construction and format conversion.

Source files

Definition at line 52 of file ReactionProxy.H.

Constructor & Destructor Documentation

◆ ReactionProxy() [1/3]

ReactionProxy	(	const speciesTable &	species,
		const List< specieCoeffs > &	lhs,
		const List< specieCoeffs > &	rhs,
		const HashPtrTable< ReactionThermo > &	thermoDatabase
	)

Construct from components.

Definition at line 32 of file ReactionProxy.C.

Referenced by ReactionProxy< ReactionThermo >::ReactionProxy().

Here is the caller graph for this function:

◆ ReactionProxy() [2/3]

ReactionProxy	(	const Reaction< ReactionThermo > &	r,
		const speciesTable &	species
	)

Construct as copy given new speciesTable.

Definition at line 51 of file ReactionProxy.C.

References ReactionProxy< ReactionThermo >::ReactionProxy().

Here is the call graph for this function:

◆ ReactionProxy() [3/3]

ReactionProxy	(	const speciesTable &	species,
		const HashPtrTable< ReactionThermo > &	thermoDatabase,
		const dictionary &	dict
	)

Construct from dictionary.

Definition at line 66 of file ReactionProxy.C.

◆ ~ReactionProxy()

virtual ~ReactionProxy ( )

inlinevirtual

Destructor.

Definition at line 96 of file ReactionProxy.H.

References Foam::constant::universal::c, ReactionProxy< ReactionThermo >::dkfdc(), ReactionProxy< ReactionThermo >::dkfdT(), ReactionProxy< ReactionThermo >::dkrdc(), ReactionProxy< ReactionThermo >::dkrdT(), ReactionProxy< ReactionThermo >::hasDkdc(), ReactionProxy< ReactionThermo >::kf(), ReactionProxy< ReactionThermo >::kr(), p, ReactionProxy< ReactionThermo >::postEvaluate(), ReactionProxy< ReactionThermo >::preEvaluate(), and Foam::T().

Here is the call graph for this function:

Member Function Documentation

◆ clone() [1/2]

Foam::autoPtr< Foam::Reaction< ReactionThermo > > clone ( ) const

virtual

Construct and return a clone.

Implements Reaction< ReactionThermo >.

Definition at line 83 of file ReactionProxy.C.

References NotImplemented.

◆ clone() [2/2]

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

virtual

Construct and return a clone with new speciesTable.

Implements Reaction< ReactionThermo >.

Definition at line 93 of file ReactionProxy.C.

References NotImplemented.

◆ preEvaluate()

void preEvaluate ( ) const

virtual

Pre-evaluation hook.

Implements Reaction< ReactionThermo >.

Definition at line 105 of file ReactionProxy.C.

Referenced by ReactionProxy< ReactionThermo >::~ReactionProxy().

Here is the caller graph for this function:

◆ postEvaluate()

void postEvaluate ( ) const

virtual

Post-evaluation hook.

Implements Reaction< ReactionThermo >.

Definition at line 110 of file ReactionProxy.C.

References ReactionProxy< ReactionThermo >::kf().

Referenced by ReactionProxy< ReactionThermo >::~ReactionProxy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ kf()

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

virtual

Forward rate constant.

Implements Reaction< ReactionThermo >.

Definition at line 116 of file ReactionProxy.C.

References ReactionProxy< ReactionThermo >::kr(), and NotImplemented.

Referenced by ReactionProxy< ReactionThermo >::postEvaluate(), and ReactionProxy< ReactionThermo >::~ReactionProxy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ kr() [1/2]

Foam::scalar kr	(	const scalar	kfwd,
		const scalar	p,
		const scalar	T,
		const scalarField &	c,
		const label	li
	)		const

virtual

Reverse rate constant from the given forward rate constant.

Implements Reaction< ReactionThermo >.

Definition at line 130 of file ReactionProxy.C.

References NotImplemented.

Referenced by ReactionProxy< ReactionThermo >::kf(), and ReactionProxy< ReactionThermo >::~ReactionProxy().

Here is the caller graph for this function:

◆ kr() [2/2]

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

virtual

Reverse rate constant.

Implements Reaction< ReactionThermo >.

Definition at line 145 of file ReactionProxy.C.

References ReactionProxy< ReactionThermo >::dkfdT(), and NotImplemented.

Here is the call graph for this function:

◆ dkfdT()

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

virtual

Temperature derivative of forward rate.

Implements Reaction< ReactionThermo >.

Definition at line 159 of file ReactionProxy.C.

References ReactionProxy< ReactionThermo >::dkrdT(), and NotImplemented.

Referenced by ReactionProxy< ReactionThermo >::kr(), and ReactionProxy< ReactionThermo >::~ReactionProxy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dkrdT()

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

virtual

Temperature derivative of reverse rate.

Implements Reaction< ReactionThermo >.

Definition at line 173 of file ReactionProxy.C.

References NotImplemented.

Referenced by ReactionProxy< ReactionThermo >::dkfdT(), and ReactionProxy< ReactionThermo >::~ReactionProxy().

Here is the caller graph for this function:

◆ hasDkdc()

bool hasDkdc ( ) const

virtual

Does this reaction have concentration-dependent rate constants?

Implements Reaction< ReactionThermo >.

Definition at line 188 of file ReactionProxy.C.

References ReactionProxy< ReactionThermo >::dkfdc(), and NotImplemented.

Referenced by ReactionProxy< ReactionThermo >::~ReactionProxy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dkfdc()

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

virtual

Concentration derivative of forward rate.

Implements Reaction< ReactionThermo >.

Definition at line 197 of file ReactionProxy.C.

References ReactionProxy< ReactionThermo >::dkrdc(), and NotImplemented.

Referenced by ReactionProxy< ReactionThermo >::hasDkdc(), and ReactionProxy< ReactionThermo >::~ReactionProxy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dkrdc()

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

virtual

Concentration derivative of reverse rate.

Implements Reaction< ReactionThermo >.

Definition at line 211 of file ReactionProxy.C.

References NotImplemented.

Referenced by ReactionProxy< ReactionThermo >::dkfdc(), and ReactionProxy< ReactionThermo >::~ReactionProxy().

Here is the caller graph for this function:

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

src/thermophysicalModels/specie/reaction/Reactions/ReactionProxy/ReactionProxy.H
src/thermophysicalModels/specie/reaction/Reactions/ReactionProxy/ReactionProxy.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class ReactionThermo> class Foam::ReactionProxy< ReactionThermo >

Constructor & Destructor Documentation

◆ ReactionProxy() [1/3]

◆ ReactionProxy() [2/3]

◆ ReactionProxy() [3/3]

◆ ~ReactionProxy()

Member Function Documentation

◆ clone() [1/2]

◆ clone() [2/2]

◆ preEvaluate()

◆ postEvaluate()

◆ kf()

◆ kr() [1/2]

◆ kr() [2/2]

◆ dkfdT()

◆ dkrdT()

◆ hasDkdc()

◆ dkfdc()

◆ dkrdc()

template<class ReactionThermo>
class Foam::ReactionProxy< ReactionThermo >