An abstract class for methods of chemical mechanism reduction. More...

Inheritance diagram for chemistryReductionMethod< ThermoType >:

[legend]

Collaboration diagram for chemistryReductionMethod< ThermoType >:

[legend]

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

	declareRunTimeSelectionTable (autoPtr, chemistryReductionMethod, dictionary,(const IOdictionary &dict, chemistryModel< ThermoType > &chemistry),(dict, chemistry))

	chemistryReductionMethod (chemistryModel< ThermoType > &chemistry)
	Construct from components. More...

	chemistryReductionMethod (const IOdictionary &dict, chemistryModel< ThermoType > &chemistry)
	Construct from components. More...

virtual	~chemistryReductionMethod ()
	Destructor. More...

virtual bool	active () const
	Return mechanism reduction active. More...

label	nSpecie ()
	Return the number of species. More...

label	nActiveSpecies () const
	Return the number of active species. More...

scalar	tolerance () const
	Return the tolerance. More...

const List< bool > &	activeSpecies () const
	Return the active species. More...

bool	reactionDisabled (const label i) const
	Return whether or not a reaction is disabled. More...

virtual void	reduceMechanism (const scalar p, const scalar T, const scalarField &c, List< label > &ctos, DynamicList< label > &stoc, const label li)=0
	Reduce the mechanism. More...

virtual void	update ()
	... More...

Static Public Member Functions
static autoPtr< chemistryReductionMethod< ThermoType > >	New (const IOdictionary &dict, chemistryModel< ThermoType > &chemistry)

Protected Member Functions
void	initReduceMechanism ()
	Protected Member Functions. More...

void	endReduceMechanism (List< label > &ctos, DynamicList< label > &stoc)
	End reduction of the mechanism. More...

Protected Attributes
const dictionary	coeffsDict_
	Dictionary that store the algorithm data. More...

chemistryModel< ThermoType > &	chemistry_
	Reference to the chemistry model. More...

const label	nSpecie_
	Total number of species. More...

label	nActiveSpecies_
	Number of active species. More...

Field< bool >	reactionsDisabled_
	List of disabled reactions (disabled = true) More...

List< bool >	activeSpecies_
	List of active species (active = true) More...

Detailed Description

template<class ThermoType>
class Foam::chemistryReductionMethod< ThermoType >

An abstract class for methods of chemical mechanism reduction.

Source files

Definition at line 59 of file chemistryReductionMethod.H.

Constructor & Destructor Documentation

◆ chemistryReductionMethod() [1/2]

chemistryReductionMethod ( Foam::chemistryModel< ThermoType > & chemistry )

Construct from components.

Definition at line 33 of file chemistryReductionMethod.C.

◆ chemistryReductionMethod() [2/2]

chemistryReductionMethod	(	const IOdictionary &	dict,
		Foam::chemistryModel< ThermoType > &	chemistry
	)

Construct from components.

Definition at line 53 of file chemistryReductionMethod.C.

References odeChemistryModel::logFile().

Here is the call graph for this function:

◆ ~chemistryReductionMethod()

~chemistryReductionMethod ( )

virtual

Destructor.

Definition at line 81 of file chemistryReductionMethod.C.

Member Function Documentation

◆ initReduceMechanism()

void initReduceMechanism ( )

protected

Protected Member Functions.

Initialise reduction of the mechanism

Definition at line 88 of file chemistryReductionMethod.C.

References chemistryReductionMethod< ThermoType >::endReduceMechanism().

Here is the call graph for this function:

◆ endReduceMechanism()

void endReduceMechanism	(	List< label > &	ctos,
		DynamicList< label > &	stoc
	)

protected

End reduction of the mechanism.

Definition at line 99 of file chemistryReductionMethod.C.

References Foam::count(), forAll, reaction::lhs(), nSpecie, R, reaction::rhs(), s(), and DynamicList< T, SizeInc, SizeMult, SizeDiv >::setSize().

Referenced by chemistryReductionMethod< ThermoType >::initReduceMechanism().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "chemistryReductionMethod< ThermoType >" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		chemistryReductionMethod< ThermoType >	,
		dictionary	,
		(const IOdictionary &dict, chemistryModel< ThermoType > &chemistry)	,
		(dict, chemistry)
	)

◆ New()

Foam::autoPtr< Foam::chemistryReductionMethod< ThermoType > > New	(	const IOdictionary &	dict,
		chemistryModel< ThermoType > &	chemistry
	)

static

Definition at line 35 of file chemistryReductionMethodNew.C.

References List< T >::append(), chemistry, dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, dictionary::found(), Foam::Info, and dictionary::subDict().

Here is the call graph for this function:

◆ active()

virtual bool active ( ) const

inlinevirtual

Return mechanism reduction active.

Reimplemented in none< ThermoType >.

Definition at line 174 of file chemistryReductionMethod.H.

References chemistryReductionMethod< ThermoType >::activeSpecies(), Foam::constant::universal::c, chemistryReductionMethod< ThermoType >::nActiveSpecies(), chemistryReductionMethod< ThermoType >::nSpecie(), p, chemistryReductionMethod< ThermoType >::reactionDisabled(), chemistryReductionMethod< ThermoType >::reduceMechanism(), Foam::T(), chemistryReductionMethod< ThermoType >::tolerance(), and chemistryReductionMethod< ThermoType >::update().

Here is the call graph for this function:

◆ nSpecie()

Foam::label nSpecie ( )

inline

Return the number of species.

Definition at line 31 of file chemistryReductionMethodI.H.

Referenced by chemistryReductionMethod< ThermoType >::active().

Here is the caller graph for this function:

◆ nActiveSpecies()

Foam::label nActiveSpecies ( ) const

inline

Return the number of active species.

Definition at line 39 of file chemistryReductionMethodI.H.

Referenced by chemistryReductionMethod< ThermoType >::active().

Here is the caller graph for this function:

◆ tolerance()

Foam::scalar tolerance ( ) const

inline

Return the tolerance.

Definition at line 55 of file chemistryReductionMethodI.H.

References chemistryReductionMethod< ThermoType >::reactionDisabled().

Referenced by chemistryReductionMethod< ThermoType >::active().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ activeSpecies()

const Foam::List< bool > & activeSpecies ( ) const

inline

Return the active species.

Definition at line 47 of file chemistryReductionMethodI.H.

Referenced by chemistryReductionMethod< ThermoType >::active().

Here is the caller graph for this function:

◆ reactionDisabled()

bool reactionDisabled ( const label i ) const

inline

Return whether or not a reaction is disabled.

Definition at line 63 of file chemistryReductionMethodI.H.

Referenced by chemistryReductionMethod< ThermoType >::active(), and chemistryReductionMethod< ThermoType >::tolerance().

Here is the caller graph for this function:

◆ reduceMechanism()

virtual void reduceMechanism	(	const scalar	p,
		const scalar	T,
		const scalarField &	c,
		List< label > &	ctos,
		DynamicList< label > &	stoc,
		const label	li
	)

pure virtual

Reduce the mechanism.

Implemented in DRGEP< ThermoType >, DAC< ThermoType >, none< ThermoType >, PFA< ThermoType >, DRG< ThermoType >, and EFA< ThermoType >.

Referenced by chemistryReductionMethod< ThermoType >::active().

Here is the caller graph for this function:

◆ update()

void update ( )

virtual

...

Reimplemented in none< ThermoType >.

Definition at line 169 of file chemistryReductionMethod.C.

References Foam::endl().

Referenced by chemistryReductionMethod< ThermoType >::active().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ coeffsDict_

const dictionary coeffsDict_

protected

Dictionary that store the algorithm data.

Definition at line 66 of file chemistryReductionMethod.H.

◆ chemistry_

chemistryModel<ThermoType>& chemistry_

protected

Reference to the chemistry model.

Definition at line 69 of file chemistryReductionMethod.H.

◆ nSpecie_

const label nSpecie_

protected

Total number of species.

Definition at line 72 of file chemistryReductionMethod.H.

◆ nActiveSpecies_

label nActiveSpecies_

protected

Number of active species.

Definition at line 75 of file chemistryReductionMethod.H.

◆ reactionsDisabled_

Field<bool> reactionsDisabled_

protected

List of disabled reactions (disabled = true)

Definition at line 78 of file chemistryReductionMethod.H.

◆ activeSpecies_

List<bool> activeSpecies_

protected

List of active species (active = true)

Definition at line 81 of file chemistryReductionMethod.H.

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

src/thermophysicalModels/chemistryModel/chemistryModel/reduction/chemistryReductionMethod/chemistryReductionMethod.H
src/thermophysicalModels/chemistryModel/chemistryModel/reduction/chemistryReductionMethod/chemistryReductionMethod.C
src/thermophysicalModels/chemistryModel/chemistryModel/reduction/chemistryReductionMethod/chemistryReductionMethodI.H
src/thermophysicalModels/chemistryModel/chemistryModel/reduction/chemistryReductionMethod/chemistryReductionMethodNew.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<class ThermoType> class Foam::chemistryReductionMethod< ThermoType >

Constructor & Destructor Documentation

◆ chemistryReductionMethod() [1/2]

◆ chemistryReductionMethod() [2/2]

◆ ~chemistryReductionMethod()

Member Function Documentation

◆ initReduceMechanism()

◆ endReduceMechanism()

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ active()

◆ nSpecie()

◆ nActiveSpecies()

◆ tolerance()

◆ activeSpecies()

◆ reactionDisabled()

◆ reduceMechanism()

◆ update()

Member Data Documentation

◆ coeffsDict_

◆ chemistry_

◆ nSpecie_

◆ nActiveSpecies_

◆ reactionsDisabled_

◆ activeSpecies_

template<class ThermoType>
class Foam::chemistryReductionMethod< ThermoType >