Abstract base-class for fluid and solid thermodynamic properties. More...
Public Member Functions | |
TypeName ("basicThermo") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, basicThermo, fvMesh,(const fvMesh &mesh, const word &phaseName),(mesh, phaseName)) | |
Declare run-time constructor selection table. More... | |
basicThermo (const fvMesh &, const word &phaseName) | |
Construct from mesh and phase name. More... | |
basicThermo (const fvMesh &, const dictionary &, const word &phaseName) | |
Construct from mesh, dictionary and phase name. More... | |
virtual | ~basicThermo () |
Destructor. More... | |
word | phasePropertyName (const word &name) const |
void | validate (const string &app, const word &) const |
Check that the thermodynamics package is consistent. More... | |
void | validate (const string &app, const word &, const word &) const |
Check that the thermodynamics package is consistent. More... | |
void | validate (const string &app, const word &, const word &, const word &) const |
Check that the thermodynamics package is consistent. More... | |
void | validate (const string &app, const word &, const word &, const word &, const word &) const |
Check that the thermodynamics package is consistent. More... | |
virtual void | correct ()=0 |
Update properties. More... | |
virtual word | thermoName () const =0 |
Return the name of the thermo physics. More... | |
virtual bool | incompressible () const =0 |
Return true if the equation of state is incompressible. More... | |
virtual bool | isochoric () const =0 |
Return true if the equation of state is isochoric. More... | |
Switch | dpdt () const |
Should the dpdt term be included in the enthalpy equation. More... | |
virtual tmp< volScalarField > | rho () const =0 |
Density [kg/m^3]. More... | |
virtual tmp< scalarField > | rho (const label patchi) const =0 |
Density for patch [kg/m^3]. More... | |
virtual volScalarField & | he ()=0 |
Enthalpy/Internal energy [J/kg]. More... | |
virtual const volScalarField & | he () const =0 |
Enthalpy/Internal energy [J/kg]. More... | |
virtual tmp< volScalarField > | he (const volScalarField &p, const volScalarField &T) const =0 |
Enthalpy/Internal energy. More... | |
virtual tmp< scalarField > | he (const scalarField &T, const labelList &cells) const =0 |
Enthalpy/Internal energy for cell-set [J/kg]. More... | |
virtual tmp< scalarField > | he (const scalarField &T, const label patchi) const =0 |
Enthalpy/Internal energy for patch [J/kg]. More... | |
virtual tmp< volScalarField > | hs () const =0 |
Sensible enthalpy [J/kg]. More... | |
virtual tmp< volScalarField > | hs (const volScalarField &p, const volScalarField &T) const =0 |
Sensible enthalpy. More... | |
virtual tmp< scalarField > | hs (const scalarField &T, const labelList &cells) const =0 |
Sensible enthalpy for cell-set [J/kg]. More... | |
virtual tmp< scalarField > | hs (const scalarField &T, const label patchi) const =0 |
Sensible enthalpy for patch [J/kg]. More... | |
virtual tmp< volScalarField > | ha () const =0 |
Absolute enthalpy [J/kg]. More... | |
virtual tmp< volScalarField > | ha (const volScalarField &p, const volScalarField &T) const =0 |
Absolute enthalpy. More... | |
virtual tmp< scalarField > | ha (const scalarField &T, const labelList &cells) const =0 |
Absolute enthalpy for cell-set [J/kg]. More... | |
virtual tmp< scalarField > | ha (const scalarField &T, const label patchi) const =0 |
Absolute enthalpy for patch [J/kg]. More... | |
virtual tmp< volScalarField > | hc () const =0 |
Enthalpy of formation [J/kg]. More... | |
virtual tmp< scalarField > | THE (const scalarField &h, const scalarField &T0, const labelList &cells) const =0 |
Temperature from enthalpy/internal energy for cell-set. More... | |
virtual tmp< scalarField > | THE (const scalarField &h, const scalarField &T0, const label patchi) const =0 |
Temperature from enthalpy/internal energy for patch. More... | |
virtual const volScalarField & | T () const |
Temperature [K]. More... | |
virtual volScalarField & | T () |
Temperature [K]. More... | |
virtual tmp< volScalarField > | Cp () const =0 |
Heat capacity at constant pressure [J/kg/K]. More... | |
virtual tmp< scalarField > | Cp (const scalarField &T, const label patchi) const =0 |
Heat capacity at constant pressure for patch [J/kg/K]. More... | |
virtual tmp< volScalarField > | Cv () const =0 |
Heat capacity at constant volume [J/kg/K]. More... | |
virtual tmp< scalarField > | Cv (const scalarField &T, const label patchi) const =0 |
Heat capacity at constant volume for patch [J/kg/K]. More... | |
virtual tmp< volScalarField > | Cpv () const =0 |
Heat capacity at constant pressure/volume [J/kg/K]. More... | |
virtual tmp< scalarField > | Cpv (const scalarField &T, const label patchi) const =0 |
Heat capacity at constant pressure/volume for patch [J/kg/K]. More... | |
virtual tmp< volScalarField > | CpByCpv () const =0 |
Heat capacity ratio []. More... | |
virtual tmp< scalarField > | CpByCpv (const scalarField &T, const label patchi) const =0 |
Heat capacity ratio for patch []. More... | |
virtual const volScalarField & | alpha () const |
Thermal diffusivity for enthalpy of mixture [kg/m/s]. More... | |
virtual const scalarField & | alpha (const label patchi) const |
Thermal diffusivity for enthalpy of mixture for patch [kg/m/s]. More... | |
virtual tmp< volScalarField > | kappa () const =0 |
Thermal diffusivity for temperature of mixture [W/m/K]. More... | |
virtual tmp< scalarField > | kappa (const label patchi) const =0 |
Thermal diffusivity for temperature of mixture. More... | |
virtual tmp< volScalarField > | alphahe () const =0 |
Thermal diffusivity for energy of mixture [kg/m/s]. More... | |
virtual tmp< scalarField > | alphahe (const label patchi) const =0 |
Thermal diffusivity for energy of mixture for patch [kg/m/s]. More... | |
virtual bool | read () |
Read thermophysical properties dictionary. More... | |
template<class Thermo > | |
Foam::autoPtr< Thermo > | New (const fvMesh &mesh, const word &phaseName) |
template<class Thermo > | |
Foam::autoPtr< Thermo > | New (const fvMesh &mesh, const dictionary &dict, const word &phaseName) |
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 word & | name () 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... | |
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... | |
bool | headerOk () |
Read and check header info. More... | |
Istream & | readStream (const word &, const bool read=true) |
Return Istream and check object type against that given. More... | |
void | close () |
Close Istream. More... | |
virtual label | addWatch (const fileName &) |
Add file watch for fileName on object if not yet watched. Return. More... | |
const labelList & | watchIndices () const |
Return file-monitoring handles. More... | |
labelList & | watchIndices () |
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 ®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... | |
IOobject (const IOobject &io, const objectRegistry ®istry) | |
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< IOobject > | clone () const |
Clone. More... | |
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
Clone resetting registry. 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... | |
word & | headerClassName () |
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... | |
word | modelName (const char *name) const |
Return the name of the object within this model. 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 | 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< IOobject > | info () 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< dictionary > | clone () const |
Construct and return clone. More... | |
virtual | ~dictionary () |
Destructor. More... | |
const dictionary & | parent () const |
Return the parent dictionary. More... | |
bool | isNull () const |
Return whether this dictionary is null. 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 | 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 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... | |
dictionary * | subDictPtr (const word &) |
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... | |
const dictionary & | optionalSubDict (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< 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... | |
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... | |
ITstream & | operator[] (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 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... | |
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... | |
T * | first () |
Return the first entry. More... | |
const T * | first () const |
Return the first entry. More... | |
T * | last () |
Return the last entry. More... | |
const T * | last () const |
Return the last entry. More... | |
T * | removeHead () |
Remove and return head. More... | |
T * | remove (T *p) |
Remove and return element. More... | |
T * | remove (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 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 |
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... | |
Static Public Member Functions | |
template<class Thermo , class Table > | |
static Table::iterator | lookupThermo (const dictionary &thermoTypeDict, Table *tablePtr, const int nCmpt, const char *cmptNames[], const word &thermoTypeName) |
Generic lookup for thermodynamics package thermoTypeName. More... | |
template<class Thermo , class Table > | |
static Table::iterator | lookupThermo (const dictionary &thermoDict, Table *tablePtr) |
Generic lookup for each of the related thermodynamics packages. More... | |
template<class Thermo > | |
static autoPtr< Thermo > | New (const fvMesh &, const word &phaseName=word::null) |
Generic New for each of the related thermodynamics packages. More... | |
template<class Thermo > | |
static autoPtr< Thermo > | New (const fvMesh &, const dictionary &, const word &phaseName=word::null) |
Generic New for each of the related thermodynamics packages. More... | |
static autoPtr< basicThermo > | New (const fvMesh &, const word &phaseName=word::null) |
Specialisation of the Generic New for basicThermo. More... | |
static word | phasePropertyName (const word &name, const word &phaseName) |
static const basicThermo & | lookupThermo (const fvPatchScalarField &pf) |
static wordList | splitThermoName (const word &thermoName, const int nCmpt) |
Split name of thermo package into a list of the components names. 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< dictionary > | New (Istream &) |
Construct top-level dictionary on freestore from Istream. More... | |
Static Public Attributes | |
static const word | dictName |
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... | |
Protected Member Functions | |
basicThermo (const basicThermo &) | |
Construct as copy (not implemented) More... | |
volScalarField & | lookupOrConstruct (const fvMesh &mesh, const char *name) const |
wordList | heBoundaryTypes () |
Return the enthalpy/internal energy field boundary types. More... | |
wordList | heBoundaryBaseTypes () |
Return the enthalpy/internal energy field boundary base types. 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 word & | phaseName_ |
Phase-name. More... | |
volScalarField | T_ |
Temperature [K]. More... | |
volScalarField | alpha_ |
Laminar thermal diffusivity [kg/m/s]. More... | |
Switch | dpdt_ |
Should the dpdt term be included in the enthalpy equation. More... | |
Additional Inherited Members | |
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 T & | reference |
Type that can be used for storing into DLList::value_type. More... | |
typedef const T & | 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 LListBase::iterator | LListBase_iterator |
typedef LListBase::const_iterator | LListBase_const_iterator |
Abstract base-class for fluid and solid thermodynamic properties.
Definition at line 52 of file basicThermo.H.
|
protected |
Construct as copy (not implemented)
Referenced by basicThermo::basicThermo(), and basicThermo::lookupOrConstruct().
basicThermo | ( | const fvMesh & | mesh, |
const word & | phaseName | ||
) |
Construct from mesh and phase name.
Definition at line 169 of file basicThermo.C.
References basicThermo::basicThermo().
basicThermo | ( | const fvMesh & | mesh, |
const dictionary & | dict, | ||
const word & | phaseName | ||
) |
Construct from mesh, dictionary and phase name.
Definition at line 220 of file basicThermo.C.
References basicThermo::New().
|
virtual |
Destructor.
Definition at line 284 of file basicThermo.C.
References basicThermo::lookupThermo().
|
protected |
Definition at line 137 of file basicThermo.C.
References IOobject::AUTO_WRITE, basicThermo::basicThermo(), mesh, IOobject::MUST_READ, Foam::name(), regIOobject::store(), fvMesh::time(), and Time::timeName().
Referenced by basicThermo::heBoundaryTypes().
|
protected |
Return the enthalpy/internal energy field boundary types.
by interrogating the temperature field boundary types
Definition at line 84 of file basicThermo.C.
References forAll, basicThermo::lookupOrConstruct(), patchi, and Field< Type >::typeName.
|
protected |
Return the enthalpy/internal energy field boundary base types.
by interrogating the temperature field boundary types
Definition at line 52 of file basicThermo.C.
References forAll, word::null, and patchi.
TypeName | ( | "basicThermo" | ) |
Runtime type information.
declareRunTimeSelectionTable | ( | autoPtr | , |
basicThermo | , | ||
fvMesh | , | ||
(const fvMesh &mesh, const word &phaseName) | , | ||
(mesh, phaseName) | |||
) |
Declare run-time constructor selection table.
|
static |
Generic lookup for thermodynamics package thermoTypeName.
Definition at line 32 of file basicThermoTemplates.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::nl, Foam::printTable(), List< T >::setSize(), and List< T >::size().
Referenced by basicThermo::phasePropertyName(), fixedEnergyFvPatchScalarField::updateCoeffs(), energyJumpFvPatchScalarField::updateCoeffs(), energyJumpAMIFvPatchScalarField::updateCoeffs(), gradientEnergyFvPatchScalarField::updateCoeffs(), mixedEnergyFvPatchScalarField::updateCoeffs(), and basicThermo::~basicThermo().
|
static |
Generic lookup for each of the related thermodynamics packages.
Definition at line 101 of file basicThermoTemplates.C.
References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, dictionary::found(), Foam::Info, dictionary::isDict(), dictionary::lookup(), basicThermo::New(), Foam::nl, and dictionary::subDict().
|
static |
Generic New for each of the related thermodynamics packages.
Referenced by basicThermo::basicThermo(), basicThermo::lookupThermo(), and basicThermo::New().
|
static |
Generic New for each of the related thermodynamics packages.
|
static |
Specialisation of the Generic New for basicThermo.
Definition at line 273 of file basicThermo.C.
References mesh.
Definition at line 188 of file basicThermo.H.
References IOobject::groupName().
Referenced by basicThermo::phasePropertyName().
Definition at line 196 of file basicThermo.H.
References basicThermo::correct(), basicThermo::incompressible(), basicThermo::isochoric(), basicThermo::lookupThermo(), basicThermo::phasePropertyName(), basicThermo::splitThermoName(), basicThermo::thermoName(), and basicThermo::validate().
|
static |
Definition at line 291 of file basicThermo.C.
References HashTable< T, Key, Hash >::begin(), fvPatchField< Type >::db(), dictName(), HashTableCore::end(), objectRegistry::foundObject(), he, fvPatchField< Type >::internalField(), objectRegistry::lookupClass(), objectRegistry::lookupObject(), thermos(), and basicThermo::validate().
Check that the thermodynamics package is consistent.
with energy forms supported by the application
Definition at line 327 of file basicThermo.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, he, Foam::name(), and IOobject::name().
Referenced by basicThermo::lookupThermo(), basicThermo::phasePropertyName(), and basicThermo::validate().
Check that the thermodynamics package is consistent.
with energy forms supported by the application
Definition at line 342 of file basicThermo.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, he, Foam::name(), IOobject::name(), and basicThermo::validate().
Check that the thermodynamics package is consistent.
with energy forms supported by the application
Definition at line 365 of file basicThermo.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, he, Foam::name(), IOobject::name(), and basicThermo::validate().
void validate | ( | const string & | app, |
const word & | a, | ||
const word & | b, | ||
const word & | c, | ||
const word & | d | ||
) | const |
Check that the thermodynamics package is consistent.
with energy forms supported by the application
Definition at line 391 of file basicThermo.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, he, Foam::name(), IOobject::name(), and basicThermo::splitThermoName().
|
static |
Split name of thermo package into a list of the components names.
Definition at line 421 of file basicThermo.C.
References Foam::min().
Referenced by basicThermo::phasePropertyName(), and basicThermo::validate().
|
pure virtual |
Update properties.
Implemented in solidDisplacementThermo, multiphaseMixtureThermo, twoPhaseMixtureThermo, and psiuReactionThermo.
Referenced by radiation::addSup(), and basicThermo::phasePropertyName().
|
pure virtual |
Return the name of the thermo physics.
Implemented in multiphaseMixtureThermo, twoPhaseMixtureThermo, and solidDisplacementThermo.
Referenced by sootModel::New(), and basicThermo::phasePropertyName().
|
pure virtual |
Return true if the equation of state is incompressible.
i.e. rho != f(p)
Implemented in multiphaseMixtureThermo, twoPhaseMixtureThermo, and solidDisplacementThermo.
Referenced by basicThermo::phasePropertyName().
|
pure virtual |
Return true if the equation of state is isochoric.
i.e. rho = const
Implemented in multiphaseMixtureThermo, twoPhaseMixtureThermo, and solidDisplacementThermo.
Referenced by basicThermo::phasePropertyName().
|
inline |
Should the dpdt term be included in the enthalpy equation.
Definition at line 263 of file basicThermo.H.
References basicThermo::alpha(), basicThermo::alphahe(), cells, basicThermo::Cp(), basicThermo::CpByCpv(), basicThermo::Cpv(), basicThermo::Cv(), basicThermo::dpdt_, Foam::constant::universal::h, basicThermo::ha(), basicThermo::hc(), basicThermo::he(), basicThermo::hs(), basicThermo::kappa(), p, patchi, basicThermo::read(), basicThermo::rho(), basicThermo::T(), T0, and basicThermo::THE().
|
pure virtual |
Density [kg/m^3].
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, solidThermo, rhoThermo, and psiThermo.
Referenced by adsorptionMassFractionFvPatchScalarField::calcPhiYp(), semiPermeableBaffleMassFractionFvPatchScalarField::calcPhiYp(), variableHeatTransfer::calculateHtc(), basicThermo::dpdt(), and fluidThermo::nu().
|
pure virtual |
Density for patch [kg/m^3].
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, solidThermo, rhoThermo, and psiThermo.
|
pure virtual |
Enthalpy/Internal energy [J/kg].
Non-const access allowed for transport equations
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
Referenced by fixedTemperatureConstraint::constrain(), limitTemperature::correct(), basicThermo::dpdt(), effectivenessHeatExchangerSource::effectivenessHeatExchangerSource(), wallHeatFlux::execute(), fixedTemperatureConstraint::fixedTemperatureConstraint(), limitTemperature::limitTemperature(), radiation::radiation(), solidificationMeltingSource::solidificationMeltingSource(), externalCoupledTemperatureMixedFvPatchScalarField::transferData(), energyJumpFvPatchScalarField::updateCoeffs(), fixedEnergyFvPatchScalarField::updateCoeffs(), energyJumpAMIFvPatchScalarField::updateCoeffs(), gradientEnergyFvPatchScalarField::updateCoeffs(), mixedEnergyFvPatchScalarField::updateCoeffs(), specieTransferTemperatureFvPatchScalarField::updateCoeffs(), and alphatJayatillekeWallFunctionFvPatchScalarField::updateCoeffs().
|
pure virtual |
Enthalpy/Internal energy [J/kg].
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
|
pure virtual |
Enthalpy/Internal energy.
for given pressure and temperature [J/kg]
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
|
pure virtual |
Enthalpy/Internal energy for cell-set [J/kg].
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
|
pure virtual |
Enthalpy/Internal energy for patch [J/kg].
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
|
pure virtual |
Sensible enthalpy [J/kg].
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
Referenced by basicThermo::dpdt().
|
pure virtual |
Sensible enthalpy.
for given pressure and temperature [J/kg]
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
|
pure virtual |
Sensible enthalpy for cell-set [J/kg].
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
|
pure virtual |
Sensible enthalpy for patch [J/kg].
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
|
pure virtual |
Absolute enthalpy [J/kg].
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
Referenced by basicThermo::dpdt(), and totalEnthalpy::execute().
|
pure virtual |
Absolute enthalpy.
for given pressure and temperature [J/kg]
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
|
pure virtual |
Absolute enthalpy for cell-set [J/kg].
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
|
pure virtual |
Absolute enthalpy for patch [J/kg].
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
|
pure virtual |
Enthalpy of formation [J/kg].
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
Referenced by basicThermo::dpdt().
|
pure virtual |
Temperature from enthalpy/internal energy for cell-set.
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
Referenced by basicThermo::dpdt().
|
pure virtual |
Temperature from enthalpy/internal energy for patch.
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
|
virtual |
Temperature [K].
Definition at line 482 of file basicThermo.C.
Referenced by basicThermo::dpdt(), twoPhaseMixtureThermo::he(), multiphaseMixtureThermo::he(), laminarFlameSpeed::New(), radiation::radiation(), solidDisplacementThermo::thermalStress(), fixedEnergyFvPatchScalarField::updateCoeffs(), energyJumpFvPatchScalarField::updateCoeffs(), energyJumpAMIFvPatchScalarField::updateCoeffs(), gradientEnergyFvPatchScalarField::updateCoeffs(), mixedEnergyFvPatchScalarField::updateCoeffs(), convectiveHeatTransferFvPatchScalarField::updateCoeffs(), and thermalBaffle1DFvPatchScalarField< solidType >::updateCoeffs().
|
virtual |
Temperature [K].
Non-const access allowed for transport equations
Definition at line 488 of file basicThermo.C.
|
pure virtual |
Heat capacity at constant pressure [J/kg/K].
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
Referenced by interRegionHeatTransferModel::addSup(), effectivenessHeatExchangerSource::addSup(), basicThermo::dpdt(), temperatureCoupledBase::kappa(), NamedEnum< compressibleField, 8 >::names(), mixedUnburntEnthalpyFvPatchScalarField::updateCoeffs(), gradientUnburntEnthalpyFvPatchScalarField::updateCoeffs(), and convectiveHeatTransferFvPatchScalarField::updateCoeffs().
|
pure virtual |
Heat capacity at constant pressure for patch [J/kg/K].
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
|
pure virtual |
Heat capacity at constant volume [J/kg/K].
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
Referenced by basicThermo::dpdt().
|
pure virtual |
Heat capacity at constant volume for patch [J/kg/K].
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
|
pure virtual |
Heat capacity at constant pressure/volume [J/kg/K].
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
Referenced by interRegionHeatTransferModel::addSup(), basicThermo::dpdt(), radiationModel::Sh(), gradientEnergyFvPatchScalarField::updateCoeffs(), and mixedEnergyFvPatchScalarField::updateCoeffs().
|
pure virtual |
Heat capacity at constant pressure/volume for patch [J/kg/K].
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
|
pure virtual |
Heat capacity ratio [].
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
Referenced by basicThermo::dpdt().
|
pure virtual |
Heat capacity ratio for patch [].
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
|
virtual |
Thermal diffusivity for enthalpy of mixture [kg/m/s].
Definition at line 494 of file basicThermo.C.
Referenced by basicThermo::dpdt(), wallHeatFlux::execute(), externalCoupledTemperatureMixedFvPatchScalarField::transferData(), alphatFilmWallFunctionFvPatchScalarField::updateCoeffs(), and alphatJayatillekeWallFunctionFvPatchScalarField::updateCoeffs().
|
virtual |
Thermal diffusivity for enthalpy of mixture for patch [kg/m/s].
Definition at line 500 of file basicThermo.C.
References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), and patchi.
|
pure virtual |
Thermal diffusivity for temperature of mixture [W/m/K].
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
Referenced by basicThermo::dpdt(), and temperatureCoupledBase::kappa().
|
pure virtual |
Thermal diffusivity for temperature of mixture.
for patch [W/m/K]
Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.
|
pure virtual |
Thermal diffusivity for energy of mixture [kg/m/s].
Implemented in multiphaseMixtureThermo, twoPhaseMixtureThermo, and solidDisplacementThermo.
Referenced by basicThermo::dpdt().
|
pure virtual |
Thermal diffusivity for energy of mixture for patch [kg/m/s].
Implemented in multiphaseMixtureThermo, twoPhaseMixtureThermo, and solidDisplacementThermo.
|
virtual |
Read thermophysical properties dictionary.
Reimplemented from regIOobject.
Reimplemented in solidDisplacementThermo, twoPhaseMixtureThermo, and solidThermo.
Definition at line 506 of file basicThermo.C.
References regIOobject::read().
Referenced by basicThermo::dpdt().
Foam::autoPtr<Thermo> New | ( | const fvMesh & | mesh, |
const word & | phaseName | ||
) |
Definition at line 202 of file basicThermoTemplates.C.
References TimePaths::constant(), dictName(), mesh, basicThermo::New(), and fvMesh::time().
Foam::autoPtr<Thermo> New | ( | const fvMesh & | mesh, |
const dictionary & | dict, | ||
const word & | phaseName | ||
) |
Definition at line 233 of file basicThermoTemplates.C.
|
protected |
Phase-name.
Definition at line 62 of file basicThermo.H.
|
protected |
Temperature [K].
Definition at line 68 of file basicThermo.H.
|
protected |
Laminar thermal diffusivity [kg/m/s].
Definition at line 71 of file basicThermo.H.
|
protected |
Should the dpdt term be included in the enthalpy equation.
Definition at line 75 of file basicThermo.H.
Referenced by basicThermo::dpdt().
|
static |
Definition at line 185 of file basicThermo.H.