basicThermo Class Referenceabstract

Abstract base-class for fluid and solid thermodynamic properties. More...

Inheritance diagram for basicThermo:
Collaboration diagram for basicThermo:

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< volScalarFieldrho () const =0
 Density [kg/m^3]. More...
 
virtual tmp< scalarFieldrho (const label patchi) const =0
 Density for patch [kg/m^3]. More...
 
virtual volScalarFieldhe ()=0
 Enthalpy/Internal energy [J/kg]. More...
 
virtual const volScalarFieldhe () const =0
 Enthalpy/Internal energy [J/kg]. More...
 
virtual tmp< volScalarFieldhe (const volScalarField &p, const volScalarField &T) const =0
 Enthalpy/Internal energy. More...
 
virtual tmp< scalarFieldhe (const scalarField &T, const labelList &cells) const =0
 Enthalpy/Internal energy for cell-set [J/kg]. More...
 
virtual tmp< scalarFieldhe (const scalarField &T, const label patchi) const =0
 Enthalpy/Internal energy for patch [J/kg]. More...
 
virtual tmp< volScalarFieldhs () const =0
 Sensible enthalpy [J/kg]. More...
 
virtual tmp< volScalarFieldhs (const volScalarField &p, const volScalarField &T) const =0
 Sensible enthalpy. More...
 
virtual tmp< scalarFieldhs (const scalarField &T, const labelList &cells) const =0
 Sensible enthalpy for cell-set [J/kg]. More...
 
virtual tmp< scalarFieldhs (const scalarField &T, const label patchi) const =0
 Sensible enthalpy for patch [J/kg]. More...
 
virtual tmp< volScalarFieldha () const =0
 Absolute enthalpy [J/kg]. More...
 
virtual tmp< volScalarFieldha (const volScalarField &p, const volScalarField &T) const =0
 Absolute enthalpy. More...
 
virtual tmp< scalarFieldha (const scalarField &T, const labelList &cells) const =0
 Absolute enthalpy for cell-set [J/kg]. More...
 
virtual tmp< scalarFieldha (const scalarField &T, const label patchi) const =0
 Absolute enthalpy for patch [J/kg]. More...
 
virtual tmp< volScalarFieldhc () const =0
 Enthalpy of formation [J/kg]. More...
 
virtual tmp< scalarFieldTHE (const scalarField &h, const scalarField &T0, const labelList &cells) const =0
 Temperature from enthalpy/internal energy for cell-set. More...
 
virtual tmp< scalarFieldTHE (const scalarField &h, const scalarField &T0, const label patchi) const =0
 Temperature from enthalpy/internal energy for patch. More...
 
virtual const volScalarFieldT () const
 Temperature [K]. More...
 
virtual volScalarFieldT ()
 Temperature [K]. More...
 
virtual tmp< volScalarFieldCp () const =0
 Heat capacity at constant pressure [J/kg/K]. More...
 
virtual tmp< scalarFieldCp (const scalarField &T, const label patchi) const =0
 Heat capacity at constant pressure for patch [J/kg/K]. More...
 
virtual tmp< volScalarFieldCv () const =0
 Heat capacity at constant volume [J/kg/K]. More...
 
virtual tmp< scalarFieldCv (const scalarField &T, const label patchi) const =0
 Heat capacity at constant volume for patch [J/kg/K]. More...
 
virtual tmp< volScalarFieldCpv () const =0
 Heat capacity at constant pressure/volume [J/kg/K]. More...
 
virtual tmp< scalarFieldCpv (const scalarField &T, const label patchi) const =0
 Heat capacity at constant pressure/volume for patch [J/kg/K]. More...
 
virtual tmp< volScalarFieldCpByCpv () const =0
 Heat capacity ratio []. More...
 
virtual tmp< scalarFieldCpByCpv (const scalarField &T, const label patchi) const =0
 Heat capacity ratio for patch []. More...
 
virtual const volScalarFieldalpha () const
 Thermal diffusivity for enthalpy of mixture [kg/m/s]. More...
 
virtual const scalarFieldalpha (const label patchi) const
 Thermal diffusivity for enthalpy of mixture for patch [kg/m/s]. More...
 
virtual tmp< volScalarFieldkappa () const =0
 Thermal diffusivity for temperature of mixture [W/m/K]. More...
 
virtual tmp< scalarFieldkappa (const label patchi) const =0
 Thermal diffusivity for temperature of mixture. More...
 
virtual tmp< volScalarFieldalphahe () const =0
 Thermal diffusivity for energy of mixture [kg/m/s]. More...
 
virtual tmp< scalarFieldalphahe (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 wordname () const
 Name function is needed to disambiguate those inherited. More...
 
virtual bool readData (Istream &)
 ReadData function required for regIOobject read operation. More...
 
virtual bool writeData (Ostream &) const
 WriteData function required for regIOobject write operation. More...
 
void operator= (const baseIOdictionary &)
 Assignment of other baseIOdictionary's entries to this. More...
 
void operator= (baseIOdictionary &&)
 Move assignment. More...
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the. More...
 
 regIOobject (const regIOobject &)
 Copy constructor. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Copy constructor, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Copy constructor with new name, transferring registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Copy constructor with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
virtual void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
void store ()
 Transfer ownership of this object to its registry. More...
 
void release ()
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
labeleventNo ()
 Event number at last update. More...
 
bool upToDate (const regIOobject &) const
 Return true if up-to-date with respect to given object. More...
 
bool upToDate (const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
void setUpToDate ()
 Set up to date (obviously) More...
 
virtual void rename (const word &newName)
 Rename. More...
 
bool headerOk ()
 Read and check header info. More...
 
IstreamreadStream (const word &, const bool read=true)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual label addWatch (const fileName &)
 Add file watch for fileName on object if not yet watched. Return. More...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
 Write using given format, version and compression. More...
 
virtual bool write (const bool write=true) const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Construct from copy resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Construct from copy resetting name. More...
 
 IOobject (const IOobject &io)=default
 Copy constructor. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
wordheaderClassName ()
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () const
 Return the optional note. More...
 
bool & registerObject ()
 Register object created from this IOobject with registry if true. More...
 
bool registerObject () const
 Register object created from this IOobject with registry if true. More...
 
readOption readOpt () const
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
word modelName (const char *name) const
 Return the name of the object within this model. More...
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const
 
fileNameinstance ()
 
const fileNamelocal () const
 
fileName path () const
 Return complete path. More...
 
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local. More...
 
fileName localPath () const
 Return the path relative to the case. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName localObjectPath () const
 Return complete localPath + object name. More...
 
fileName localFilePath (const word &typeName) const
 Helper for filePath that searches locally. More...
 
fileName globalFilePath (const word &typeName) const
 Helper for filePath that searches up if in parallel. More...
 
bool readHeader (Istream &)
 Read header. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType=true)
 Read header (uses typeFilePath to find file) and check header. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &) const
 Write header. More...
 
bool writeHeader (Ostream &, const word &objectType) const
 Write header. Allow override of type. More...
 
bool good () const
 
bool bad () const
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 
template<class Name >
Foam::word modelName (Name name, const word &model)
 
- Public Member Functions inherited from dictionary
 ClassName ("dictionary")
 
 dictionary ()
 Construct top-level dictionary null. More...
 
 dictionary (const fileName &name)
 Construct top-level empty dictionary with given name. More...
 
 dictionary (const fileName &name, const dictionary &parentDict, Istream &)
 Construct given the entry name, parent dictionary and Istream,. More...
 
 dictionary (Istream &, const bool keepHeader=false)
 Construct top-level dictionary from Istream,. More...
 
 dictionary (const dictionary &parentDict, const dictionary &)
 Construct as copy given the parent dictionary. More...
 
 dictionary (const dictionary &)
 Construct top-level dictionary as copy. More...
 
 dictionary (const dictionary *)
 Construct top-level dictionary as copy from pointer to dictionary. More...
 
 dictionary (const dictionary &parentDict, dictionary &&)
 Move constructor transferring parameter contents. More...
 
 dictionary (dictionary &&)
 Move constructor. More...
 
autoPtr< dictionaryclone () const
 Construct and return clone. More...
 
virtual ~dictionary ()
 Destructor. More...
 
const dictionaryparent () const
 Return the parent dictionary. More...
 
bool isNull () const
 Return whether this dictionary is null. More...
 
const dictionarytopDict () const
 Return the top of the tree. More...
 
label startLineNumber () const
 Return line number of first token in dictionary. More...
 
label endLineNumber () const
 Return line number of last token in dictionary. More...
 
SHA1Digest digest () const
 Return the SHA1 digest of the dictionary contents. More...
 
tokenList tokens () const
 Return the dictionary as a list of tokens. More...
 
bool found (const word &, bool recursive=false, bool patternMatch=true) const
 Search dictionary for given keyword. More...
 
const entrylookupEntryPtr (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream pointer if present. More...
 
entrylookupEntryPtr (const word &, bool recursive, bool patternMatch)
 Find and return an entry data stream pointer for manipulation. More...
 
const entrylookupEntry (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream if present otherwise error. More...
 
ITstreamlookup (const word &, bool recursive=false, bool patternMatch=true) const
 Find and return an entry data stream. More...
 
template<class T >
T lookup (const word &, bool recursive=false, bool patternMatch=true) const
 Find and return a T,. More...
 
template<class T >
T lookupOrDefault (const word &, const T &, bool recursive=false, bool patternMatch=true) const
 Find and return a T,. More...
 
template<class T >
T lookupOrAddDefault (const word &, const T &, bool recursive=false, bool patternMatch=true)
 Find and return a T, if not found return the given. More...
 
template<class T >
bool readIfPresent (const word &, T &, bool recursive=false, bool patternMatch=true) const
 Find an entry if present, and assign to T. More...
 
const entrylookupScopedEntryPtr (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream pointer if present. More...
 
bool isDict (const word &) const
 Check if entry is a sub-dictionary. More...
 
const dictionarysubDictPtr (const word &) const
 Find and return a sub-dictionary pointer if present. More...
 
dictionarysubDictPtr (const word &)
 Find and return a sub-dictionary pointer if present. More...
 
const dictionarysubDict (const word &) const
 Find and return a sub-dictionary. More...
 
dictionarysubDict (const word &)
 Find and return a sub-dictionary for manipulation. More...
 
dictionary subOrEmptyDict (const word &, const bool mustRead=false) const
 Find and return a sub-dictionary as a copy, or. More...
 
const dictionaryoptionalSubDict (const word &) const
 Find and return a sub-dictionary if found. More...
 
wordList toc () const
 Return the table of contents. More...
 
wordList sortedToc () const
 Return the sorted table of contents. More...
 
List< keyTypekeys (bool patterns=false) const
 Return the list of available keys or patterns. More...
 
bool substituteKeyword (const word &keyword)
 Substitute the given keyword prepended by '$' with the. More...
 
bool substituteScopedKeyword (const word &keyword)
 Substitute the given scoped keyword prepended by '$' with the. More...
 
bool add (entry *, bool mergeEntry=false)
 Add a new entry. More...
 
void add (const entry &, bool mergeEntry=false)
 Add an entry. More...
 
void add (const keyType &, const word &, bool overwrite=false)
 Add a word entry. More...
 
void add (const keyType &, const string &, bool overwrite=false)
 Add a string entry. More...
 
void add (const keyType &, const label, bool overwrite=false)
 Add a label entry. More...
 
void add (const keyType &, const scalar, bool overwrite=false)
 Add a scalar entry. More...
 
void add (const keyType &, const dictionary &, bool mergeEntry=false)
 Add a dictionary entry. More...
 
template<class T >
void add (const keyType &, const T &, bool overwrite=false)
 Add a T entry. More...
 
void set (entry *)
 Assign a new entry, overwrite any existing entry. More...
 
void set (const entry &)
 Assign a new entry, overwrite any existing entry. More...
 
void set (const keyType &, const dictionary &)
 Assign a dictionary entry, overwrite any existing entry. More...
 
template<class T >
void set (const keyType &, const T &)
 Assign a T entry, overwrite any existing entry. More...
 
bool remove (const word &)
 Remove an entry specified by keyword. More...
 
bool changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool forceOverwrite=false)
 Change the keyword for an entry,. More...
 
bool merge (const dictionary &)
 Merge entries from the given dictionary. More...
 
void clear ()
 Clear the dictionary. More...
 
void transfer (dictionary &)
 Transfer the contents of the argument and annul the argument. More...
 
bool read (Istream &, const bool keepHeader=false)
 Read dictionary from Istream, optionally keeping the header. More...
 
void write (Ostream &, const bool subDict=true) const
 Write dictionary, normally with sub-dictionary formatting. More...
 
ITstreamoperator[] (const word &) const
 Find and return entry. More...
 
void operator= (const dictionary &)
 
void operator= (dictionary &&)
 
void operator+= (const dictionary &)
 Include entries from the given dictionary. More...
 
void operator|= (const dictionary &)
 Conditionally include entries from the given dictionary. More...
 
void operator<<= (const dictionary &)
 Unconditionally include entries from the given dictionary. More...
 
- Public Member Functions inherited from dictionaryName
 dictionaryName ()
 Construct dictionaryName null. More...
 
 dictionaryName (const fileName &name)
 Construct dictionaryName as copy of the given fileName. More...
 
 dictionaryName (dictionaryName &&name)
 Move constructor. More...
 
const fileNamename () const
 Return the dictionary name. More...
 
fileNamename ()
 Return the dictionary name. More...
 
const word dictName () const
 Return the local dictionary name (final part of scoped name) More...
 
void operator= (const dictionaryName &name)
 
void operator= (dictionaryName &&name)
 
- Public Member Functions inherited from ILList< LListBase, T >
 ILList ()
 Null construct. More...
 
 ILList (T *a)
 Construct given initial T. More...
 
 ILList (Istream &)
 Construct from Istream. More...
 
 ILList (const ILList< LListBase, T > &)
 Copy constructor. More...
 
 ILList (ILList< LListBase, T > &&)
 Move constructor. More...
 
template<class CloneArg >
 ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone. More...
 
template<class INew >
 ILList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class. More...
 
 ~ILList ()
 Destructor. More...
 
bool eraseHead ()
 Remove the head element specified from the list and delete it. More...
 
bool erase (T *p)
 Remove the specified element from the list and delete it. More...
 
void clear ()
 Clear the contents of the list. More...
 
void transfer (ILList< LListBase, T > &)
 Transfer the contents of the argument into this List. More...
 
void operator= (const ILList< LListBase, T > &)
 Assignment operator. More...
 
void operator= (ILList< LListBase, T > &&)
 Move assignment operator. More...
 
- Public Member Functions inherited from UILList< LListBase, T >
 UILList ()
 Null construct. More...
 
 UILList (T *a)
 Construct given initial T. More...
 
 UILList (const UILList< LListBase, T > &)
 Copy constructor. More...
 
 UILList (UILList< LListBase, T > &&)
 Move constructor. More...
 
Tfirst ()
 Return the first entry. More...
 
const Tfirst () const
 Return the first entry. More...
 
Tlast ()
 Return the last entry. More...
 
const Tlast () const
 Return the last entry. More...
 
TremoveHead ()
 Remove and return head. More...
 
Tremove (T *p)
 Remove and return element. More...
 
Tremove (iterator &it)
 Remove and return specified by iterator. More...
 
void operator= (const UILList< LListBase, T > &)
 Assignment operator. More...
 
void operator= (UILList< LListBase, T > &&)
 Move assignment operator. More...
 
iterator begin ()
 
const iteratorend ()
 
const_iterator cbegin () const
 
const const_iteratorcend () const
 
const_iterator begin () const
 
const const_iteratorend () const
 
const_reverse_iterator crbegin () const
 
const const_reverse_iteratorcrend () const
 
const_reverse_iterator rbegin () const
 
const const_reverse_iteratorrend () const
 
bool operator== (const UILList< LListBase, T > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UILList< LListBase, T > &) const
 The opposite of the equality operation. Takes linear time. More...
 

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< basicThermoNew (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 basicThermolookupThermo (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< dictionaryNew (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...
 
volScalarFieldlookupOrConstruct (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 wordphaseName_
 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 Treference
 Type that can be used for storing into DLList::value_type. More...
 
typedef const Tconst_reference
 Type that can be used for storing into constant. More...
 
typedef label size_type
 The type that can represent the size of a DLList. More...
 
typedef LListBase::iterator LListBase_iterator
 
typedef LListBase::const_iterator LListBase_const_iterator
 

Detailed Description

Abstract base-class for fluid and solid thermodynamic properties.

Source files

Definition at line 52 of file basicThermo.H.

Constructor & Destructor Documentation

◆ basicThermo() [1/3]

basicThermo ( const basicThermo )
protected

Construct as copy (not implemented)

Referenced by basicThermo::basicThermo(), and basicThermo::lookupOrConstruct().

Here is the caller graph for this function:

◆ basicThermo() [2/3]

basicThermo ( const fvMesh mesh,
const word phaseName 
)

Construct from mesh and phase name.

Definition at line 169 of file basicThermo.C.

References basicThermo::basicThermo().

Here is the call graph for this function:

◆ basicThermo() [3/3]

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

Here is the call graph for this function:

◆ ~basicThermo()

~basicThermo ( )
virtual

Destructor.

Definition at line 284 of file basicThermo.C.

References basicThermo::lookupThermo().

Here is the call graph for this function:

Member Function Documentation

◆ lookupOrConstruct()

Foam::volScalarField & lookupOrConstruct ( const fvMesh mesh,
const char *  name 
) const
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().

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

◆ heBoundaryTypes()

Foam::wordList 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.

Here is the call graph for this function:

◆ heBoundaryBaseTypes()

Foam::wordList heBoundaryBaseTypes ( )
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()

TypeName ( "basicThermo"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
basicThermo  ,
fvMesh  ,
(const fvMesh &mesh, const word &phaseName)  ,
(mesh, phaseName)   
)

Declare run-time constructor selection table.

◆ lookupThermo() [1/3]

Table::iterator lookupThermo ( const dictionary thermoTypeDict,
Table *  tablePtr,
const int  nCmpt,
const char *  cmptNames[],
const word thermoTypeName 
)
static

◆ lookupThermo() [2/3]

Table::iterator lookupThermo ( const dictionary thermoDict,
Table *  tablePtr 
)
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().

Here is the call graph for this function:

◆ New() [1/5]

static autoPtr<Thermo> New ( const fvMesh ,
const word phaseName = word::null 
)
static

Generic New for each of the related thermodynamics packages.

Referenced by basicThermo::basicThermo(), basicThermo::lookupThermo(), and basicThermo::New().

Here is the caller graph for this function:

◆ New() [2/5]

static autoPtr<Thermo> New ( const fvMesh ,
const dictionary ,
const word phaseName = word::null 
)
static

Generic New for each of the related thermodynamics packages.

◆ New() [3/5]

Foam::autoPtr< Foam::basicThermo > New ( const fvMesh mesh,
const word phaseName = word::null 
)
static

Specialisation of the Generic New for basicThermo.

Definition at line 273 of file basicThermo.C.

References mesh.

◆ phasePropertyName() [1/2]

static word phasePropertyName ( const word name,
const word phaseName 
)
inlinestatic

Definition at line 188 of file basicThermo.H.

References IOobject::groupName().

Referenced by basicThermo::phasePropertyName().

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

◆ phasePropertyName() [2/2]

◆ lookupThermo() [3/3]

◆ validate() [1/4]

void validate ( const string app,
const word a 
) const

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

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

◆ validate() [2/4]

void validate ( const string app,
const word a,
const word b 
) const

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

Here is the call graph for this function:

◆ validate() [3/4]

void validate ( const string app,
const word a,
const word b,
const word c 
) const

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

Here is the call graph for this function:

◆ validate() [4/4]

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

Here is the call graph for this function:

◆ splitThermoName()

Foam::wordList splitThermoName ( const word thermoName,
const int  nCmpt 
)
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().

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

◆ correct()

virtual void correct ( )
pure virtual

Update properties.

Implemented in solidDisplacementThermo, multiphaseMixtureThermo, twoPhaseMixtureThermo, and psiuReactionThermo.

Referenced by radiation::addSup(), and basicThermo::phasePropertyName().

Here is the caller graph for this function:

◆ thermoName()

virtual word thermoName ( ) const
pure virtual

Return the name of the thermo physics.

Implemented in multiphaseMixtureThermo, twoPhaseMixtureThermo, and solidDisplacementThermo.

Referenced by sootModel::New(), and basicThermo::phasePropertyName().

Here is the caller graph for this function:

◆ incompressible()

virtual bool incompressible ( ) const
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().

Here is the caller graph for this function:

◆ isochoric()

virtual bool isochoric ( ) const
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().

Here is the caller graph for this function:

◆ dpdt()

◆ rho() [1/2]

◆ rho() [2/2]

virtual tmp<scalarField> rho ( const label  patchi) const
pure virtual

Density for patch [kg/m^3].

Implemented in multiphaseMixtureThermo, solidDisplacementThermo, solidThermo, rhoThermo, and psiThermo.

◆ he() [1/5]

◆ he() [2/5]

virtual const volScalarField& he ( ) const
pure virtual

Enthalpy/Internal energy [J/kg].

Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.

◆ he() [3/5]

virtual tmp<volScalarField> he ( const volScalarField p,
const volScalarField T 
) const
pure virtual

Enthalpy/Internal energy.

for given pressure and temperature [J/kg]

Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.

◆ he() [4/5]

virtual tmp<scalarField> he ( const scalarField T,
const labelList cells 
) const
pure virtual

Enthalpy/Internal energy for cell-set [J/kg].

Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.

◆ he() [5/5]

virtual tmp<scalarField> he ( const scalarField T,
const label  patchi 
) const
pure virtual

Enthalpy/Internal energy for patch [J/kg].

Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.

◆ hs() [1/4]

virtual tmp<volScalarField> hs ( ) const
pure virtual

Sensible enthalpy [J/kg].

Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.

Referenced by basicThermo::dpdt().

Here is the caller graph for this function:

◆ hs() [2/4]

virtual tmp<volScalarField> hs ( const volScalarField p,
const volScalarField T 
) const
pure virtual

Sensible enthalpy.

for given pressure and temperature [J/kg]

Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.

◆ hs() [3/4]

virtual tmp<scalarField> hs ( const scalarField T,
const labelList cells 
) const
pure virtual

Sensible enthalpy for cell-set [J/kg].

Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.

◆ hs() [4/4]

virtual tmp<scalarField> hs ( const scalarField T,
const label  patchi 
) const
pure virtual

Sensible enthalpy for patch [J/kg].

Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.

◆ ha() [1/4]

virtual tmp<volScalarField> ha ( ) const
pure virtual

Absolute enthalpy [J/kg].

Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.

Referenced by basicThermo::dpdt(), and totalEnthalpy::execute().

Here is the caller graph for this function:

◆ ha() [2/4]

virtual tmp<volScalarField> ha ( const volScalarField p,
const volScalarField T 
) const
pure virtual

Absolute enthalpy.

for given pressure and temperature [J/kg]

Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.

◆ ha() [3/4]

virtual tmp<scalarField> ha ( const scalarField T,
const labelList cells 
) const
pure virtual

Absolute enthalpy for cell-set [J/kg].

Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.

◆ ha() [4/4]

virtual tmp<scalarField> ha ( const scalarField T,
const label  patchi 
) const
pure virtual

Absolute enthalpy for patch [J/kg].

Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.

◆ hc()

virtual tmp<volScalarField> hc ( ) const
pure virtual

Enthalpy of formation [J/kg].

Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.

Referenced by basicThermo::dpdt().

Here is the caller graph for this function:

◆ THE() [1/2]

virtual tmp<scalarField> THE ( const scalarField h,
const scalarField T0,
const labelList cells 
) const
pure virtual

Temperature from enthalpy/internal energy for cell-set.

Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.

Referenced by basicThermo::dpdt().

Here is the caller graph for this function:

◆ THE() [2/2]

virtual tmp<scalarField> THE ( const scalarField h,
const scalarField T0,
const label  patchi 
) const
pure virtual

Temperature from enthalpy/internal energy for patch.

Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.

◆ T() [1/2]

◆ T() [2/2]

Foam::volScalarField & T ( )
virtual

Temperature [K].

Non-const access allowed for transport equations

Definition at line 488 of file basicThermo.C.

◆ Cp() [1/2]

◆ Cp() [2/2]

virtual tmp<scalarField> Cp ( const scalarField T,
const label  patchi 
) const
pure virtual

Heat capacity at constant pressure for patch [J/kg/K].

Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.

◆ Cv() [1/2]

virtual tmp<volScalarField> Cv ( ) const
pure virtual

Heat capacity at constant volume [J/kg/K].

Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.

Referenced by basicThermo::dpdt().

Here is the caller graph for this function:

◆ Cv() [2/2]

virtual tmp<scalarField> Cv ( const scalarField T,
const label  patchi 
) const
pure virtual

Heat capacity at constant volume for patch [J/kg/K].

Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.

◆ Cpv() [1/2]

virtual tmp<volScalarField> Cpv ( ) const
pure virtual

◆ Cpv() [2/2]

virtual tmp<scalarField> Cpv ( const scalarField T,
const label  patchi 
) const
pure virtual

Heat capacity at constant pressure/volume for patch [J/kg/K].

Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.

◆ CpByCpv() [1/2]

virtual tmp<volScalarField> CpByCpv ( ) const
pure virtual

Heat capacity ratio [].

Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.

Referenced by basicThermo::dpdt().

Here is the caller graph for this function:

◆ CpByCpv() [2/2]

virtual tmp<scalarField> CpByCpv ( const scalarField T,
const label  patchi 
) const
pure virtual

Heat capacity ratio for patch [].

Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.

◆ alpha() [1/2]

const Foam::volScalarField & alpha ( ) const
virtual

◆ alpha() [2/2]

const Foam::scalarField & alpha ( const label  patchi) const
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.

Here is the call graph for this function:

◆ kappa() [1/2]

virtual tmp<volScalarField> kappa ( ) const
pure virtual

Thermal diffusivity for temperature of mixture [W/m/K].

Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.

Referenced by basicThermo::dpdt(), and temperatureCoupledBase::kappa().

Here is the caller graph for this function:

◆ kappa() [2/2]

virtual tmp<scalarField> kappa ( const label  patchi) const
pure virtual

Thermal diffusivity for temperature of mixture.

for patch [W/m/K]

Implemented in multiphaseMixtureThermo, solidDisplacementThermo, and twoPhaseMixtureThermo.

◆ alphahe() [1/2]

virtual tmp<volScalarField> alphahe ( ) const
pure virtual

Thermal diffusivity for energy of mixture [kg/m/s].

Implemented in multiphaseMixtureThermo, twoPhaseMixtureThermo, and solidDisplacementThermo.

Referenced by basicThermo::dpdt().

Here is the caller graph for this function:

◆ alphahe() [2/2]

virtual tmp<scalarField> alphahe ( const label  patchi) const
pure virtual

Thermal diffusivity for energy of mixture for patch [kg/m/s].

Implemented in multiphaseMixtureThermo, twoPhaseMixtureThermo, and solidDisplacementThermo.

◆ read()

bool read ( )
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().

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

◆ New() [4/5]

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

Here is the call graph for this function:

◆ New() [5/5]

Foam::autoPtr<Thermo> New ( const fvMesh mesh,
const dictionary dict,
const word phaseName 
)

Definition at line 233 of file basicThermoTemplates.C.

References dict, and mesh.

Member Data Documentation

◆ phaseName_

const word& phaseName_
protected

Phase-name.

Definition at line 62 of file basicThermo.H.

◆ T_

volScalarField T_
protected

Temperature [K].

Definition at line 68 of file basicThermo.H.

◆ alpha_

volScalarField alpha_
protected

Laminar thermal diffusivity [kg/m/s].

Definition at line 71 of file basicThermo.H.

◆ dpdt_

Switch dpdt_
protected

Should the dpdt term be included in the enthalpy equation.

Definition at line 75 of file basicThermo.H.

Referenced by basicThermo::dpdt().

◆ dictName

const Foam::word dictName
static

Definition at line 185 of file basicThermo.H.


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