Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
basicThermo Class Referenceabstract

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

Inheritance diagram for basicThermo:
Inheritance graph
[legend]
Collaboration diagram for basicThermo:
Collaboration graph
[legend]

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 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 volScalarFieldp ()
 Pressure [Pa]. More...
 
virtual const volScalarFieldp () const
 Pressure [Pa]. 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 &p, const scalarField &T, const labelList &cells) const =0
 Enthalpy/Internal energy for cell-set [J/kg]. More...
 
virtual tmp< scalarFieldhe (const scalarField &p, const scalarField &T, const label patchi) const =0
 Enthalpy/Internal energy for patch [J/kg]. More...
 
virtual tmp< volScalarFieldhc () const =0
 Chemical enthalpy [J/kg]. More...
 
virtual tmp< scalarFieldTHE (const scalarField &h, const scalarField &p, 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 &p, 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 &p, 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 &p, const scalarField &T, const label patchi) const =0
 Heat capacity at constant volume for patch [J/kg/K]. More...
 
virtual tmp< volScalarFieldgamma () const =0
 Gamma = Cp/Cv []. More...
 
virtual tmp< scalarFieldgamma (const scalarField &p, const scalarField &T, const label patchi) const =0
 Gamma = Cp/Cv for patch []. More...
 
virtual tmp< volScalarFieldCpv () const =0
 Heat capacity at constant pressure/volume [J/kg/K]. More...
 
virtual tmp< scalarFieldCpv (const scalarField &p, 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 &p, 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 [J/m/s/K]. More...
 
virtual tmp< scalarFieldkappa (const label patchi) const =0
 Thermal diffusivity for temperature. More...
 
virtual tmp< volScalarFieldkappaEff (const volScalarField &) const =0
 Effective thermal diffusivity for temperature. More...
 
virtual tmp< scalarFieldkappaEff (const scalarField &alphat, const label patchi) const =0
 Effective thermal diffusivity for temperature. More...
 
virtual tmp< volScalarFieldalphaEff (const volScalarField &alphat) const =0
 Effective thermal diffusivity of mixture [kg/m/s]. More...
 
virtual tmp< scalarFieldalphaEff (const scalarField &alphat, const label patchi) const =0
 Effective thermal diffusivity 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
 TypeName ("dictionary")
 
 IOdictionary (const IOobject &)
 Construct given an IOobject. More...
 
 IOdictionary (const IOobject &, const dictionary &)
 Construct given an IOobject and dictionary. More...
 
 IOdictionary (const IOobject &, Istream &)
 Construct given an IOobject and Istream. More...
 
virtual ~IOdictionary ()
 Destructor. More...
 
const wordname () const
 Name function is needed to disambiguate those inherited. More...
 
bool readData (Istream &)
 ReadData function required for regIOobject read operation. More...
 
bool writeData (Ostream &) const
 WriteData function required for regIOobject write operation. More...
 
void operator= (const IOdictionary &)
 Assignment of other IOdictionary's entries to this IOdictionary. More...
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the. More...
 
 regIOobject (const regIOobject &)
 Construct as copy. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Construct as copy, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Construct as copy with new name, transfering registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Construct as copy with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
void store ()
 Transfer ownership of this object to its registry. More...
 
void release ()
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
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...
 
IstreamreadStream (const word &)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
label watchIndex () const
 Return file-monitoring handle. More...
 
labelwatchIndex ()
 Return file-monitoring handle. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const
 Write using given format, version and compression. More...
 
virtual bool write () const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &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...
 
Foam::autoPtr< IOobjectclone () const
 Clone. 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...
 
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...
 
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 objectPath () const
 Return complete path + object name. More...
 
fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read and check header info. More...
 
bool writeHeader (Ostream &) const
 Write header. More...
 
bool writeHeader (Ostream &, const word &objectType) const
 Write header. Allow override of type. More...
 
bool good () const
 
bool bad () const
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 
- Public Member Functions inherited from dictionary
 ClassName ("dictionary")
 
 dictionary ()
 Construct top-level dictionary null. More...
 
 dictionary (const fileName &name)
 Construct top-level empty dictionary with given name. More...
 
 dictionary (const fileName &name, const dictionary &parentDict, Istream &)
 Construct given the entry name, parent dictionary and Istream,. More...
 
 dictionary (Istream &)
 Construct top-level dictionary from Istream,. More...
 
 dictionary (Istream &, const bool keepHeader)
 Construct top-level dictionary from Istream,. More...
 
 dictionary (const dictionary &parentDict, const dictionary &)
 Construct as copy given the parent dictionary. More...
 
 dictionary (const dictionary &)
 Construct top-level dictionary as copy. More...
 
 dictionary (const dictionary *)
 Construct top-level dictionary as copy from pointer to dictionary. More...
 
 dictionary (const dictionary &parentDict, const Xfer< dictionary > &)
 Construct by transferring parameter contents given parent dictionary. More...
 
 dictionary (const Xfer< dictionary > &)
 Construct top-level dictionary by transferring parameter contents. More...
 
autoPtr< dictionaryclone () const
 Construct and return clone. More...
 
virtual ~dictionary ()
 Destructor. More...
 
const dictionaryparent () const
 Return the parent dictionary. 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 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...
 
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...
 
wordList toc () const
 Return the 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...
 
Xfer< dictionaryxfer ()
 Transfer contents to the Xfer container. More...
 
bool read (Istream &)
 Read dictionary from Istream. More...
 
bool read (Istream &, const bool keepHeader)
 Read dictionary from Istream, optionally keeping the header. More...
 
void write (Ostream &, const bool subDict=true) const
 Write dictionary, normally with sub-dictionary formatting. More...
 
ITstreamoperator[] (const word &) const
 Find and return entry. More...
 
void operator= (const dictionary &)
 
void operator+= (const dictionary &)
 Include entries from the given dictionary. More...
 
void operator|= (const dictionary &)
 Conditionally include entries from the given dictionary. More...
 
void operator<<= (const dictionary &)
 Unconditionally include entries from the given dictionary. More...
 
- Public Member Functions inherited from dictionaryName
 dictionaryName ()
 Construct dictionaryName null. More...
 
 dictionaryName (const fileName &name)
 Construct dictionaryName as copy of the given fileName. More...
 
const 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...
 
- Public Member Functions inherited from IDLList< entry >
 IDLList ()
 Null construct. More...
 
 IDLList (const entry &a)
 Construct given initial T. More...
 
 IDLList (Istream &is, const INew &inewt)
 Construct from Istream using given Istream constructor class. More...
 
 IDLList (Istream &is)
 Construct from Istream. More...
 
 IDLList (const IDLList< entry > &idll, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone. More...
 
- Public Member Functions inherited from ILList< DLListBase, entry >
 ILList ()
 Null construct. More...
 
 ILList (entry *a)
 Construct given initial T. More...
 
 ILList (Istream &)
 Construct from Istream. More...
 
 ILList (const ILList< DLListBase, entry > &)
 Construct as copy. More...
 
 ILList (const ILList< DLListBase, entry > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone. More...
 
 ILList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class. More...
 
 ~ILList ()
 Destructor. More...
 
bool eraseHead ()
 Remove the head element specified from the list and delete it. More...
 
bool erase (entry *p)
 Remove the specified element from the list and delete it. More...
 
void clear ()
 Clear the contents of the list. More...
 
void transfer (ILList< DLListBase, entry > &)
 Transfer the contents of the argument into this List. More...
 
void operator= (const ILList< DLListBase, entry > &)
 
- Public Member Functions inherited from UILList< DLListBase, entry >
 UILList ()
 Null construct. More...
 
 UILList (entry *a)
 Construct given initial T. More...
 
 UILList (const UILList< DLListBase, entry > &)
 Construct as copy. More...
 
entryfirst ()
 Return the first entry. More...
 
const entryfirst () const
 Return the first entry. More...
 
entrylast ()
 Return the last entry. More...
 
const entrylast () const
 Return the last entry. More...
 
entryremoveHead ()
 Remove and return head. More...
 
entryremove (entry *p)
 Remove and return element. More...
 
entryremove (iterator &it)
 Remove and return specified by iterator. More...
 
void operator= (const UILList< DLListBase, entry > &)
 
iterator begin ()
 
const_iterator begin () const
 
const iteratorend ()
 
const const_iteratorend () const
 
const_iterator cbegin () const
 
const const_iteratorcend () 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< DLListBase, entry > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UILList< DLListBase, entry > &) const
 The opposite of the equality operation. Takes linear time. More...
 
- Public Member Functions inherited from DLListBase
 DLListBase ()
 Null construct. More...
 
 DLListBase (link *)
 Construct given initial entry. More...
 
 ~DLListBase ()
 Destructor. More...
 
label size () const
 Return number of elements in list. More...
 
bool empty () const
 Return true if the list is empty. More...
 
linkfirst ()
 Return first entry. More...
 
const linkfirst () const
 Return const access to first entry. More...
 
linklast ()
 Return last entry. More...
 
const linklast () const
 Return const access to last entry. More...
 
void insert (link *)
 Add at head of list. More...
 
void append (link *)
 Add at tail of list. More...
 
bool swapUp (link *)
 Swap this element with the one above unless it is at the top. More...
 
bool swapDown (link *)
 Swap this element with the one below unless it is at the bottom. More...
 
linkremoveHead ()
 Remove and return head. More...
 
linkremove (link *)
 Remove and return element. More...
 
linkremove (iterator &)
 
linkreplace (link *oldLink, link *newLink)
 Replace oldLink with newLink and return element. More...
 
linkreplace (iterator &oldIter, link *newLink)
 Replace oldIter with newLink and return element. More...
 
void clear ()
 Clear the list. More...
 
void transfer (DLListBase &)
 Transfer the contents of the argument into this List. More...
 
iterator begin ()
 
const 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
 

Static Public Member Functions

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)
 
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 const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static int fileModificationSkew
 
static fileCheckTypes fileModificationChecking
 
- Static Public Attributes inherited from dictionary
static const dictionary null
 Null dictionary. More...
 

Protected Member Functions

 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 IOobject
IstreamobjectStream ()
 Construct and return an IFstream for the object. More...
 
IstreamobjectStream (const fileName &)
 Construct and return an IFstream for the object given the. More...
 
void setBad (const string &)
 Set the object state to bad. More...
 

Protected Attributes

const wordphaseName_
 Phase-name. More...
 
volScalarFieldp_
 Pressure [Pa]. More...
 
volScalarField T_
 Temperature [K]. More...
 
volScalarField alpha_
 Laminar thermal diffusuvity [kg/m/s]. More...
 
Switch dpdt_
 Should the dpdt term be included in the enthalpy equation. More...
 

Additional Inherited Members

- Public Types inherited from regIOobject
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Types of communications. More...
 
- Public Types inherited from IOobject
enum  objectState { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
- Public Types inherited from UILList< DLListBase, entry >
typedef entry value_type
 Type of values the DLList contains. More...
 
typedef entryreference
 Type that can be used for storing into DLList::value_type. More...
 
typedef const entryconst_reference
 Type that can be used for storing into constant. More...
 
typedef label size_type
 The type that can represent the size of a DLList. More...
 
typedef DLListBase::iterator LListBase_iterator
 
typedef DLListBase::const_iterator LListBase_const_iterator
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

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 ( const basicThermo )
protected

Construct as copy (not implemented)

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

Here is the caller graph for this function:

basicThermo ( const fvMesh mesh,
const word phaseName 
)

Construct from mesh and phase name.

Definition at line 163 of file basicThermo.C.

References basicThermo::basicThermo().

Here is the call graph for this function:

basicThermo ( const fvMesh mesh,
const dictionary dict,
const word phaseName 
)

Construct from mesh, dictionary and phase name.

Definition at line 216 of file basicThermo.C.

References basicThermo::New().

Here is the call graph for this function:

~basicThermo ( )
virtual

Destructor.

Definition at line 282 of file basicThermo.C.

References basicThermo::lookupThermo().

Here is the call graph for this function:

Member Function Documentation

Foam::volScalarField & lookupOrConstruct ( const fvMesh mesh,
const char *  name 
) const
protected

Definition at line 128 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:

Foam::wordList heBoundaryTypes ( )
protected

Return the enthalpy/internal energy field boundary types.

by interrogating the temperature field boundary types

Definition at line 82 of file basicThermo.C.

References forAll, basicThermo::lookupOrConstruct(), patchi, Foam::type(), and Field< Type >::typeName.

Here is the call graph for this function:

Foam::wordList heBoundaryBaseTypes ( )
protected

Return the enthalpy/internal energy field boundary base types.

by interrogating the temperature field boundary types

Definition at line 50 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.

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

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

Generic New for each of the related thermodynamics packages.

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

Specialisation of the Generic New for basicThermo.

Definition at line 271 of file basicThermo.C.

References mesh.

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

Definition at line 179 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:

word phasePropertyName ( const word name) const
inline
const Foam::basicThermo & lookupThermo ( const fvPatchScalarField pf)
static
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 325 of file basicThermo.C.

References Foam::exit(), Foam::FatalError, FatalErrorIn, 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:

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 340 of file basicThermo.C.

References Foam::exit(), Foam::FatalError, FatalErrorIn, he, Foam::name(), IOobject::name(), and basicThermo::validate().

Here is the call graph for this function:

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 363 of file basicThermo.C.

References Foam::exit(), Foam::FatalError, FatalErrorIn, he, Foam::name(), IOobject::name(), and basicThermo::validate().

Here is the call graph for this function:

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 389 of file basicThermo.C.

References Foam::exit(), Foam::FatalError, FatalErrorIn, he, Foam::name(), IOobject::name(), and basicThermo::splitThermoName().

Here is the call graph for this function:

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

virtual void correct ( )
pure virtual

Update properties.

Implemented in multiphaseMixtureThermo, twoPhaseMixtureThermo, and psiuReactionThermo.

Referenced by reactingOneDim::evolveRegion(), and basicThermo::phasePropertyName().

Here is the caller graph for this function:

virtual bool incompressible ( ) const
pure virtual

Return true if the equation of state is incompressible.

i.e. rho != f(p)

Implemented in multiphaseMixtureThermo, and twoPhaseMixtureThermo.

Referenced by basicThermo::phasePropertyName().

Here is the caller graph for this function:

virtual bool isochoric ( ) const
pure virtual

Return true if the equation of state is isochoric.

i.e. rho = const

Implemented in multiphaseMixtureThermo, and twoPhaseMixtureThermo.

Referenced by basicThermo::phasePropertyName().

Here is the caller graph for this function:

Switch dpdt ( ) const
inline
Foam::volScalarField & p ( )
virtual
const Foam::volScalarField & p ( ) const
virtual

Pressure [Pa].

Definition at line 472 of file basicThermo.C.

virtual tmp<volScalarField> rho ( ) const
pure virtual

Density [kg/m^3].

Implemented in multiphaseMixtureThermo, solidThermo, rhoThermo, and psiThermo.

Referenced by basicThermo::dpdt(), and fluidThermo::nu().

Here is the caller graph for this function:

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

Density for patch [kg/m^3].

Implemented in multiphaseMixtureThermo, solidThermo, rhoThermo, and psiThermo.

virtual volScalarField& he ( )
pure virtual
virtual const volScalarField& he ( ) const
pure virtual

Enthalpy/Internal energy [J/kg].

Implemented in multiphaseMixtureThermo, and twoPhaseMixtureThermo.

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, and twoPhaseMixtureThermo.

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

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

Implemented in multiphaseMixtureThermo, and twoPhaseMixtureThermo.

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

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

Implemented in multiphaseMixtureThermo, and twoPhaseMixtureThermo.

virtual tmp<volScalarField> hc ( ) const
pure virtual

Chemical enthalpy [J/kg].

Implemented in multiphaseMixtureThermo, and twoPhaseMixtureThermo.

Referenced by basicThermo::dpdt().

Here is the caller graph for this function:

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

Temperature from enthalpy/internal energy for cell-set.

Implemented in multiphaseMixtureThermo, and twoPhaseMixtureThermo.

Referenced by basicThermo::dpdt().

Here is the caller graph for this function:

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

Temperature from enthalpy/internal energy for patch.

Implemented in multiphaseMixtureThermo, and twoPhaseMixtureThermo.

const Foam::volScalarField & T ( ) const
virtual
Foam::volScalarField & T ( )
virtual

Temperature [K].

Non-const access allowed for transport equations

Definition at line 484 of file basicThermo.C.

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

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

Implemented in multiphaseMixtureThermo, and twoPhaseMixtureThermo.

virtual tmp<volScalarField> Cv ( ) const
pure virtual

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

Implemented in multiphaseMixtureThermo, and twoPhaseMixtureThermo.

Referenced by basicThermo::dpdt().

Here is the caller graph for this function:

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

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

Implemented in multiphaseMixtureThermo, and twoPhaseMixtureThermo.

virtual tmp<volScalarField> gamma ( ) const
pure virtual

Gamma = Cp/Cv [].

Implemented in multiphaseMixtureThermo, and twoPhaseMixtureThermo.

Referenced by basicThermo::dpdt().

Here is the caller graph for this function:

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

Gamma = Cp/Cv for patch [].

Implemented in multiphaseMixtureThermo, and twoPhaseMixtureThermo.

virtual tmp<volScalarField> Cpv ( ) const
pure virtual

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

Implemented in multiphaseMixtureThermo, and twoPhaseMixtureThermo.

Referenced by interRegionHeatTransferModel::addSup(), basicThermo::dpdt(), radiationModel::Sh(), mixedEnergyFvPatchScalarField::updateCoeffs(), and gradientEnergyFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

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

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

Implemented in multiphaseMixtureThermo, and twoPhaseMixtureThermo.

virtual tmp<volScalarField> CpByCpv ( ) const
pure virtual

Heat capacity ratio [].

Implemented in multiphaseMixtureThermo, and twoPhaseMixtureThermo.

Referenced by basicThermo::dpdt().

Here is the caller graph for this function:

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

Heat capacity ratio for patch [].

Implemented in multiphaseMixtureThermo, and twoPhaseMixtureThermo.

const Foam::volScalarField & alpha ( ) const
virtual

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

Definition at line 490 of file basicThermo.C.

Referenced by basicThermo::dpdt(), reactingOneDim::solveEnergy(), and externalCoupledTemperatureMixedFvPatchScalarField::transferData().

Here is the caller graph for this function:

const Foam::scalarField & alpha ( const label  patchi) const
virtual

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

Definition at line 496 of file basicThermo.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), and patchi.

Here is the call graph for this function:

virtual tmp<volScalarField> kappa ( ) const
pure virtual

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

Implemented in multiphaseMixtureThermo, and twoPhaseMixtureThermo.

Referenced by basicThermo::dpdt(), temperatureCoupledBase::kappa(), reactingOneDim::kappa(), and NamedEnum< Enum, nEnum >::names().

Here is the caller graph for this function:

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

Thermal diffusivity for temperature.

of mixture for patch [J/m/s/K]

Implemented in multiphaseMixtureThermo, and twoPhaseMixtureThermo.

virtual tmp<volScalarField> kappaEff ( const volScalarField ) const
pure virtual

Effective thermal diffusivity for temperature.

of mixture [J/m/s/K]

Implemented in multiphaseMixtureThermo, and twoPhaseMixtureThermo.

Referenced by basicThermo::dpdt().

Here is the caller graph for this function:

virtual tmp<scalarField> kappaEff ( const scalarField alphat,
const label  patchi 
) const
pure virtual

Effective thermal diffusivity for temperature.

of mixture for patch [J/m/s/K]

Implemented in multiphaseMixtureThermo, and twoPhaseMixtureThermo.

virtual tmp<volScalarField> alphaEff ( const volScalarField alphat) const
pure virtual

Effective thermal diffusivity of mixture [kg/m/s].

Implemented in multiphaseMixtureThermo, and twoPhaseMixtureThermo.

Referenced by basicThermo::dpdt().

Here is the caller graph for this function:

virtual tmp<scalarField> alphaEff ( const scalarField alphat,
const label  patchi 
) const
pure virtual

Effective thermal diffusivity of mixture for patch [kg/m/s].

Implemented in multiphaseMixtureThermo, and twoPhaseMixtureThermo.

bool read ( )
virtual

Read thermophysical properties dictionary.

Reimplemented from regIOobject.

Reimplemented in solidThermo.

Definition at line 502 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:

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

Definition at line 138 of file basicThermoTemplates.C.

References TimePaths::constant(), dictName(), mesh, basicThermo::New(), and fvMesh::time().

Here is the call graph for this function:

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

Definition at line 169 of file basicThermoTemplates.C.

References dict, and mesh.

Member Data Documentation

const word& phaseName_
protected

Phase-name.

Definition at line 62 of file basicThermo.H.

volScalarField& p_
protected

Pressure [Pa].

Definition at line 68 of file basicThermo.H.

Referenced by psiThermo::rho(), psiuReactionThermo::rhob(), and psiuReactionThermo::rhou().

volScalarField T_
protected

Temperature [K].

Definition at line 71 of file basicThermo.H.

volScalarField alpha_
protected

Laminar thermal diffusuvity [kg/m/s].

Definition at line 74 of file basicThermo.H.

Switch dpdt_
protected

Should the dpdt term be included in the enthalpy equation.

Definition at line 77 of file basicThermo.H.

Referenced by basicThermo::dpdt().

const Foam::word dictName
static

Definition at line 176 of file basicThermo.H.


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