Loading...
Searching...
No Matches
chemistryReductionMethod< CompType, ThermoType > Class Template Referenceabstract

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

#include <chemistryReductionMethod.H>

Inheritance diagram for chemistryReductionMethod< CompType, ThermoType >:
Inheritance graph
[legend]
Collaboration diagram for chemistryReductionMethod< CompType, ThermoType >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("chemistryReductionMethod")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, chemistryReductionMethod, dictionary,(const IOdictionary &dict, TDACChemistryModel< CompType, ThermoType > &chemistry),(dict, chemistry))
 chemistryReductionMethod (const IOdictionary &dict, TDACChemistryModel< CompType, ThermoType > &chemistry)
 Construct from components.
virtual ~chemistryReductionMethod ()
 Destructor.
bool active () const
 Is mechanism reduction active?
bool log () const
 Is performance data logging enabled?
const List< bool > & activeSpecies () const
 Return the active species.
label NsSimp ()
 Return the number of active species.
label nSpecie ()
 Return the initial number of species.
scalar tolerance () const
 Return the tolerance.
virtual void reduceMechanism (const scalarField &c, const scalar T, const scalar p)=0
 Reduce the mechanism.

Static Public Member Functions

static autoPtr< chemistryReductionMethod< CompType, ThermoType > > New (const IOdictionary &dict, TDACChemistryModel< CompType, ThermoType > &chemistry)

Protected Attributes

const IOdictionary & dict_
const dictionary coeffsDict_
 Dictionary that store the algorithm data.
Switch active_
 Is mechanism reduction active?
Switch log_
 Switch to select performance logging.
TDACChemistryModel< CompType, ThermoType > & chemistry_
List< bool > activeSpecies_
 List of active species (active = true).
label NsSimp_
 Number of active species.
const label nSpecie_
 Number of species.
scalar tolerance_
 Tolerance for the mechanism reduction algorithm.

Detailed Description

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

An abstract class for methods of chemical mechanism reduction.

An abstract class for reducing chemical mechanisms.

Source files

Source files

Definition at line 52 of file chemistryReductionMethod.H.

Constructor & Destructor Documentation

◆ chemistryReductionMethod()

template<class CompType, class ThermoType>
chemistryReductionMethod ( const IOdictionary & dict,
Foam::TDACChemistryModel< CompType, ThermoType > & chemistry )

Construct from components.

Definition at line 28 of file chemistryReductionMethod.C.

References active_, activeSpecies_, chemistry, chemistry_, coeffsDict_, dict, dict_, e, log_, nSpecie(), nSpecie_, NsSimp_, and tolerance_.

Referenced by DAC< CompType, ThermoType >::DAC(), DRG< CompType, ThermoType >::DRG(), DRGEP< CompType, ThermoType >::DRGEP(), EFA< CompType, ThermoType >::EFA(), none< CompType, ThermoType >::none(), and PFA< CompType, ThermoType >::PFA().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ~chemistryReductionMethod()

template<class CompType, class ThermoType>
~chemistryReductionMethod ( )
virtual

Destructor.

Definition at line 49 of file chemistryReductionMethod.C.

Member Function Documentation

◆ TypeName()

template<class CompType, class ThermoType>
TypeName ( "chemistryReductionMethod< CompType, ThermoType >" )

Runtime type information.

◆ declareRunTimeSelectionTable()

template<class CompType, class ThermoType>
declareRunTimeSelectionTable ( autoPtr ,
chemistryReductionMethod< CompType, ThermoType > ,
dictionary ,
(const IOdictionary &dict, TDACChemistryModel< CompType, ThermoType > &chemistry) ,
(dict, chemistry)  )

◆ New()

template<class CompType, class ThermoType>
Foam::autoPtr< Foam::chemistryReductionMethod< CompType, ThermoType > > New ( const IOdictionary & dict,
TDACChemistryModel< CompType, ThermoType > & chemistry )
static

DynamicList<word> thisCmpts(6); thisCmpts.append(CompType::typeName); thisCmpts.append ( basicThermo::splitThermoName(ThermoType::typeName(), 5) );

DynamicList<word> validNames;

if (thisCmpts == SubList<word>(cmpts, 6, 1)) { validNames.append(cmpts[0]); }

Definition at line 29 of file chemistryReductionMethodNew.C.

References DynamicList< T, SizeMin >::append(), chemistry, dict, UList< T >::empty(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInLookup, dictionary::get(), Foam::Info, names, Foam::nl, Foam::printTable(), UList< T >::size(), and basicThermo::splitThermoName().

Referenced by TDACChemistryModel< ReactionThermo, ThermoType >::TDACChemistryModel().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ active()

template<class CompType, class ThermoType>
bool active ( ) const
inline

Is mechanism reduction active?

Definition at line 36 of file chemistryReductionMethodI.H.

References active_.

◆ log()

template<class CompType, class ThermoType>
bool log ( ) const
inline

Is performance data logging enabled?

Definition at line 44 of file chemistryReductionMethodI.H.

References active_, and log_.

◆ activeSpecies()

template<class CompType, class ThermoType>
const Foam::List< bool > & activeSpecies ( ) const
inline

Return the active species.

Definition at line 52 of file chemistryReductionMethodI.H.

References activeSpecies_.

◆ NsSimp()

template<class CompType, class ThermoType>
Foam::label NsSimp ( )
inline

Return the number of active species.

Definition at line 60 of file chemistryReductionMethodI.H.

References NsSimp_.

◆ nSpecie()

template<class CompType, class ThermoType>
Foam::label nSpecie ( )
inline

Return the initial number of species.

Definition at line 68 of file chemistryReductionMethodI.H.

References nSpecie_.

Referenced by chemistryReductionMethod().

Here is the caller graph for this function:

◆ tolerance()

template<class CompType, class ThermoType>
Foam::scalar tolerance ( ) const
inline

Return the tolerance.

Definition at line 76 of file chemistryReductionMethodI.H.

References tolerance_.

Referenced by DAC< CompType, ThermoType >::DAC(), DAC< CompType, ThermoType >::reduceMechanism(), DRG< CompType, ThermoType >::reduceMechanism(), DRGEP< CompType, ThermoType >::reduceMechanism(), EFA< CompType, ThermoType >::reduceMechanism(), and PFA< CompType, ThermoType >::reduceMechanism().

Here is the caller graph for this function:

◆ reduceMechanism()

template<class CompType, class ThermoType>
virtual void reduceMechanism ( const scalarField & c,
const scalar T,
const scalar p )
pure virtual

Reduce the mechanism.

Implemented in DAC< CompType, ThermoType >, DRG< CompType, ThermoType >, DRGEP< CompType, ThermoType >, EFA< CompType, ThermoType >, none< CompType, ThermoType >, none< psiReactionThermo, constAdiabaticFluidEThermoPhysics >, none< psiReactionThermo, constAdiabaticFluidHThermoPhysics >, none< psiReactionThermo, constEThermoPhysics >, none< psiReactionThermo, constFluidEThermoPhysics >, none< psiReactionThermo, constFluidHThermoPhysics >, none< psiReactionThermo, constGasEThermoPhysics >, none< psiReactionThermo, constGasHThermoPhysics >, none< psiReactionThermo, constHThermoPhysics >, none< psiReactionThermo, constIncompressibleGasEThermoPhysics >, none< psiReactionThermo, constIncompressibleGasHThermoPhysics >, none< psiReactionThermo, gasEThermoPhysics >, none< psiReactionThermo, gasHThermoPhysics >, none< psiReactionThermo, icoPoly8EThermoPhysics >, none< psiReactionThermo, icoPoly8HThermoPhysics >, none< psiReactionThermo, incompressibleGasEThermoPhysics >, none< psiReactionThermo, incompressibleGasHThermoPhysics >, none< psiReactionThermo, PengRobinsonGasEThermoPhysics >, none< psiReactionThermo, PengRobinsonGasHThermoPhysics >, none< rhoReactionThermo, constAdiabaticFluidEThermoPhysics >, none< rhoReactionThermo, constAdiabaticFluidHThermoPhysics >, none< rhoReactionThermo, constEThermoPhysics >, none< rhoReactionThermo, constFluidEThermoPhysics >, none< rhoReactionThermo, constFluidHThermoPhysics >, none< rhoReactionThermo, constGasEThermoPhysics >, none< rhoReactionThermo, constGasHThermoPhysics >, none< rhoReactionThermo, constHThermoPhysics >, none< rhoReactionThermo, constIncompressibleGasEThermoPhysics >, none< rhoReactionThermo, constIncompressibleGasHThermoPhysics >, none< rhoReactionThermo, gasEThermoPhysics >, none< rhoReactionThermo, gasHThermoPhysics >, none< rhoReactionThermo, icoPoly8EThermoPhysics >, none< rhoReactionThermo, icoPoly8HThermoPhysics >, none< rhoReactionThermo, incompressibleGasEThermoPhysics >, none< rhoReactionThermo, incompressibleGasHThermoPhysics >, none< rhoReactionThermo, PengRobinsonGasEThermoPhysics >, none< rhoReactionThermo, PengRobinsonGasHThermoPhysics >, and PFA< CompType, ThermoType >.

Member Data Documentation

◆ dict_

template<class CompType, class ThermoType>
const IOdictionary& dict_
protected

Definition at line 57 of file chemistryReductionMethod.H.

Referenced by chemistryReductionMethod().

◆ coeffsDict_

template<class CompType, class ThermoType>
const dictionary coeffsDict_
protected

Dictionary that store the algorithm data.

Definition at line 62 of file chemistryReductionMethod.H.

Referenced by chemistryReductionMethod(), DAC< CompType, ThermoType >::DAC(), DRG< CompType, ThermoType >::DRG(), DRGEP< CompType, ThermoType >::DRGEP(), EFA< CompType, ThermoType >::EFA(), and PFA< CompType, ThermoType >::PFA().

◆ active_

template<class CompType, class ThermoType>
Switch active_
protected

Is mechanism reduction active?

Definition at line 67 of file chemistryReductionMethod.H.

Referenced by active(), chemistryReductionMethod(), log(), and none< CompType, ThermoType >::none().

◆ log_

template<class CompType, class ThermoType>
Switch log_
protected

Switch to select performance logging.

Definition at line 72 of file chemistryReductionMethod.H.

Referenced by chemistryReductionMethod(), and log().

◆ chemistry_

template<class CompType, class ThermoType>
TDACChemistryModel<CompType, ThermoType>& chemistry_
protected

Definition at line 74 of file chemistryReductionMethod.H.

Referenced by chemistryReductionMethod(), DAC< CompType, ThermoType >::DAC(), EFA< CompType, ThermoType >::EFA(), DAC< CompType, ThermoType >::reduceMechanism(), DRG< CompType, ThermoType >::reduceMechanism(), DRGEP< CompType, ThermoType >::reduceMechanism(), EFA< CompType, ThermoType >::reduceMechanism(), and PFA< CompType, ThermoType >::reduceMechanism().

◆ activeSpecies_

template<class CompType, class ThermoType>
List<bool> activeSpecies_
protected

List of active species (active = true).

Definition at line 79 of file chemistryReductionMethod.H.

Referenced by activeSpecies(), chemistryReductionMethod(), DAC< CompType, ThermoType >::reduceMechanism(), DRG< CompType, ThermoType >::reduceMechanism(), DRGEP< CompType, ThermoType >::reduceMechanism(), EFA< CompType, ThermoType >::reduceMechanism(), and PFA< CompType, ThermoType >::reduceMechanism().

◆ NsSimp_

template<class CompType, class ThermoType>
label NsSimp_
protected

Number of active species.

Definition at line 84 of file chemistryReductionMethod.H.

Referenced by chemistryReductionMethod(), NsSimp(), DAC< CompType, ThermoType >::reduceMechanism(), DRG< CompType, ThermoType >::reduceMechanism(), DRGEP< CompType, ThermoType >::reduceMechanism(), EFA< CompType, ThermoType >::reduceMechanism(), and PFA< CompType, ThermoType >::reduceMechanism().

◆ nSpecie_

template<class CompType, class ThermoType>
const label nSpecie_
protected

Number of species.

Definition at line 89 of file chemistryReductionMethod.H.

Referenced by chemistryReductionMethod(), DAC< CompType, ThermoType >::DAC(), DRGEP< CompType, ThermoType >::DRGEP(), EFA< CompType, ThermoType >::EFA(), nSpecie(), DAC< CompType, ThermoType >::reduceMechanism(), DRG< CompType, ThermoType >::reduceMechanism(), DRGEP< CompType, ThermoType >::reduceMechanism(), EFA< CompType, ThermoType >::reduceMechanism(), and PFA< CompType, ThermoType >::reduceMechanism().

◆ tolerance_

template<class CompType, class ThermoType>
scalar tolerance_
protected

Tolerance for the mechanism reduction algorithm.

Definition at line 94 of file chemistryReductionMethod.H.

Referenced by chemistryReductionMethod(), and tolerance().

The documentation for this class was generated from the following files:
  • src/thermophysicalModels/chemistryModel/chemistryModel/TDACChemistryModel/reduction/chemistryReductionMethod/chemistryReductionMethod.H
  • src/thermophysicalModels/chemistryModel/chemistryModel/TDACChemistryModel/reduction/chemistryReductionMethod/chemistryReductionMethod.C
  • src/thermophysicalModels/chemistryModel/chemistryModel/TDACChemistryModel/reduction/chemistryReductionMethod/chemistryReductionMethodI.H
  • src/thermophysicalModels/chemistryModel/chemistryModel/TDACChemistryModel/reduction/chemistryReductionMethod/chemistryReductionMethodNew.C