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

[legend]

Collaboration diagram for StandardChemistryModel< ReactionThermo, ThermoType >:

[legend]

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

	StandardChemistryModel (ReactionThermo &thermo)
	Construct from thermo. More...

virtual	~StandardChemistryModel ()
	Destructor. More...

const PtrList< Reaction< ThermoType > > &	reactions () const
	The reactions. More...

const PtrList< ThermoType > &	specieThermo () 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 scalarField &c, const scalar T, const scalar p, scalarField &dcdt) const
	dc/dt = omega, rate of change in concentration, for each species More...

virtual scalar	omega (const Reaction< ThermoType > &r, const scalarField &c, const scalar T, const scalar p, scalar &pf, scalar &cf, label &lRef, scalar &pr, scalar &cr, label &rRef) const
	Return the reaction rate for reaction r and the reference. More...

virtual scalar	omegaI (label iReaction, const scalarField &c, const scalar T, const scalar p, 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::Internal &	RR (const label i) const
	Return const access to the chemical source terms for specie, i. More...

virtual volScalarField::Internal &	RR (const label i)
	Return non const access to chemical source terms [kg/m3/s]. More...

virtual tmp< volScalarField::Internal >	calculateRR (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< volScalarField >	tc () const
	Return the chemical time scale. More...

virtual tmp< volScalarField >	Qdot () const
	Return the heat release rate [kg/m/s3]. More...

virtual label	nEqns () const
	Number of ODE's to solve. More...

virtual void	derivatives (const scalar t, const scalarField &c, scalarField &dcdt) const
	Calculate the derivatives in dydx. More...

virtual void	jacobian (const scalar t, const scalarField &c, scalarField &dcdt, scalarSquareMatrix &dfdc) const
	Calculate the Jacobian of the system. More...

virtual void	solve (scalarField &c, scalar &T, scalar &p, scalar &deltaT, scalar &subDeltaT) const =0

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,(ReactionThermo &thermo),(thermo))
	Declare run-time constructor selection tables. More...

	BasicChemistryModel (ReactionThermo &thermo)
	Construct from thermo. More...

virtual	~BasicChemistryModel ()
	Destructor. More...

ReactionThermo &	thermo ()
	Return access to the thermo package. 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 (basicThermo &thermo)
	Construct from thermo. More...

virtual	~basicChemistryModel ()
	Destructor. More...

const fvMesh &	mesh () const
	Return const access to the mesh database. More...

Switch	chemistry () const
	Chemistry activation switch. More...

const volScalarField::Internal &	deltaTChem () const
	Return the latest estimation of integration step. More...

template<class ChemistryModel >
Foam::autoPtr< ChemistryModel >	New (typename ChemistryModel::reactionThermo &thermo)

Public Member Functions inherited from IOdictionary
	IOdictionary (const IOobject &io, const dictionary *fallback=nullptr)

	IOdictionary (const IOobject &io, const dictionary &dict)

	IOdictionary (const IOobject &io, const word &wantedType, const dictionary *fallback=nullptr)

	IOdictionary (const IOobject &io, Istream &is)
	Construct given an IOobject and Istream. More...

virtual	~IOdictionary ()=default
	Destructor. More...

virtual bool	global () const
	Is object global. More...

virtual fileName	filePath () const
	Return complete path + object name if the file exists. More...

Public Member Functions inherited from baseIOdictionary
	TypeName ("dictionary")
	Declare type-name, virtual type (with debug switch) More...

	baseIOdictionary (const baseIOdictionary &)=default
	Copy construct. More...

	baseIOdictionary (baseIOdictionary &&)=default
	Move construct. More...

virtual	~baseIOdictionary ()=default
	Destructor. More...

	baseIOdictionary (const IOobject &io, const dictionary *fallback=nullptr)

	baseIOdictionary (const IOobject &io, const dictionary &dict)

	baseIOdictionary (const IOobject &io, Istream &is)
	Construct given an IOobject and Istream (ununsed) More...

const word &	name () const

virtual bool	readData (Istream &)
	The readData function required by regIOobject read operation. More...

virtual bool	writeData (Ostream &) const
	The writeData function required by regIOobject write operation. More...

void	operator= (const baseIOdictionary &rhs)
	Copy assignment of dictionary entries (leave regIOobject untouched) More...

void	operator= (const dictionary &rhs)
	Copy assignment of dictionary entries. More...

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")
	Runtime type information. More...

	regIOobject (const IOobject &io, const bool isTimeObject=false)

	regIOobject (const regIOobject &rio)
	Copy construct. More...

	regIOobject (const regIOobject &rio, bool registerCopy)

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)

	regIOobject (const IOobject &io, const regIOobject &rio)
	Copy construct with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

bool	checkIn ()
	Add object to registry, if not already registered. More...

bool	checkOut ()
	Remove all file watches and 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...

bool	store ()

void	release (const bool unregister=false)
	Release ownership of this object from its registry. More...

label	eventNo () const
	Event number at last update. More...

label &	eventNo ()
	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 as up-to-date. More...

virtual void	rename (const word &newName)
	Rename. More...

const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data or nullptr. More...

dictionary &	getMetaData () noexcept
	Get or create meta-data. More...

void	removeMetaData ()
	Remove meta-data. More...

virtual void	updateMetaData ()
	Update internal meta-data (eg, prior to writing) More...

bool	headerOk ()
	Read and check header info. More...

Istream &	readStream (const word &, const bool valid=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. More...

const labelList &	watchIndices () const
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	Return file-monitoring handles. More...

virtual bool	modified () const

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const
	Write using stream options. More...

virtual bool	write (const bool valid=true) const
	Write using setting from DB. More...

void	operator= (const IOobject &io)
	Copy assignment. More...

virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const
	Write using given format, version and compression. More...

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Declare type-name, virtual type (with debug switch) More...

	IOobject (const IOobject &)=default
	Copy construct. More...

virtual	~IOobject ()=default
	Destructor. More...

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
	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, bool globalObject=false)
	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, bool globalObject=false)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Copy construct, resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name. More...

	IOobject (const IOobject &io, readOption, writeOption)
	Copy construct, resetting io options. More...

autoPtr< IOobject >	clone () const
	Clone. More...

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

const objectRegistry &	db () const noexcept
	Return the local objectRegistry. More...

const Time &	time () const
	Return Time associated with the objectRegistry. More...

const word &	name () const noexcept
	Return name. More...

const word &	headerClassName () const noexcept
	Return name of the class name read from header. More...

word &	headerClassName () noexcept
	Return non-constant access to the class name read from header. More...

const string &	note () const noexcept
	Return the optional note. More...

string &	note () noexcept
	Return non-constant access to the optional note. More...

bool	registerObject () const noexcept
	Should object created with this IOobject be registered? More...

bool	registerObject (bool on) noexcept
	Change registration preference, return previous value. More...

bool	globalObject () const noexcept
	Is object same for all processors? More...

bool	globalObject (bool on) noexcept
	Change global-object status, return previous value. More...

unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes, possibly read from the header. More...

unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes, possibly read from the header. More...

bool	isHeaderClassName (const word &clsName) const
	Test if headerClassName() equals the given class name. More...

template<class Type >
bool	isHeaderClassName () const
	Test if headerClassName() equals Type::typeName. More...

readOption	readOpt () const noexcept
	The read option. More...

readOption	readOpt (readOption opt) noexcept
	Change the read option, return previous value. More...

writeOption	writeOpt () const noexcept
	The write option. More...

writeOption	writeOpt (writeOption opt) noexcept
	Change the write option, return previous value. More...

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const noexcept

fileName &	instance () noexcept

const fileName &	local () const noexcept

fileName	path () const
	The complete path. More...

fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local. More...

fileName	objectPath () const
	The complete path + object name. More...

fileName	objectRelPath () const
	The object path relative to the root. More...

fileName	localFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches locally. More...

fileName	globalFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches up if in parallel. More...

IOstreamOption	parseHeader (const dictionary &headerDict)

bool	readHeader (Istream &is)

bool	readHeader (dictionary &headerDict, Istream &is)

template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
	Read header (uses typeFilePath to find file) and check its info. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...

bool	writeHeader (Ostream &os) const
	Write header with current type() More...

bool	writeHeader (Ostream &os, const word &objectType) const
	Write header with override of type. More...

void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const

void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const

bool	good () const noexcept

bool	bad () const noexcept

InfoProxy< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &io)

readOption &	readOpt () noexcept
	Access to the read option. More...

writeOption &	writeOpt () noexcept
	Access to the write option. More...

bool &	registerObject () noexcept
	Access to the register object option. More...

bool &	globalObject () noexcept
	Access to the global object option. More...

template<>
bool	isHeaderClassName () const
	Specialization for `void` always returns true (no headerClassName check). More...

template<class StringType >
Foam::word	groupName (StringType base, const word &group)

Public Member Functions inherited from dictionary
	ClassName ("dictionary")

	dictionary ()
	Default construct, a top-level empty dictionary. More...

	dictionary (const fileName &name)
	Construct top-level empty dictionary with given name. More...

	dictionary (const fileName &name, const dictionary &parentDict, Istream &is, bool keepHeader=false)

	dictionary (Istream &is)

	dictionary (Istream &is, bool keepHeader)

	dictionary (const dictionary &parentDict, const dictionary &dict)
	Copy construct given the parent dictionary. More...

	dictionary (const dictionary &dict)
	Copy construct top-level dictionary. More...

	dictionary (const dictionary *dict)
	Construct top-level dictionary as copy from pointer to dictionary. More...

	dictionary (const dictionary &parentDict, dictionary &&dict)
	Move construct for given parent dictionary. More...

	dictionary (dictionary &&dict)
	Move construct top-level dictionary. More...

autoPtr< dictionary >	clone () const
	Construct and return clone. More...

virtual	~dictionary ()
	Destructor. More...

const fileName &	name () const noexcept
	The dictionary name. More...

fileName &	name () noexcept
	The dictionary name for modification (use with caution). More...

word	dictName () const
	The local dictionary name (final part of scoped name) More...

fileName	relativeName (const bool caseTag=false) const
	The dictionary name relative to the case. More...

bool	isNullDict () const noexcept
	The dictionary is actually dictionary::null (root dictionary) More...

const dictionary &	parent () const noexcept
	Return the parent dictionary. More...

const dictionary &	topDict () 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 &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Search for an entry (const access) with the given keyword. More...

entry *	findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find for an entry (non-const access) with the given keyword. More...

const entry *	findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find an entry (const access) with the given keyword. More...

const entry *	findScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Search for a scoped entry (const access) with the given keyword. More...

dictionary *	findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary pointer if present. More...

const dictionary *	findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary pointer if present. More...

const entry &	lookupEntry (const word &keyword, enum keyType::option matchOpt) const
	Search for an entry (const access) with the given keyword. More...

ITstream &	lookup (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const

template<class T >
T	get (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const

template<class T >
T	getOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const

template<class T >
T	getOrAdd (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)

template<class T >
bool	readEntry (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const

template<class T >
bool	readIfPresent (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const

template<class T , class Predicate >
T	getCheck (const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const

template<class T , class Predicate >
T	getCheckOrDefault (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const

template<class T , class Predicate >
T	getCheckOrAdd (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX)

template<class T , class Predicate >
bool	readCheck (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const

template<class T , class Predicate >
bool	readCheckIfPresent (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const

bool	isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Check if entry is found and is a sub-dictionary. More...

const dictionary &	subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary. More...

dictionary &	subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary for manipulation. More...

dictionary &	subDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary for manipulation. More...

dictionary	subOrEmptyDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX, const bool mandatory=false) const

const dictionary &	optionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary, otherwise return this dictionary. More...

wordList	toc () const
	Return the table of contents. More...

wordList	sortedToc () const
	Return the sorted table of contents. More...

template<class Compare >
wordList	sortedToc (const Compare &comp) const
	Return table of contents sorted using the specified comparator. More...

List< keyType >	keys (bool patterns=false) const
	Return the list of available keys or patterns. More...

bool	substituteKeyword (const word &keyword, bool mergeEntry=false)
	Substitute the given keyword (which is prefixed by '$') More...

bool	substituteScopedKeyword (const word &keyword, bool mergeEntry=false)
	Substitute the given scoped keyword (which is prefixed by '$') More...

entry *	add (entry *entryPtr, bool mergeEntry=false)
	Add a new entry. More...

entry *	add (const entry &e, bool mergeEntry=false)
	Add an entry. More...

entry *	add (const keyType &k, const word &v, bool overwrite=false)
	Add a word entry. More...

entry *	add (const keyType &k, const string &v, bool overwrite=false)
	Add a string entry. More...

entry *	add (const keyType &k, const label v, bool overwrite=false)
	Add a label entry. More...

entry *	add (const keyType &k, const scalar v, bool overwrite=false)
	Add a scalar entry. More...

entry *	add (const keyType &k, const dictionary &d, bool mergeEntry=false)
	Add a dictionary entry. More...

template<class T >
entry *	add (const keyType &k, const T &v, bool overwrite=false)
	Add a T entry. More...

entry *	set (entry *entryPtr)
	Assign a new entry, overwriting any existing entry. More...

entry *	set (const entry &e)
	Assign a new entry, overwriting any existing entry. More...

entry *	set (const keyType &k, const dictionary &v)
	Assign a dictionary entry, overwriting any existing entry. More...

template<class T >
entry *	set (const keyType &k, const T &v)
	Assign a T entry, overwriting any existing entry. More...

bool	remove (const word &keyword)
	Remove an entry specified by keyword. More...

bool	changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false)
	Change the keyword for an entry,. More...

bool	merge (const dictionary &dict)
	Merge entries from the given dictionary. More...

void	clear ()
	Clear the dictionary. More...

void	transfer (dictionary &dict)
	Transfer the contents of the argument and annul the argument. More...

void	checkITstream (const ITstream &is, const word &keyword) const

bool	read (Istream &is)
	Read dictionary from Istream. Discards the header. More...

bool	read (Istream &is, bool keepHeader)
	Read dictionary from Istream, optionally keeping the header. More...

void	writeEntry (Ostream &os) const
	Write sub-dictionary with its dictName as its header. More...

void	writeEntry (const keyType &keyword, Ostream &os) const
	Write sub-dictionary with the keyword as its header. More...

void	writeEntries (Ostream &os, const bool extraNewLine=false) const
	Write dictionary entries. More...

void	write (Ostream &os, const bool subDict=true) const
	Write dictionary, normally with sub-dictionary formatting. More...

const_searcher	csearch (const word &keyword, enum keyType::option=keyType::REGEX) const
	Search dictionary for given keyword. More...

const_searcher	search (const word &keyword, enum keyType::option=keyType::REGEX) const
	Search dictionary for given keyword. More...

searcher	search (const word &keyword, enum keyType::option=keyType::REGEX)
	Search dictionary for given keyword. More...

const_searcher	csearchScoped (const word &keyword, enum keyType::option) const
	Search using scoping. More...

const_searcher	searchScoped (const word &keyword, enum keyType::option) const
	Search using dot or slash scoping. More...

searcher	searchScoped (const word &keyword, enum keyType::option)
	Search using dot or slash scoping. More...

const dictionary *	cfindScopedDict (const fileName &dictPath) const
	Locate a sub-dictionary using slash-scoping. More...

const dictionary *	findScopedDict (const fileName &dictPath) const
	Locate a sub-dictionary using slash-scoping. More...

dictionary *	findScopedDict (const fileName &dictPath)
	Locate a sub-dictionary using slash-scoping. More...

dictionary *	makeScopedDict (const fileName &dictPath)
	Locate existing or create sub-dictionary using slash-scoping. More...

const_searcher	csearchCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
	Search dictionary for given keyword and any compatibility names. More...

bool	foundCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
	Search dictionary for given keyword and any compatibility names. More...

const entry *	findCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const

const entry &	lookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const

ITstream &	lookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const

template<class T >
T	getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const

template<class T >
T	getOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option=keyType::REGEX) const

template<class T >
bool	readCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX, bool mandatory=true) const

template<class T >
bool	readIfPresentCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX) const

void	operator= (const dictionary &rhs)
	Copy assignment. More...

void	operator+= (const dictionary &rhs)
	Include entries from the given dictionary. More...

void	operator\|= (const dictionary &rhs)
	Conditionally include entries from the given dictionary. More...

void	operator<<= (const dictionary &rhs)
	Unconditionally include entries from the given dictionary. More...

template<class T >
T	lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const

template<class T >
T	lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)

template<class T >
T	lookupOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const

ITstream &	operator[] (const word &keyword) const
	Deprecated(2018-07) find and return an entry data stream. More...

bool	found (const word &keyword, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...

entry *	lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch)
	Deprecated(2018-10) More...

const entry *	lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10) More...

const entry *	lookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10) More...

const dictionary *	subDictPtr (const word &keyword) const
	Deprecated(2018-10) More...

dictionary *	subDictPtr (const word &keyword)

const entry &	lookupEntry (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10) More...

ITstream &	lookup (const word &keyword, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...

template<class T >
T	lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...

template<class T >
T	lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true)
	Deprecated(2018-10) More...

template<class T >
bool	readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...

template<class T >
T	lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const
	Deprecated(2018-10) find and return a T. More...

bool	getBool (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< bool >(const word&, keyType::option) More...

label	getLabel (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< label >(const word&, keyType::option) More...

scalar	getScalar (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< scalar >(const word&, keyType::option) More...

string	getString (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< string >(const word&, keyType::option) More...

word	getWord (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< word >(const word&, keyType::option) More...

fileName	getFileName (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< fileName >(const word&, keyType::option) More...

template<class Compare >
Foam::wordList	sortedToc (const Compare &comp) const

template<class T >
Foam::entry *	add (const keyType &k, const T &v, bool overwrite)

template<class T >
Foam::entry *	set (const keyType &k, const T &v)

Public Member Functions inherited from ILList< LListBase, T >
	ILList ()=default
	Default construct. More...

	ILList (T *item)
	Construct and insert the initial T item pointer. More...

	ILList (Istream &is)
	Construct from Istream. More...

	ILList (const ILList< LListBase, T > &lst)
	Copy construct using the 'clone()' method for each element. More...

	ILList (ILList< LListBase, T > &&lst)
	Move construct. More...

template<class CloneArg >
	ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
	Copy constructor with additional argument for clone 'clone()'. More...

template<class INew >
	ILList (Istream &is, const INew &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 *item)
	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 > &lst)

void	operator= (const ILList< LListBase, T > &lst)
	Copy assignment using the 'clone()' method for each element. More...

void	operator= (ILList< LListBase, T > &&lst)
	Move assignment. More...

Public Member Functions inherited from ODESystem
	ODESystem ()
	Construct null. More...

virtual	~ODESystem ()=default
	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::Internal &	deltaTChem ()
	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 IOstreamOption::streamFormat fmt, const word &typeName)
	Helper: check readOpt flags and read if necessary. More...

Protected Member Functions inherited from IOobject
void	setBad (const string &s)
	Set the object state to bad. More...

Protected Attributes
PtrList< volScalarField > &	Y_
	Reference to the field of specie mass fractions. More...

const PtrList< Reaction< ThermoType > > &	reactions_
	Reactions. More...

const PtrList< ThermoType > &	specieThermo_
	Thermodynamic data of the species. 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::Internal >	RR_
	List of reaction rate per specie [kg/m3/s]. More...

scalarField	c_
	Temporary concentration field. More...

scalarField	dcdt_
	Temporary rate-of-change of concentration field. More...

Protected Attributes inherited from BasicChemistryModel< ReactionThermo >
ReactionThermo &	thermo_
	Thermo. More...

Protected Attributes inherited from basicChemistryModel
const fvMesh &	mesh_
	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 : char { GOOD, BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
	Enumeration defining the read options. More...

enum	writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }
	Enumeration defining the write options. More...

enum	fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Enumeration defining the file checking options. More...

Public Types inherited from dictionary
typedef Searcher< true >	const_searcher
	Searcher with const access. More...

typedef Searcher< false >	searcher
	Searcher with non-const access. More...

Static Public Member Functions inherited from BasicChemistryModel< ReactionThermo >
static autoPtr< BasicChemistryModel< ReactionThermo > >	New (ReactionThermo &thermo)
	Selector. More...

Static Public Member Functions inherited from basicChemistryModel
template<class ChemistryModel >
static autoPtr< ChemistryModel >	New (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 *p)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept
	Status of output file banner. More...

static bool	bannerEnabled (bool on) noexcept
	Enable/disable an output file banner. More...

static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class StringType >
static word	groupName (StringType base, const word &group)
	Create dot-delimited name.group string. More...

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

static word	scopedName (const std::string &scope, const word &name)
	Create scope:name or scope_name string. More...

static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name. More...

static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider. More...

static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider. More...

Static Public Member Functions inherited from dictionary
static int	reportOptional () noexcept
	Return the state of reporting optional (default) entries. More...

static int	reportOptional (const int level) noexcept
	Change the state of reporting optional (default) entries. More...

static autoPtr< dictionary >	New (Istream &is)
	Construct top-level dictionary on freestore from Istream. More...

Public Attributes inherited from dictionary
friend	const_searcher
	Declare friendship with the searcher classes. More...

friend	searcher

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes. More...

static char	scopeSeparator
	Character for scoping object names (':' or '_') More...

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

static float	fileModificationSkew
	Time skew (seconds) for file modification checks. More...

static int	maxFileModificationPolls
	Max number of times to poll for file modification changes. More...

Static Public Attributes inherited from dictionary
static int	writeOptionalEntries
	Report optional keywords and values if not present in dictionary. More...

static const dictionary	null
	An empty dictionary, which is also the parent for all dictionaries. More...

static refPtr< OSstream >	reportingOutput
	Output location when reporting default values. More...

Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)

static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects. 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 61 of file StandardChemistryModel.H.

Member Typedef Documentation

◆ thermoType

typedef ThermoType thermoType

protected

Definition at line 88 of file StandardChemistryModel.H.

Constructor & Destructor Documentation

◆ StandardChemistryModel()

StandardChemistryModel ( ReactionThermo & thermo )

Construct from thermo.

Definition at line 38 of file StandardChemistryModel.C.

References Foam::dimMass, Foam::dimTime, Foam::dimVolume, Foam::endl(), forAll, Foam::Info, mesh, Foam::name(), timeName, and Foam::Zero.

Here is the call graph for this function:

◆ ~StandardChemistryModel()

~StandardChemistryModel ( )

virtual

Destructor.

Definition at line 100 of file StandardChemistryModel.C.

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 44 of file StandardChemistryModelI.H.

◆ TypeName()

TypeName ( "standard" )

Runtime type information.

◆ reactions()

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

inline

The reactions.

Definition at line 52 of file StandardChemistryModelI.H.

◆ specieThermo()

const Foam::PtrList< ThermoType > & specieThermo ( ) const

inline

Thermodynamic data of the species.

Definition at line 60 of file StandardChemistryModelI.H.

◆ nSpecie()

Foam::label nSpecie ( ) const

inlinevirtual

The number of species.

Implements basicChemistryModel.

Definition at line 68 of file StandardChemistryModelI.H.

◆ nReaction()

Foam::label nReaction ( ) const

inlinevirtual

The number of reactions.

Implements basicChemistryModel.

Definition at line 76 of file StandardChemistryModelI.H.

◆ Treact() [1/2]

Foam::scalar Treact ( ) const

inline

Temperature below which the reaction rates are assumed 0.

Definition at line 84 of file StandardChemistryModelI.H.

◆ Treact() [2/2]

Foam::scalar & Treact ( )

inline

Temperature below which the reaction rates are assumed 0.

Definition at line 92 of file StandardChemistryModelI.H.

◆ omega() [1/2]

void omega	(	const scalarField &	c,
		const scalar	T,
		const scalar	p,
		scalarField &	dcdt
	)		const

virtual

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

Definition at line 108 of file StandardChemistryModel.C.

References Foam::constant::universal::c, forAll, p, R, s, T, and Foam::Zero.

◆ omega() [2/2]

Foam::scalar omega	(	const Reaction< ThermoType > &	r,
		const scalarField &	c,
		const scalar	T,
		const scalar	p,
		scalar &	pf,
		scalar &	cf,
		label &	lRef,
		scalar &	pr,
		scalar &	cr,
		label &	rRef
	)		const

virtual

Return the reaction rate for reaction r and the reference.

species and characteristic times

Definition at line 169 of file StandardChemistryModel.C.

References Foam::constant::universal::c, Foam::exp(), Foam::max(), p, Foam::pow(), R, s, and T.

Here is the call graph for this function:

◆ omegaI()

Foam::scalar omegaI	(	label	iReaction,
		const scalarField &	c,
		const scalar	T,
		const scalar	p,
		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 148 of file StandardChemistryModel.C.

References Foam::constant::universal::c, p, R, and T.

◆ calculate()

void calculate ( )

virtual

Calculates the reaction rates.

Implements basicChemistryModel.

Definition at line 653 of file StandardChemistryModel.C.

References forAll, p, Foam::constant::mathematical::pi(), rho, T, thermo, and trho.

Here is the call graph for this function:

◆ 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 101 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/m3/s].

Implements basicChemistryModel.

Definition at line 111 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 586 of file StandardChemistryModel.C.

References Foam::dimMass, Foam::dimTime, Foam::dimVolume, forAll, mesh, p, Foam::constant::mathematical::pi(), tmp< T >::ref(), rho, Foam::constant::thermodynamic::RR, T, thermo, timeName, trho, and Foam::Zero.

Here is the call 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.

Definition at line 764 of file StandardChemistryModel.C.

References Foam::min(), and solve().

Here is the call graph for this function:

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

Definition at line 779 of file StandardChemistryModel.C.

◆ tc()

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

virtual

Return the chemical time scale.

Implements basicChemistryModel.

Definition at line 471 of file StandardChemistryModel.C.

References Foam::dimTime, forAll, mesh, p, Foam::constant::mathematical::pi(), R, tmp< T >::ref(), rho, s, T, thermo, timeName, and trho.

Here is the call graph for this function:

◆ Qdot()

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

virtual

Return the heat release rate [kg/m/s3].

Implements basicChemistryModel.

Definition at line 545 of file StandardChemistryModel.C.

References Foam::dimEnergy, Foam::dimTime, Foam::dimVolume, forAll, Qdot, tmp< T >::ref(), and Foam::Zero.

Here is the call graph for this function:

◆ nEqns()

Foam::label nEqns ( ) const

inlinevirtual

Number of ODE's to solve.

Implements ODESystem.

Definition at line 35 of file StandardChemistryModelI.H.

◆ derivatives()

void derivatives	(	const scalar	x,
		const scalarField &	y,
		scalarField &	dydx
	)		const

virtual

Calculate the derivatives in dydx.

Implements ODESystem.

Definition at line 281 of file StandardChemistryModel.C.

References Foam::constant::universal::c, cp, forAll, Foam::max(), p, rho, and T.

Here is the call graph for this function:

◆ jacobian()

void jacobian	(	const scalar	x,
		const scalarField &	y,
		scalarField &	dfdx,
		scalarSquareMatrix &	dfdy
	)		const

virtual

Calculate the Jacobian of the system.

Need by the stiff-system solvers

Implements ODESystem.

Definition at line 329 of file StandardChemistryModel.C.

References Foam::constant::universal::c, delta, forAll, Foam::max(), p, Foam::pow(), R, T, and Foam::Zero.

Here is the call graph for this function:

◆ solve() [3/4]

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

pure virtual

◆ solve() [4/4]

Foam::scalar solve ( const DeltaTType & deltaT )

Definition at line 691 of file StandardChemistryModel.C.

References correct(), forAll, Foam::min(), p, Foam::constant::mathematical::pi(), rho, solve(), T, thermo, and trho.

Here is the call graph for this function:

Member Data Documentation

◆ Y_

PtrList<volScalarField>& Y_

protected

Reference to the field of specie mass fractions.

Definition at line 94 of file StandardChemistryModel.H.

◆ reactions_

const PtrList<Reaction<ThermoType> >& reactions_

protected

Reactions.

Definition at line 97 of file StandardChemistryModel.H.

◆ specieThermo_

const PtrList<ThermoType>& specieThermo_

protected

Thermodynamic data of the species.

Definition at line 100 of file StandardChemistryModel.H.

◆ nSpecie_

label nSpecie_

protected

Number of species.

Definition at line 103 of file StandardChemistryModel.H.

◆ nReaction_

label nReaction_

protected

Number of reactions.

Definition at line 106 of file StandardChemistryModel.H.

◆ Treact_

scalar Treact_

protected

Temperature below which the reaction rates are assumed 0.

Definition at line 109 of file StandardChemistryModel.H.

◆ RR_

PtrList<volScalarField::Internal> RR_

protected

List of reaction rate per specie [kg/m3/s].

Definition at line 112 of file StandardChemistryModel.H.

◆ c_

scalarField c_

mutableprotected

Temporary concentration field.

Definition at line 115 of file StandardChemistryModel.H.

◆ dcdt_

scalarField dcdt_

mutableprotected

Temporary rate-of-change of concentration field.

Definition at line 118 of file StandardChemistryModel.H.

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

src/thermophysicalModels/chemistryModel/chemistryModel/StandardChemistryModel/StandardChemistryModel.H
src/thermophysicalModels/chemistryModel/chemistryModel/StandardChemistryModel/StandardChemistryModel.C
src/thermophysicalModels/chemistryModel/chemistryModel/StandardChemistryModel/StandardChemistryModelI.H

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ thermoType

Constructor & Destructor Documentation

◆ StandardChemistryModel()

◆ ~StandardChemistryModel()

Member Function Documentation

◆ RR() [1/3]

◆ TypeName()

◆ reactions()

◆ specieThermo()

◆ nSpecie()

◆ nReaction()

◆ Treact() [1/2]

◆ Treact() [2/2]

◆ omega() [1/2]

◆ omega() [2/2]

◆ omegaI()

◆ calculate()

◆ RR() [2/3]

◆ RR() [3/3]

◆ calculateRR()

◆ solve() [1/4]

◆ solve() [2/4]

◆ tc()

◆ Qdot()

◆ nEqns()

◆ derivatives()

◆ jacobian()

◆ solve() [3/4]

◆ solve() [4/4]

Member Data Documentation

◆ Y_

◆ reactions_

◆ specieThermo_

◆ nSpecie_

◆ nReaction_

◆ Treact_

◆ RR_

◆ c_

◆ dcdt_

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