StandardChemistryModel< ReactionThermo, ThermoType > Class Template Referenceabstract

Extends base chemistry model by adding a thermo package, and ODE functions. Introduces chemistry equation system and evaluation of chemical source terms. More...

Inheritance diagram for StandardChemistryModel< ReactionThermo, ThermoType >:
Collaboration diagram for StandardChemistryModel< ReactionThermo, ThermoType >:

Public Member Functions

 TypeName ("standard")
 Runtime type information. More...
 
 StandardChemistryModel (const ReactionThermo &thermo)
 Construct from thermo. More...
 
 StandardChemistryModel (const StandardChemistryModel &)
 Disallow default bitwise copy construction. More...
 
virtual ~StandardChemistryModel ()
 Destructor. More...
 
const PtrList< Reaction< ThermoType > > & reactions () const
 The reactions. More...
 
const PtrList< ThermoType > & specieThermos () const
 Thermodynamic data of the species. More...
 
virtual label nSpecie () const
 The number of species. More...
 
virtual label nReaction () const
 The number of reactions. More...
 
scalar Treact () const
 Temperature below which the reaction rates are assumed 0. More...
 
scalar & Treact ()
 Temperature below which the reaction rates are assumed 0. More...
 
virtual void omega (const scalar p, const scalar T, const scalarField &c, const label li, scalarField &dcdt) const
 dc/dt = omega, rate of change in concentration, for each species More...
 
virtual scalar omegaI (label iReaction, const scalar p, const scalar T, const scalarField &c, const label li, scalar &pf, scalar &cf, label &lRef, scalar &pr, scalar &cr, label &rRef) const
 Return the reaction rate for iReaction and the reference. More...
 
virtual void calculate ()
 Calculates the reaction rates. More...
 
const volScalarField::InternalRR (const label i) const
 Return const access to the chemical source terms for specie, i. More...
 
virtual volScalarField::InternalRR (const label i)
 Return non const access to chemical source terms [kg/m^3/s]. More...
 
virtual tmp< volScalarField::InternalcalculateRR (const label reactionI, const label speciei) const
 Return reaction rate of the speciei in reactionI. More...
 
virtual scalar solve (const scalar deltaT)
 Solve the reaction system for the given time step. More...
 
virtual scalar solve (const scalarField &deltaT)
 Solve the reaction system for the given time step. More...
 
virtual tmp< volScalarFieldtc () const
 Return the chemical time scale. More...
 
virtual tmp< volScalarFieldQdot () const
 Return the heat release rate [kg/m/s^3]. More...
 
virtual label nEqns () const
 Number of ODE's to solve. More...
 
virtual void derivatives (const scalar t, const scalarField &c, const label li, scalarField &dcdt) const
 Calculate the derivatives in dydx. More...
 
virtual void jacobian (const scalar t, const scalarField &c, const label li, scalarField &dcdt, scalarSquareMatrix &J) const
 Calculate the Jacobian of the system. More...
 
virtual void solve (scalar &p, scalar &T, scalarField &c, const label li, scalar &deltaT, scalar &subDeltaT) const =0
 
void operator= (const StandardChemistryModel &)=delete
 Disallow default bitwise assignment. More...
 
template<class DeltaTType >
Foam::scalar solve (const DeltaTType &deltaT)
 
- Public Member Functions inherited from BasicChemistryModel< ReactionThermo >
 TypeName ("BasicChemistryModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, BasicChemistryModel, thermo,(const ReactionThermo &thermo),(thermo))
 Declare run-time constructor selection tables. More...
 
 BasicChemistryModel (const ReactionThermo &thermo)
 Construct from thermo. More...
 
virtual ~BasicChemistryModel ()
 Destructor. More...
 
const ReactionThermo & thermo () const
 Return const access to the thermo package. More...
 
- Public Member Functions inherited from basicChemistryModel
 TypeName ("basicChemistryModel")
 Runtime type information. More...
 
 basicChemistryModel (const basicThermo &thermo)
 Construct from thermo. More...
 
 basicChemistryModel (const basicChemistryModel &)
 Construct as copy (not implemented) More...
 
virtual ~basicChemistryModel ()
 Destructor. More...
 
const fvMeshmesh () const
 Return const access to the mesh database. More...
 
Switch chemistry () const
 Chemistry activation switch. More...
 
const volScalarField::InternaldeltaTChem () const
 Return the latest estimation of integration step. More...
 
void operator= (const basicChemistryModel &)=delete
 Disallow default bitwise assignment. More...
 
template<class ChemistryModel >
Foam::autoPtr< ChemistryModel > New (const typename ChemistryModel::reactionThermo &thermo)
 
- Public Member Functions inherited from IOdictionary
 IOdictionary (const IOobject &)
 Construct given an IOobject. More...
 
 IOdictionary (const IOobject &, const dictionary &)
 Construct given an IOobject and dictionary. More...
 
 IOdictionary (const IOobject &, Istream &)
 Construct given an IOobject and Istream. More...
 
 IOdictionary (const IOdictionary &)
 Copy constructor. More...
 
 IOdictionary (IOdictionary &&)
 Move constructor. More...
 
virtual ~IOdictionary ()
 Destructor. More...
 
virtual bool global () const
 Is object global. More...
 
virtual fileName filePath () const
 Return complete path + object name if the file exists. More...
 
void operator= (IOdictionary &&)
 Move assignment. More...
 
- Public Member Functions inherited from baseIOdictionary
 TypeName ("dictionary")
 
 baseIOdictionary (const IOobject &)
 Construct given an IOobject. More...
 
 baseIOdictionary (const IOobject &, const dictionary &)
 Construct given an IOobject and dictionary. More...
 
 baseIOdictionary (const IOobject &, Istream &)
 Construct given an IOobject and Istream. More...
 
 baseIOdictionary (const baseIOdictionary &)
 Copy constructor. More...
 
 baseIOdictionary (baseIOdictionary &&)
 Move constructor. More...
 
virtual ~baseIOdictionary ()
 Destructor. More...
 
const wordname () const
 Name function is needed to disambiguate those inherited. More...
 
virtual bool readData (Istream &)
 ReadData function required for regIOobject read operation. More...
 
virtual bool writeData (Ostream &) const
 WriteData function required for regIOobject write operation. More...
 
void operator= (const baseIOdictionary &)
 Assignment of other baseIOdictionary's entries to this. More...
 
void operator= (baseIOdictionary &&)
 Move assignment. More...
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the. More...
 
 regIOobject (const regIOobject &)
 Copy constructor. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Copy constructor, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Copy constructor with new name, transferring registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Copy constructor with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
virtual void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
void store ()
 Transfer ownership of this object to its registry. More...
 
void release ()
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
labeleventNo ()
 Event number at last update. More...
 
bool upToDate (const regIOobject &) const
 Return true if up-to-date with respect to given object. More...
 
bool upToDate (const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
void setUpToDate ()
 Set up to date (obviously) More...
 
virtual void rename (const word &newName)
 Rename. More...
 
bool headerOk ()
 Read and check header info. More...
 
IstreamreadStream (const word &, const bool read=true)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual bool read ()
 Read object. More...
 
virtual label addWatch (const fileName &)
 Add file watch for fileName on object if not yet watched. Return. More...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
 Write using given format, version and compression. More...
 
virtual bool write (const bool write=true) const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Construct from copy resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Construct from copy resetting name. More...
 
 IOobject (const IOobject &io)=default
 Copy constructor. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
wordheaderClassName ()
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () const
 Return the optional note. More...
 
bool & registerObject ()
 Register object created from this IOobject with registry if true. More...
 
bool registerObject () const
 Register object created from this IOobject with registry if true. More...
 
readOption readOpt () const
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
word modelName (const char *name) const
 Return the name of the object within this model. More...
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const
 
fileNameinstance ()
 
const fileNamelocal () const
 
fileName path () const
 Return complete path. More...
 
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local. More...
 
fileName localPath () const
 Return the path relative to the case. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName localObjectPath () const
 Return complete localPath + object name. More...
 
fileName localFilePath (const word &typeName) const
 Helper for filePath that searches locally. More...
 
fileName globalFilePath (const word &typeName) const
 Helper for filePath that searches up if in parallel. More...
 
bool readHeader (Istream &)
 Read header. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType=true)
 Read header (uses typeFilePath to find file) and check header. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &) const
 Write header. More...
 
bool writeHeader (Ostream &, const word &objectType) const
 Write header. Allow override of type. More...
 
bool good () const
 
bool bad () const
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 
template<class Name >
Foam::word modelName (Name name, const word &model)
 
- Public Member Functions inherited from dictionary
 ClassName ("dictionary")
 
 dictionary ()
 Construct top-level dictionary null. More...
 
 dictionary (const fileName &name)
 Construct top-level empty dictionary with given name. More...
 
 dictionary (const fileName &name, const dictionary &parentDict, Istream &)
 Construct given the entry name, parent dictionary and Istream,. More...
 
 dictionary (Istream &, const bool keepHeader=false)
 Construct top-level dictionary from Istream,. More...
 
 dictionary (const dictionary &parentDict, const dictionary &)
 Construct as copy given the parent dictionary. More...
 
 dictionary (const dictionary &)
 Construct top-level dictionary as copy. More...
 
 dictionary (const dictionary *)
 Construct top-level dictionary as copy from pointer to dictionary. More...
 
 dictionary (const dictionary &parentDict, dictionary &&)
 Move constructor transferring parameter contents. More...
 
 dictionary (dictionary &&)
 Move constructor. More...
 
autoPtr< dictionaryclone () const
 Construct and return clone. More...
 
virtual ~dictionary ()
 Destructor. More...
 
const dictionaryparent () const
 Return the parent dictionary. More...
 
bool isNull () const
 Return whether this dictionary is null. More...
 
const dictionarytopDict () const
 Return the top of the tree. More...
 
label startLineNumber () const
 Return line number of first token in dictionary. More...
 
label endLineNumber () const
 Return line number of last token in dictionary. More...
 
SHA1Digest digest () const
 Return the SHA1 digest of the dictionary contents. More...
 
tokenList tokens () const
 Return the dictionary as a list of tokens. More...
 
bool found (const word &, bool recursive=false, bool patternMatch=true) const
 Search dictionary for given keyword. More...
 
const entrylookupEntryPtr (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream pointer if present. More...
 
entrylookupEntryPtr (const word &, bool recursive, bool patternMatch)
 Find and return an entry data stream pointer for manipulation. More...
 
const entrylookupEntry (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream if present otherwise error. More...
 
ITstreamlookup (const word &, bool recursive=false, bool patternMatch=true) const
 Find and return an entry data stream. More...
 
template<class T >
T lookup (const word &, bool recursive=false, bool patternMatch=true) const
 Find and return a T,. More...
 
template<class T >
T lookupOrDefault (const word &, const T &, bool recursive=false, bool patternMatch=true) const
 Find and return a T,. More...
 
template<class T >
T lookupOrAddDefault (const word &, const T &, bool recursive=false, bool patternMatch=true)
 Find and return a T, if not found return the given. More...
 
template<class T >
bool readIfPresent (const word &, T &, bool recursive=false, bool patternMatch=true) const
 Find an entry if present, and assign to T. More...
 
const entrylookupScopedEntryPtr (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream pointer if present. More...
 
bool isDict (const word &) const
 Check if entry is a sub-dictionary. More...
 
const dictionarysubDictPtr (const word &) const
 Find and return a sub-dictionary pointer if present. More...
 
dictionarysubDictPtr (const word &)
 Find and return a sub-dictionary pointer if present. More...
 
const dictionarysubDict (const word &) const
 Find and return a sub-dictionary. More...
 
dictionarysubDict (const word &)
 Find and return a sub-dictionary for manipulation. More...
 
dictionary subOrEmptyDict (const word &, const bool mustRead=false) const
 Find and return a sub-dictionary as a copy, or. More...
 
const dictionaryoptionalSubDict (const word &) const
 Find and return a sub-dictionary if found. More...
 
wordList toc () const
 Return the table of contents. More...
 
wordList sortedToc () const
 Return the sorted table of contents. More...
 
List< keyTypekeys (bool patterns=false) const
 Return the list of available keys or patterns. More...
 
bool substituteKeyword (const word &keyword)
 Substitute the given keyword prepended by '$' with the. More...
 
bool substituteScopedKeyword (const word &keyword)
 Substitute the given scoped keyword prepended by '$' with the. More...
 
bool add (entry *, bool mergeEntry=false)
 Add a new entry. More...
 
void add (const entry &, bool mergeEntry=false)
 Add an entry. More...
 
void add (const keyType &, const word &, bool overwrite=false)
 Add a word entry. More...
 
void add (const keyType &, const string &, bool overwrite=false)
 Add a string entry. More...
 
void add (const keyType &, const label, bool overwrite=false)
 Add a label entry. More...
 
void add (const keyType &, const scalar, bool overwrite=false)
 Add a scalar entry. More...
 
void add (const keyType &, const dictionary &, bool mergeEntry=false)
 Add a dictionary entry. More...
 
template<class T >
void add (const keyType &, const T &, bool overwrite=false)
 Add a T entry. More...
 
void set (entry *)
 Assign a new entry, overwrite any existing entry. More...
 
void set (const entry &)
 Assign a new entry, overwrite any existing entry. More...
 
void set (const keyType &, const dictionary &)
 Assign a dictionary entry, overwrite any existing entry. More...
 
template<class T >
void set (const keyType &, const T &)
 Assign a T entry, overwrite any existing entry. More...
 
bool remove (const word &)
 Remove an entry specified by keyword. More...
 
bool changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool forceOverwrite=false)
 Change the keyword for an entry,. More...
 
bool merge (const dictionary &)
 Merge entries from the given dictionary. More...
 
void clear ()
 Clear the dictionary. More...
 
void transfer (dictionary &)
 Transfer the contents of the argument and annul the argument. More...
 
bool read (Istream &, const bool keepHeader=false)
 Read dictionary from Istream, optionally keeping the header. More...
 
void write (Ostream &, const bool subDict=true) const
 Write dictionary, normally with sub-dictionary formatting. More...
 
ITstreamoperator[] (const word &) const
 Find and return entry. More...
 
void operator= (const dictionary &)
 
void operator= (dictionary &&)
 
void operator+= (const dictionary &)
 Include entries from the given dictionary. More...
 
void operator|= (const dictionary &)
 Conditionally include entries from the given dictionary. More...
 
void operator<<= (const dictionary &)
 Unconditionally include entries from the given dictionary. More...
 
- Public Member Functions inherited from dictionaryName
 dictionaryName ()
 Construct dictionaryName null. More...
 
 dictionaryName (const fileName &name)
 Construct dictionaryName as copy of the given fileName. More...
 
 dictionaryName (dictionaryName &&name)
 Move constructor. More...
 
const fileNamename () const
 Return the dictionary name. More...
 
fileNamename ()
 Return the dictionary name. More...
 
const word dictName () const
 Return the local dictionary name (final part of scoped name) More...
 
void operator= (const dictionaryName &name)
 
void operator= (dictionaryName &&name)
 
- Public Member Functions inherited from ILList< LListBase, T >
 ILList ()
 Null construct. More...
 
 ILList (T *a)
 Construct given initial T. More...
 
 ILList (Istream &)
 Construct from Istream. More...
 
 ILList (const ILList< LListBase, T > &)
 Copy constructor. More...
 
 ILList (ILList< LListBase, T > &&)
 Move constructor. More...
 
template<class CloneArg >
 ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone. More...
 
template<class INew >
 ILList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class. More...
 
 ~ILList ()
 Destructor. More...
 
bool eraseHead ()
 Remove the head element specified from the list and delete it. More...
 
bool erase (T *p)
 Remove the specified element from the list and delete it. More...
 
void clear ()
 Clear the contents of the list. More...
 
void transfer (ILList< LListBase, T > &)
 Transfer the contents of the argument into this List. More...
 
void operator= (const ILList< LListBase, T > &)
 Assignment operator. More...
 
void operator= (ILList< LListBase, T > &&)
 Move assignment operator. More...
 
- Public Member Functions inherited from UILList< LListBase, T >
 UILList ()
 Null construct. More...
 
 UILList (T *a)
 Construct given initial T. More...
 
 UILList (const UILList< LListBase, T > &)
 Copy constructor. More...
 
 UILList (UILList< LListBase, T > &&)
 Move constructor. More...
 
Tfirst ()
 Return the first entry. More...
 
const Tfirst () const
 Return the first entry. More...
 
Tlast ()
 Return the last entry. More...
 
const Tlast () const
 Return the last entry. More...
 
TremoveHead ()
 Remove and return head. More...
 
Tremove (T *p)
 Remove and return element. More...
 
Tremove (iterator &it)
 Remove and return specified by iterator. More...
 
void operator= (const UILList< LListBase, T > &)
 Assignment operator. More...
 
void operator= (UILList< LListBase, T > &&)
 Move assignment operator. More...
 
iterator begin ()
 
const iteratorend ()
 
const_iterator cbegin () const
 
const const_iteratorcend () const
 
const_iterator begin () const
 
const const_iteratorend () const
 
const_reverse_iterator crbegin () const
 
const const_reverse_iteratorcrend () const
 
const_reverse_iterator rbegin () const
 
const const_reverse_iteratorrend () const
 
bool operator== (const UILList< LListBase, T > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UILList< LListBase, T > &) const
 The opposite of the equality operation. Takes linear time. More...
 
- Public Member Functions inherited from ODESystem
 ODESystem ()
 Construct null. More...
 
virtual ~ODESystem ()
 Destructor. More...
 

Protected Types

typedef ThermoType thermoType
 

Protected Member Functions

PtrList< volScalarField::Internal > & RR ()
 Write access to chemical source terms. More...
 
- Protected Member Functions inherited from basicChemistryModel
volScalarField::InternaldeltaTChem ()
 Return non-const access to the latest estimation of integration. More...
 
void correct ()
 Correct function - updates due to mesh changes. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstream::streamFormat PstreamFormat, const word &typeName)
 Helper: check readOpt flags and read if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &)
 Set the object state to bad. More...
 

Protected Attributes

const PtrList< volScalarField > & Y_
 Reference to the field of specie mass fractions. More...
 
const PtrList< ThermoType > & specieThermos_
 Thermodynamic data of the species. More...
 
const ReactionList< ThermoType > reactions_
 Reactions. More...
 
label nSpecie_
 Number of species. More...
 
label nReaction_
 Number of reactions. More...
 
scalar Treact_
 Temperature below which the reaction rates are assumed 0. More...
 
PtrList< volScalarField::InternalRR_
 List of reaction rate per specie [kg/m^3/s]. More...
 
scalarField c_
 Temporary concentration field. More...
 
scalarField dcdt_
 Temporary rate-of-change of concentration field. More...
 
- Protected Attributes inherited from BasicChemistryModel< ReactionThermo >
const ReactionThermo & thermo_
 Thermo. More...
 
- Protected Attributes inherited from basicChemistryModel
const fvMeshmesh_
 Reference to the mesh database. More...
 
Switch chemistry_
 Chemistry activation switch. More...
 
const scalar deltaTChemIni_
 Initial chemical time step. More...
 
const scalar deltaTChemMax_
 Maximum chemical time step. More...
 
volScalarField::Internal deltaTChem_
 Latest estimation of integration step. More...
 

Additional Inherited Members

- Public Types inherited from BasicChemistryModel< ReactionThermo >
typedef ReactionThermo reactionThermo
 Thermo type. More...
 
- Public Types inherited from IOobject
enum  objectState { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Enumeration defining the file checking options. More...
 
- Public Types inherited from UILList< LListBase, T >
typedef T value_type
 Type of values the DLList contains. More...
 
typedef Treference
 Type that can be used for storing into DLList::value_type. More...
 
typedef const Tconst_reference
 Type that can be used for storing into constant. More...
 
typedef label size_type
 The type that can represent the size of a DLList. More...
 
typedef LListBase::iterator LListBase_iterator
 
typedef LListBase::const_iterator LListBase_const_iterator
 
- Static Public Member Functions inherited from BasicChemistryModel< ReactionThermo >
static autoPtr< BasicChemistryModel< ReactionThermo > > New (const ReactionThermo &thermo)
 Selector. More...
 
- Static Public Member Functions inherited from basicChemistryModel
template<class ChemistryModel >
static autoPtr< ChemistryModel > New (const typename ChemistryModel::reactionThermo &thermo)
 Generic New for each of the related chemistry model. More...
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *)
 Transfer ownership of the given object pointer to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &)
 Transfer ownership of the given object pointer to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class Name >
static word groupName (Name name, const word &group)
 
static word group (const word &name)
 Return group (extension part of name) More...
 
static word member (const word &name)
 Return member (name without the extension) More...
 
template<class Name >
static word modelName (Name name, const word &model)
 Return the name of the object within the given model. More...
 
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider. More...
 
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider. More...
 
- Static Public Member Functions inherited from dictionary
static autoPtr< dictionaryNew (Istream &)
 Construct top-level dictionary on freestore from Istream. More...
 
- Static Public Attributes inherited from regIOobject
static float fileModificationSkew
 
- Static Public Attributes inherited from IOobject
static constexpr const char * foamFile = "FoamFile"
 Keyword for the FoamFile header sub-dictionary. More...
 
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 
- Static Public Attributes inherited from dictionary
static const dictionary null
 Null dictionary. More...
 

Detailed Description

template<class ReactionThermo, class ThermoType>
class Foam::StandardChemistryModel< ReactionThermo, ThermoType >

Extends base chemistry model by adding a thermo package, and ODE functions. Introduces chemistry equation system and evaluation of chemical source terms.

Source files

Definition at line 58 of file StandardChemistryModel.H.

Member Typedef Documentation

◆ thermoType

typedef ThermoType thermoType
protected

Definition at line 73 of file StandardChemistryModel.H.

Constructor & Destructor Documentation

◆ StandardChemistryModel() [1/2]

StandardChemistryModel ( const ReactionThermo &  thermo)

Construct from thermo.

Definition at line 35 of file StandardChemistryModel.C.

◆ StandardChemistryModel() [2/2]

StandardChemistryModel ( const StandardChemistryModel< ReactionThermo, ThermoType > &  )

Disallow default bitwise copy construction.

◆ ~StandardChemistryModel()

~StandardChemistryModel ( )
virtual

Destructor.

Definition at line 103 of file StandardChemistryModel.C.

Referenced by StandardChemistryModel< CompType, ThermoType >::StandardChemistryModel().

Here is the caller graph for this function:

Member Function Documentation

◆ RR() [1/3]

Foam::PtrList< Foam::DimensionedField< Foam::scalar, Foam::volMesh > > & RR ( )
inlineprotected

Write access to chemical source terms.

(e.g. for multi-chemistry model)

Definition at line 42 of file StandardChemistryModelI.H.

Referenced by StandardChemistryModel< CompType, ThermoType >::RR(), and StandardChemistryModel< CompType, ThermoType >::Treact().

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "standard"  )

Runtime type information.

◆ reactions()

const Foam::PtrList< Foam::Reaction< ThermoType > > & reactions ( ) const
inline

The reactions.

Definition at line 50 of file StandardChemistryModelI.H.

◆ specieThermos()

const Foam::PtrList< ThermoType > & specieThermos ( ) const
inline

Thermodynamic data of the species.

Definition at line 58 of file StandardChemistryModelI.H.

◆ nSpecie()

Foam::label nSpecie ( ) const
inlinevirtual

The number of species.

Implements basicChemistryModel.

Definition at line 66 of file StandardChemistryModelI.H.

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

Here is the caller graph for this function:

◆ nReaction()

Foam::label nReaction ( ) const
inlinevirtual

The number of reactions.

Implements basicChemistryModel.

Definition at line 74 of file StandardChemistryModelI.H.

◆ Treact() [1/2]

Foam::scalar Treact ( ) const
inline

Temperature below which the reaction rates are assumed 0.

Definition at line 82 of file StandardChemistryModelI.H.

◆ Treact() [2/2]

Foam::scalar & Treact ( )
inline

Temperature below which the reaction rates are assumed 0.

Definition at line 90 of file StandardChemistryModelI.H.

◆ omega()

void omega ( const scalar  p,
const scalar  T,
const scalarField c,
const label  li,
scalarField dcdt 
) const
virtual

dc/dt = omega, rate of change in concentration, for each species

Reimplemented in TDACChemistryModel< ReactionThermo, ThermoType >, and TDACChemistryModel< CompType, ThermoType >.

Definition at line 111 of file StandardChemistryModel.C.

Referenced by StandardChemistryModel< CompType, ThermoType >::~StandardChemistryModel().

Here is the caller graph for this function:

◆ omegaI()

Foam::scalar omegaI ( label  iReaction,
const scalar  p,
const scalar  T,
const scalarField c,
const label  li,
scalar &  pf,
scalar &  cf,
label lRef,
scalar &  pr,
scalar &  cr,
label rRef 
) const
virtual

Return the reaction rate for iReaction and the reference.

species and characteristic times

Definition at line 133 of file StandardChemistryModel.C.

Referenced by StandardChemistryModel< CompType, ThermoType >::omega().

Here is the caller graph for this function:

◆ calculate()

void calculate ( )
virtual

Calculates the reaction rates.

Implements basicChemistryModel.

Definition at line 452 of file StandardChemistryModel.C.

◆ RR() [2/3]

const Foam::DimensionedField< Foam::scalar, Foam::volMesh > & RR ( const label  i) const
inlinevirtual

Return const access to the chemical source terms for specie, i.

Implements basicChemistryModel.

Definition at line 99 of file StandardChemistryModelI.H.

◆ RR() [3/3]

Foam::DimensionedField< Foam::scalar, Foam::volMesh > & RR ( const label  i)
virtual

Return non const access to chemical source terms [kg/m^3/s].

Implements basicChemistryModel.

Definition at line 109 of file StandardChemistryModelI.H.

◆ calculateRR()

Foam::tmp< Foam::DimensionedField< Foam::scalar, Foam::volMesh > > calculateRR ( const label  reactionI,
const label  speciei 
) const
virtual

Return reaction rate of the speciei in reactionI.

Implements basicChemistryModel.

Definition at line 384 of file StandardChemistryModel.C.

Referenced by StandardChemistryModel< CompType, ThermoType >::Qdot().

Here is the caller graph for this function:

◆ solve() [1/4]

Foam::scalar solve ( const scalar  deltaT)
virtual

Solve the reaction system for the given time step.

and return the characteristic time

Implements basicChemistryModel.

Reimplemented in TDACChemistryModel< ReactionThermo, ThermoType >, and TDACChemistryModel< CompType, ThermoType >.

Definition at line 563 of file StandardChemistryModel.C.

◆ solve() [2/4]

Foam::scalar solve ( const scalarField deltaT)
virtual

Solve the reaction system for the given time step.

and return the characteristic time

Implements basicChemistryModel.

Reimplemented in TDACChemistryModel< ReactionThermo, ThermoType >, and TDACChemistryModel< CompType, ThermoType >.

Definition at line 578 of file StandardChemistryModel.C.

◆ tc()

Foam::tmp< Foam::volScalarField > tc ( ) const
virtual

Return the chemical time scale.

Implements basicChemistryModel.

Definition at line 285 of file StandardChemistryModel.C.

◆ Qdot()

Foam::tmp< Foam::volScalarField > Qdot ( ) const
virtual

Return the heat release rate [kg/m/s^3].

Implements basicChemistryModel.

Definition at line 351 of file StandardChemistryModel.C.

◆ nEqns()

Foam::label nEqns ( ) const
inlinevirtual

Number of ODE's to solve.

Implements ODESystem.

Definition at line 33 of file StandardChemistryModelI.H.

◆ derivatives()

void derivatives ( const scalar  x,
const scalarField y,
const label  li,
scalarField dydx 
) const
virtual

Calculate the derivatives in dydx.

for the current state x and y and optional index into the list of systems to solve li

Implements ODESystem.

Reimplemented in TDACChemistryModel< ReactionThermo, ThermoType >, and TDACChemistryModel< CompType, ThermoType >.

Definition at line 155 of file StandardChemistryModel.C.

Referenced by StandardChemistryModel< CompType, ThermoType >::omegaI().

Here is the caller graph for this function:

◆ jacobian()

void jacobian ( const scalar  x,
const scalarField y,
const label  li,
scalarField dfdx,
scalarSquareMatrix dfdy 
) const
virtual

Calculate the Jacobian of the system.

for the current state x and y and optional index into the list of systems to solve li. Need by stiff-system solvers

Implements ODESystem.

Reimplemented in TDACChemistryModel< ReactionThermo, ThermoType >, and TDACChemistryModel< CompType, ThermoType >.

Definition at line 206 of file StandardChemistryModel.C.

Referenced by StandardChemistryModel< CompType, ThermoType >::derivatives().

Here is the caller graph for this function:

◆ solve() [3/4]

virtual void solve ( scalar &  p,
scalar &  T,
scalarField c,
const label  li,
scalar &  deltaT,
scalar &  subDeltaT 
) const
pure virtual

◆ operator=()

void operator= ( const StandardChemistryModel< ReactionThermo, ThermoType > &  )
delete

Disallow default bitwise assignment.

◆ solve() [4/4]

Foam::scalar solve ( const DeltaTType &  deltaT)

Definition at line 490 of file StandardChemistryModel.C.

Member Data Documentation

◆ Y_

const PtrList<volScalarField>& Y_
protected

Reference to the field of specie mass fractions.

Definition at line 79 of file StandardChemistryModel.H.

◆ specieThermos_

const PtrList<ThermoType>& specieThermos_
protected

Thermodynamic data of the species.

Definition at line 82 of file StandardChemistryModel.H.

◆ reactions_

const ReactionList<ThermoType> reactions_
protected

Reactions.

Definition at line 85 of file StandardChemistryModel.H.

◆ nSpecie_

label nSpecie_
protected

Number of species.

Definition at line 88 of file StandardChemistryModel.H.

◆ nReaction_

label nReaction_
protected

Number of reactions.

Definition at line 91 of file StandardChemistryModel.H.

◆ Treact_

scalar Treact_
protected

Temperature below which the reaction rates are assumed 0.

Definition at line 94 of file StandardChemistryModel.H.

◆ RR_

List of reaction rate per specie [kg/m^3/s].

Definition at line 97 of file StandardChemistryModel.H.

◆ c_

scalarField c_
mutableprotected

Temporary concentration field.

Definition at line 100 of file StandardChemistryModel.H.

◆ dcdt_

scalarField dcdt_
mutableprotected

Temporary rate-of-change of concentration field.

Definition at line 103 of file StandardChemistryModel.H.


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