Public Member Functions | |
TypeName ("psiCombustionModel") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, psiCombustionModel, dictionary,(const word &modelType, const fvMesh &mesh, const word &phaseName),(modelType, mesh, phaseName)) | |
Declare run-time constructor selection tables. More... | |
psiCombustionModel (const word &modelType, const fvMesh &mesh, const word &phaseName) | |
Construct from components. More... | |
virtual | ~psiCombustionModel () |
Destructor. More... | |
virtual psiReactionThermo & | thermo ()=0 |
Return access to the thermo package. More... | |
virtual const psiReactionThermo & | thermo () const =0 |
Return const access to the thermo package. More... | |
virtual tmp< volScalarField > | rho () const =0 |
Return tmp of rho. More... | |
virtual bool | read () |
Update properties from given dictionary. More... | |
Public Member Functions inherited from combustionModel | |
TypeName ("combustionModel") | |
Runtime type information. More... | |
combustionModel (const word &modelType, const fvMesh &mesh, const word &phaseName=word::null) | |
Construct from components. More... | |
virtual | ~combustionModel () |
Destructor. More... | |
const fvMesh & | mesh () const |
Return const access to the mesh database. More... | |
const surfaceScalarField & | phi () const |
Return const access to phi. More... | |
const compressibleTurbulenceModel & | turbulence () const |
Return access to turbulence. More... | |
void | setTurbulence (compressibleTurbulenceModel &turbModel) |
Set turbulence. More... | |
const Switch & | active () const |
Is combustion active? More... | |
const dictionary & | coeffs () const |
Return const dictionary of the model. More... | |
virtual void | correct ()=0 |
Correct combustion rate. More... | |
virtual tmp< fvScalarMatrix > | R (volScalarField &Y) const =0 |
Fuel consumption rate matrix, i.e. source term for fuel equation. More... | |
virtual tmp< volScalarField > | dQ () const =0 |
Heat release rate calculated from fuel consumption rate matrix. More... | |
virtual tmp< volScalarField > | Sh () const |
Return source for enthalpy equation [kg/m/s3]. More... | |
Public Member Functions inherited from IOdictionary | |
TypeName ("dictionary") | |
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... | |
virtual | ~IOdictionary () |
Destructor. More... | |
const word & | name () const |
Name function is needed to disambiguate those inherited. More... | |
bool | readData (Istream &) |
ReadData function required for regIOobject read operation. More... | |
bool | writeData (Ostream &) const |
WriteData function required for regIOobject write operation. More... | |
void | operator= (const IOdictionary &) |
Assignment of other IOdictionary's entries to this IOdictionary. 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 &) | |
Construct as copy. More... | |
regIOobject (const regIOobject &, bool registerCopy) | |
Construct as copy, transferring registry registration to copy. More... | |
regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
Construct as copy with new name, transfering registry registration. More... | |
regIOobject (const IOobject &, const regIOobject &) | |
Construct as copy with new IO parameters. More... | |
virtual | ~regIOobject () |
Destructor. More... | |
bool | checkIn () |
Add object to registry. More... | |
bool | checkOut () |
Remove object from registry. 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... | |
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 up to date (obviously) More... | |
virtual void | rename (const word &newName) |
Rename. More... | |
Istream & | readStream (const word &) |
Return Istream and check object type against that given. More... | |
void | close () |
Close Istream. More... | |
label | watchIndex () const |
Return file-monitoring handle. More... | |
label & | watchIndex () |
Return file-monitoring handle. 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 |
Write using given format, version and compression. More... | |
virtual bool | write () 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 ®istry, 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 ®istry, 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 ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
Construct from path, registry, io options. More... | |
Foam::autoPtr< IOobject > | clone () const |
Clone. More... | |
virtual | ~IOobject () |
Destructor. More... | |
const Time & | time () const |
Return time. More... | |
const objectRegistry & | db () const |
Return the local objectRegistry. More... | |
const word & | name () const |
Return name. More... | |
const word & | headerClassName () const |
Return name of the class name read from header. More... | |
string & | note () |
Return non-constant access to the optional note. More... | |
const string & | note () 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 |
readOption & | readOpt () |
writeOption | writeOpt () const |
writeOption & | writeOpt () |
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 |
fileName & | instance () |
const fileName & | local () 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 | objectPath () const |
Return complete path + object name. More... | |
fileName | filePath () const |
Return complete path + object name if the file exists. More... | |
bool | readHeader (Istream &) |
Read header. More... | |
bool | headerOk () |
Read and check header info. 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< IOobject > | info () const |
Return info proxy. More... | |
void | operator= (const IOobject &) |
template<class Name > | |
Foam::word | groupName (Name name, const word &group) |
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 &) | |
Construct top-level dictionary from Istream,. More... | |
dictionary (Istream &, const bool keepHeader) | |
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, const Xfer< dictionary > &) | |
Construct by transferring parameter contents given parent dictionary. More... | |
dictionary (const Xfer< dictionary > &) | |
Construct top-level dictionary by transferring parameter contents. More... | |
autoPtr< dictionary > | clone () const |
Construct and return clone. More... | |
virtual | ~dictionary () |
Destructor. More... | |
const dictionary & | parent () const |
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 &, bool recursive=false, bool patternMatch=true) const |
Search dictionary for given keyword. More... | |
const entry * | lookupEntryPtr (const word &, bool recursive, bool patternMatch) const |
Find and return an entry data stream pointer if present. More... | |
entry * | lookupEntryPtr (const word &, bool recursive, bool patternMatch) |
Find and return an entry data stream pointer for manipulation. More... | |
const entry & | lookupEntry (const word &, bool recursive, bool patternMatch) const |
Find and return an entry data stream if present otherwise error. More... | |
ITstream & | lookup (const word &, bool recursive=false, bool patternMatch=true) const |
Find and return an entry data stream. 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 entry * | lookupScopedEntryPtr (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 dictionary * | subDictPtr (const word &) const |
Find and return a sub-dictionary pointer if present. More... | |
const dictionary & | subDict (const word &) const |
Find and return a sub-dictionary. More... | |
dictionary & | subDict (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... | |
wordList | toc () const |
Return the table of contents. More... | |
wordList | sortedToc () const |
Return the sorted table of contents. More... | |
List< keyType > | keys (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... | |
Xfer< dictionary > | xfer () |
Transfer contents to the Xfer container. More... | |
bool | read (Istream &) |
Read dictionary from Istream. More... | |
bool | read (Istream &, const bool keepHeader) |
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... | |
ITstream & | operator[] (const word &) const |
Find and return entry. More... | |
void | operator= (const 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... | |
const fileName & | name () const |
Return the dictionary name. More... | |
fileName & | name () |
Return the dictionary name. More... | |
const word | dictName () const |
Return the local dictionary name (final part of scoped name) More... | |
Public Member Functions inherited from IDLList< entry > | |
IDLList () | |
Null construct. More... | |
IDLList (const entry &a) | |
Construct given initial T. More... | |
IDLList (Istream &is, const INew &inewt) | |
Construct from Istream using given Istream constructor class. More... | |
IDLList (Istream &is) | |
Construct from Istream. More... | |
IDLList (const IDLList< entry > &idll, const CloneArg &cloneArg) | |
Copy constructor with additional argument for clone. More... | |
Public Member Functions inherited from ILList< DLListBase, entry > | |
ILList () | |
Null construct. More... | |
ILList (entry *a) | |
Construct given initial T. More... | |
ILList (Istream &) | |
Construct from Istream. More... | |
ILList (const ILList< DLListBase, entry > &) | |
Construct as copy. More... | |
ILList (const ILList< DLListBase, entry > &lst, const CloneArg &cloneArg) | |
Copy constructor with additional argument for clone. More... | |
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 (entry *p) |
Remove the specified element from the list and delete it. More... | |
void | clear () |
Clear the contents of the list. More... | |
void | transfer (ILList< DLListBase, entry > &) |
Transfer the contents of the argument into this List. More... | |
void | operator= (const ILList< DLListBase, entry > &) |
Public Member Functions inherited from UILList< DLListBase, entry > | |
UILList () | |
Null construct. More... | |
UILList (entry *a) | |
Construct given initial T. More... | |
UILList (const UILList< DLListBase, entry > &) | |
Construct as copy. More... | |
entry * | first () |
Return the first entry. More... | |
const entry * | first () const |
Return the first entry. More... | |
entry * | last () |
Return the last entry. More... | |
const entry * | last () const |
Return the last entry. More... | |
entry * | removeHead () |
Remove and return head. More... | |
entry * | remove (entry *p) |
Remove and return element. More... | |
entry * | remove (iterator &it) |
Remove and return specified by iterator. More... | |
void | operator= (const UILList< DLListBase, entry > &) |
iterator | begin () |
const_iterator | begin () const |
const iterator & | end () |
const const_iterator & | end () const |
const_iterator | cbegin () const |
const const_iterator & | cend () const |
const_reverse_iterator | crbegin () const |
const const_reverse_iterator & | crend () const |
const_reverse_iterator | rbegin () const |
const const_reverse_iterator & | rend () const |
bool | operator== (const UILList< DLListBase, entry > &) const |
Equality operation on ULists of the same type. More... | |
bool | operator!= (const UILList< DLListBase, entry > &) const |
The opposite of the equality operation. Takes linear time. More... | |
Public Member Functions inherited from DLListBase | |
DLListBase () | |
Null construct. More... | |
DLListBase (link *) | |
Construct given initial entry. More... | |
~DLListBase () | |
Destructor. More... | |
label | size () const |
Return number of elements in list. More... | |
bool | empty () const |
Return true if the list is empty. More... | |
link * | first () |
Return first entry. More... | |
const link * | first () const |
Return const access to first entry. More... | |
link * | last () |
Return last entry. More... | |
const link * | last () const |
Return const access to last entry. More... | |
void | insert (link *) |
Add at head of list. More... | |
void | append (link *) |
Add at tail of list. More... | |
bool | swapUp (link *) |
Swap this element with the one above unless it is at the top. More... | |
bool | swapDown (link *) |
Swap this element with the one below unless it is at the bottom. More... | |
link * | removeHead () |
Remove and return head. More... | |
link * | remove (link *) |
Remove and return element. More... | |
link * | remove (iterator &) |
link * | replace (link *oldLink, link *newLink) |
Replace oldLink with newLink and return element. More... | |
link * | replace (iterator &oldIter, link *newLink) |
Replace oldIter with newLink and return element. More... | |
void | clear () |
Clear the list. More... | |
void | transfer (DLListBase &) |
Transfer the contents of the argument into this List. More... | |
iterator | begin () |
const iterator & | end () |
const_iterator | cbegin () const |
const const_iterator & | cend () const |
const_iterator | begin () const |
const const_iterator & | end () const |
const_reverse_iterator | crbegin () const |
const const_reverse_iterator & | crend () const |
const_reverse_iterator | rbegin () const |
const const_reverse_iterator & | rend () const |
Static Public Member Functions | |
static autoPtr< psiCombustionModel > | New (const fvMesh &mesh, const word &phaseName=word::null) |
Selector. 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) |
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< dictionary > | New (Istream &) |
Construct top-level dictionary on freestore from Istream. More... | |
Additional Inherited Members | |
Public Types inherited from regIOobject | |
enum | fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster } |
Types of communications. 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... | |
Public Types inherited from UILList< DLListBase, entry > | |
typedef entry | value_type |
Type of values the DLList contains. More... | |
typedef entry & | reference |
Type that can be used for storing into DLList::value_type. More... | |
typedef const entry & | const_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 DLListBase::iterator | LListBase_iterator |
typedef DLListBase::const_iterator | LListBase_const_iterator |
Static Public Attributes inherited from regIOobject | |
static const NamedEnum< fileCheckTypes, 4 > | fileCheckTypesNames |
static int | fileModificationSkew |
static fileCheckTypes | fileModificationChecking |
Static Public Attributes inherited from dictionary | |
static const dictionary | null |
Null dictionary. More... | |
Protected Member Functions inherited from IOobject | |
Istream * | objectStream () |
Construct and return an IFstream for the object. More... | |
Istream * | objectStream (const fileName &) |
Construct and return an IFstream for the object given the. More... | |
void | setBad (const string &) |
Set the object state to bad. More... | |
Protected Attributes inherited from combustionModel | |
compressibleTurbulenceModel * | turbulencePtr_ |
Reference to the turbulence model. More... | |
const fvMesh & | mesh_ |
Reference to the mesh database. More... | |
Switch | active_ |
Active. More... | |
dictionary | coeffs_ |
Dictionary of the model. More... | |
const word | modelType_ |
Model type. More... | |
const word | phaseName_ |
Phase name. More... | |
Static Protected Attributes inherited from regIOobject | |
static bool | masterOnlyReading = false |
To flag master-only reading of objects. More... | |
Definition at line 55 of file psiCombustionModel.H.
psiCombustionModel | ( | const word & | modelType, |
const fvMesh & | mesh, | ||
const word & | phaseName | ||
) |
Construct from components.
Definition at line 42 of file psiCombustionModel.C.
|
virtual |
Destructor.
Definition at line 54 of file psiCombustionModel.C.
TypeName | ( | "psiCombustionModel" | ) |
Runtime type information.
declareRunTimeSelectionTable | ( | autoPtr | , |
psiCombustionModel | , | ||
dictionary | , | ||
(const word &modelType, const fvMesh &mesh, const word &phaseName) | , | ||
(modelType, mesh, phaseName) | |||
) |
Declare run-time constructor selection tables.
|
static |
Selector.
Definition at line 32 of file psiCombustionModelNew.C.
References TimePaths::constant(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, dictionary::lookup(), mesh, and fvMesh::time().
|
pure virtual |
Return access to the thermo package.
Implemented in psiChemistryCombustion, and psiThermoCombustion.
|
pure virtual |
Return const access to the thermo package.
Implemented in psiChemistryCombustion, and psiThermoCombustion.
|
pure virtual |
Return tmp of rho.
Implements combustionModel.
Implemented in psiChemistryCombustion, and psiThermoCombustion.
|
virtual |
Update properties from given dictionary.
Reimplemented from combustionModel.
Definition at line 60 of file psiCombustionModel.C.
References combustionModel::read().