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")
 
 declareRunTimeSelectionTable (autoPtr, basicThermo, fvMesh,(const fvMesh &mesh, const word &phaseName),(mesh, phaseName))
 
 declareRunTimeSelectionTable (autoPtr, basicThermo, fvMeshDictPhase,(const fvMesh &mesh, const word &phaseName, const word &dictName),(mesh, phaseName, dictName))
 
 basicThermo (const fvMesh &, const word &phaseName)
 
 basicThermo (const fvMesh &, const dictionary &, const word &phaseName)
 
 basicThermo (const fvMesh &, const word &phaseName, const word &dictionaryName)
 
virtual ~basicThermo ()
 
word phasePropertyName (const word &name) const
 
void validate (const string &app, const word &) const
 
void validate (const string &app, const word &, const word &) const
 
void validate (const string &app, const word &, const word &, const word &) const
 
void validate (const string &app, const word &, const word &, const word &, const word &) const
 
virtual void correct ()=0
 
virtual word thermoName () const =0
 
virtual bool incompressible () const =0
 
virtual bool isochoric () const =0
 
bool dpdt () const noexcept
 
bool updateT () const noexcept
 
virtual volScalarFieldp ()
 
virtual const volScalarFieldp () const
 
virtual tmp< volScalarFieldrho () const =0
 
virtual tmp< scalarFieldrho (const label patchi) const =0
 
virtual volScalarFieldhe ()=0
 
virtual const volScalarFieldhe () const =0
 
virtual tmp< volScalarFieldhe (const volScalarField &p, const volScalarField &T) const =0
 
virtual tmp< scalarFieldhe (const scalarField &p, const scalarField &T, const labelList &cells) const =0
 
virtual tmp< scalarFieldhe (const scalarField &p, const scalarField &T, const label patchi) const =0
 
virtual tmp< volScalarFieldhc () const =0
 
virtual tmp< scalarFieldTHE (const scalarField &h, const scalarField &p, const scalarField &T0, const labelList &cells) const =0
 
virtual tmp< scalarFieldTHE (const scalarField &h, const scalarField &p, const scalarField &T0, const label patchi) const =0
 
virtual const volScalarFieldT () const
 
virtual volScalarFieldT ()
 
virtual tmp< volScalarFieldCp () const =0
 
virtual tmp< scalarFieldCp (const scalarField &p, const scalarField &T, const label patchi) const =0
 
virtual tmp< scalarFieldCp (const scalarField &p, const scalarField &T, const labelList &cells) const =0
 
virtual tmp< volScalarFieldCv () const =0
 
virtual tmp< scalarFieldCv (const scalarField &p, const scalarField &T, const label patchi) const =0
 
virtual tmp< scalarFieldrhoEoS (const scalarField &p, const scalarField &T, const labelList &cells) const =0
 
virtual tmp< volScalarFieldgamma () const =0
 
virtual tmp< scalarFieldgamma (const scalarField &p, const scalarField &T, const label patchi) const =0
 
virtual tmp< volScalarFieldCpv () const =0
 
virtual tmp< scalarFieldCpv (const scalarField &p, const scalarField &T, const label patchi) const =0
 
virtual tmp< volScalarFieldCpByCpv () const =0
 
virtual tmp< scalarFieldCpByCpv (const scalarField &p, const scalarField &T, const label patchi) const =0
 
virtual tmp< volScalarFieldW () const =0
 
virtual const volScalarFieldalpha () const
 
virtual const scalarFieldalpha (const label patchi) const
 
virtual tmp< volScalarFieldkappa () const =0
 
virtual tmp< scalarFieldkappa (const label patchi) const =0
 
virtual tmp< volScalarFieldalphahe () const =0
 
virtual tmp< scalarFieldalphahe (const label patchi) const =0
 
virtual tmp< volScalarFieldkappaEff (const volScalarField &) const =0
 
virtual tmp< scalarFieldkappaEff (const scalarField &alphat, const label patchi) const =0
 
virtual tmp< volScalarFieldalphaEff (const volScalarField &alphat) const =0
 
virtual tmp< scalarFieldalphaEff (const scalarField &alphat, const label patchi) const =0
 
virtual bool read ()
 
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)
 
template<class Thermo >
Foam::autoPtr< Thermo > New (const fvMesh &mesh, const word &phaseName, const word &dictName)
 
- Public Member Functions inherited from IOdictionary
 IOdictionary (const IOobject &io, const dictionary *fallback=nullptr)
 
 IOdictionary (const IOobject &io, const dictionary &dict)
 
 IOdictionary (const IOobject &io, const word &wantedType, const dictionary *fallback=nullptr)
 
 IOdictionary (const IOobject &io, Istream &is)
 
virtual ~IOdictionary ()=default
 
virtual bool global () const
 
virtual fileName filePath () const
 
- Public Member Functions inherited from baseIOdictionary
 TypeName ("dictionary")
 
 baseIOdictionary (const baseIOdictionary &)=default
 
 baseIOdictionary (baseIOdictionary &&)=default
 
virtual ~baseIOdictionary ()=default
 
 baseIOdictionary (const IOobject &io, const dictionary *fallback=nullptr)
 
 baseIOdictionary (const IOobject &io, const dictionary &dict)
 
 baseIOdictionary (const IOobject &io, Istream &is)
 
const wordname () const
 
virtual bool readData (Istream &)
 
virtual bool writeData (Ostream &) const
 
void operator= (const baseIOdictionary &rhs)
 
void operator= (const dictionary &rhs)
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 
 regIOobject (const IOobject &io, const bool isTimeObject=false)
 
 regIOobject (const regIOobject &rio)
 
 regIOobject (const regIOobject &rio, bool registerCopy)
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 
 regIOobject (const IOobject &io, const regIOobject &rio)
 
virtual ~regIOobject ()
 
bool checkIn ()
 
bool checkOut ()
 
virtual void addWatch ()
 
bool ownedByRegistry () const
 
bool store ()
 
void release (const bool unregister=false)
 
label eventNo () const
 
label & eventNo ()
 
bool upToDate (const regIOobject &) const
 
bool upToDate (const regIOobject &, const regIOobject &) const
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 
void setUpToDate ()
 
virtual void rename (const word &newName)
 
const dictionaryfindMetaData () const noexcept
 
dictionarygetMetaData () noexcept
 
void removeMetaData ()
 
virtual void updateMetaData ()
 
bool headerOk ()
 
IstreamreadStream (const word &, const bool valid=true)
 
void close ()
 
virtual label addWatch (const fileName &)
 
const labelListwatchIndices () const
 
labelListwatchIndices ()
 
virtual bool modified () const
 
virtual bool readIfModified ()
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 
virtual bool write (const bool valid=true) const
 
void operator= (const IOobject &io)
 
virtual bool writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 
 IOobject (const IOobject &)=default
 
virtual ~IOobject ()=default
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 
 IOobject (const IOobject &io, const word &name)
 
 IOobject (const IOobject &io, readOption, writeOption)
 
autoPtr< IOobjectclone () const
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 
const objectRegistrydb () const noexcept
 
const Timetime () const
 
const wordname () const noexcept
 
const wordheaderClassName () const noexcept
 
wordheaderClassName () noexcept
 
const stringnote () const noexcept
 
stringnote () noexcept
 
bool registerObject () const noexcept
 
bool registerObject (bool on) noexcept
 
bool globalObject () const noexcept
 
bool globalObject (bool on) noexcept
 
unsigned labelByteSize () const noexcept
 
unsigned scalarByteSize () const noexcept
 
bool isHeaderClassName (const word &clsName) const
 
template<class Type >
bool isHeaderClassName () const
 
readOption readOpt () const noexcept
 
readOption readOpt (readOption opt) noexcept
 
writeOption writeOpt () const noexcept
 
writeOption writeOpt (writeOption opt) noexcept
 
word group () const
 
word member () const
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const noexcept
 
fileNameinstance () noexcept
 
const fileNamelocal () const noexcept
 
fileName path () const
 
fileName path (const word &instance, const fileName &local=fileName::null) const
 
fileName objectPath () const
 
fileName objectRelPath () const
 
fileName localFilePath (const word &typeName, const bool search=true) const
 
fileName globalFilePath (const word &typeName, const bool search=true) const
 
IOstreamOption parseHeader (const dictionary &headerDict)
 
bool readHeader (Istream &is)
 
bool readHeader (dictionary &headerDict, Istream &is)
 
template<class Type >
bool typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
 
template<class Type >
void warnNoRereading () const
 
bool writeHeader (Ostream &os) const
 
bool writeHeader (Ostream &os, const word &objectType) const
 
void writeHeader (dictionary &dict, IOstreamOption streamOpt) const
 
void writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
 
bool good () const noexcept
 
bool bad () const noexcept
 
InfoProxy< IOobjectinfo () const
 
void operator= (const IOobject &io)
 
readOptionreadOpt () noexcept
 
writeOptionwriteOpt () noexcept
 
boolregisterObject () noexcept
 
boolglobalObject () noexcept
 
template<>
bool isHeaderClassName () const
 
template<class StringType >
Foam::word groupName (StringType base, const word &group)
 
- Public Member Functions inherited from dictionary
 ClassName ("dictionary")
 
 dictionary ()
 
 dictionary (const fileName &name)
 
 dictionary (const fileName &name, const dictionary &parentDict, Istream &is, bool keepHeader=false)
 
 dictionary (Istream &is)
 
 dictionary (Istream &is, bool keepHeader)
 
 dictionary (const dictionary &parentDict, const dictionary &dict)
 
 dictionary (const dictionary &dict)
 
 dictionary (const dictionary *dict)
 
 dictionary (const dictionary &parentDict, dictionary &&dict)
 
 dictionary (dictionary &&dict)
 
autoPtr< dictionaryclone () const
 
virtual ~dictionary ()
 
const fileNamename () const noexcept
 
fileNamename () noexcept
 
word dictName () const
 
fileName relativeName (const bool caseTag=false) const
 
bool isNullDict () const noexcept
 
const dictionaryparent () const noexcept
 
const dictionarytopDict () const
 
label startLineNumber () const
 
label endLineNumber () const
 
SHA1Digest digest () const
 
tokenList tokens () const
 
bool found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
entryfindEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 
const entryfindEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
const entryfindScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
dictionaryfindDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 
const dictionaryfindDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
const entrylookupEntry (const word &keyword, enum keyType::option matchOpt) const
 
ITstreamlookup (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T get (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T getOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T getOrAdd (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T >
bool readEntry (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const
 
template<class T >
bool readIfPresent (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheck (const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheckOrDefault (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheckOrAdd (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T , class Predicate >
bool readCheck (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const
 
template<class T , class Predicate >
bool readCheckIfPresent (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
bool isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
const dictionarysubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
dictionarysubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 
dictionarysubDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 
dictionary subOrEmptyDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX, const bool mandatory=false) const
 
const dictionaryoptionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
wordList toc () const
 
wordList sortedToc () const
 
template<class Compare >
wordList sortedToc (const Compare &comp) const
 
List< keyTypekeys (bool patterns=false) const
 
bool substituteKeyword (const word &keyword, bool mergeEntry=false)
 
bool substituteScopedKeyword (const word &keyword, bool mergeEntry=false)
 
entryadd (entry *entryPtr, bool mergeEntry=false)
 
entryadd (const entry &e, bool mergeEntry=false)
 
entryadd (const keyType &k, const word &v, bool overwrite=false)
 
entryadd (const keyType &k, const string &v, bool overwrite=false)
 
entryadd (const keyType &k, const label v, bool overwrite=false)
 
entryadd (const keyType &k, const scalar v, bool overwrite=false)
 
entryadd (const keyType &k, const dictionary &d, bool mergeEntry=false)
 
template<class T >
entryadd (const keyType &k, const T &v, bool overwrite=false)
 
entryset (entry *entryPtr)
 
entryset (const entry &e)
 
entryset (const keyType &k, const dictionary &v)
 
template<class T >
entryset (const keyType &k, const T &v)
 
bool remove (const word &keyword)
 
bool changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false)
 
bool merge (const dictionary &dict)
 
void clear ()
 
void transfer (dictionary &dict)
 
void checkITstream (const ITstream &is, const word &keyword) const
 
bool read (Istream &is)
 
bool read (Istream &is, bool keepHeader)
 
void writeEntry (Ostream &os) const
 
void writeEntry (const keyType &keyword, Ostream &os) const
 
void writeEntries (Ostream &os, const bool extraNewLine=false) const
 
void write (Ostream &os, const bool subDict=true) const
 
const_searcher csearch (const word &keyword, enum keyType::option=keyType::REGEX) const
 
const_searcher search (const word &keyword, enum keyType::option=keyType::REGEX) const
 
searcher search (const word &keyword, enum keyType::option=keyType::REGEX)
 
const_searcher csearchScoped (const word &keyword, enum keyType::option) const
 
const_searcher searchScoped (const word &keyword, enum keyType::option) const
 
searcher searchScoped (const word &keyword, enum keyType::option)
 
const dictionarycfindScopedDict (const fileName &dictPath) const
 
const dictionaryfindScopedDict (const fileName &dictPath) const
 
dictionaryfindScopedDict (const fileName &dictPath)
 
dictionarymakeScopedDict (const fileName &dictPath)
 
const_searcher csearchCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
bool foundCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
const entryfindCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const
 
const entrylookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const
 
ITstreamlookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
template<class T >
T getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
template<class T >
T getOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option=keyType::REGEX) const
 
template<class T >
bool readCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX, bool mandatory=true) const
 
template<class T >
bool readIfPresentCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX) const
 
void operator= (const dictionary &rhs)
 
void operator+= (const dictionary &rhs)
 
void operator|= (const dictionary &rhs)
 
void operator<<= (const dictionary &rhs)
 
template<class T >
T lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T >
T lookupOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
ITstreamoperator[] (const word &keyword) const
 
bool found (const word &keyword, bool recursive, bool patternMatch=true) const
 
entrylookupEntryPtr (const word &keyword, bool recursive, bool patternMatch)
 
const entrylookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
 
const entrylookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
 
const dictionarysubDictPtr (const word &keyword) const
 
dictionarysubDictPtr (const word &keyword)
 
const entrylookupEntry (const word &keyword, bool recursive, bool patternMatch) const
 
ITstreamlookup (const word &keyword, bool recursive, bool patternMatch=true) const
 
template<class T >
T lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const
 
template<class T >
T lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true)
 
template<class T >
bool readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const
 
template<class T >
T lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const
 
bool getBool (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< bool >(const word&, keyType::option) More...
 
label getLabel (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< label >(const word&, keyType::option) More...
 
scalar getScalar (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< scalar >(const word&, keyType::option) More...
 
string getString (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< string >(const word&, keyType::option) More...
 
word getWord (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< word >(const word&, keyType::option) More...
 
fileName getFileName (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< fileName >(const word&, keyType::option) More...
 
template<class Compare >
Foam::wordList sortedToc (const Compare &comp) const
 
template<class T >
Foam::entryadd (const keyType &k, const T &v, bool overwrite)
 
template<class T >
Foam::entryset (const keyType &k, const T &v)
 
- Public Member Functions inherited from ILList
 ILList ()=default
 
 ILList (T *item)
 
 ILList (Istream &is)
 
 ILList (const ILList< LListBase, T > &lst)
 
 ILList (ILList< LListBase, T > &&lst)
 
template<class CloneArg >
 ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
 
template<class INew >
 ILList (Istream &is, const INew &inew)
 
 ~ILList ()
 
bool eraseHead ()
 
bool erase (T *item)
 
void clear ()
 
void transfer (ILList< LListBase, T > &lst)
 
void operator= (const ILList< LListBase, T > &lst)
 
void operator= (ILList< LListBase, T > &&lst)
 

Static Public Member Functions

template<class Thermo >
static autoPtr< Thermo > New (const fvMesh &, const word &phaseName=word::null)
 
template<class Thermo >
static autoPtr< Thermo > New (const fvMesh &, const dictionary &, const word &phaseName=word::null)
 
template<class Thermo >
static autoPtr< Thermo > New (const fvMesh &, const word &phaseName, const word &dictName)
 
static autoPtr< basicThermoNew (const fvMesh &, const word &phaseName=word::null)
 
static word phasePropertyName (const word &name, const word &phaseName)
 
static const basicThermolookupThermo (const fvPatchScalarField &pf)
 
static OstreamprintThermoNames (Ostream &os, const wordList &cmptNames, const wordList &thermoNames)
 
static wordList splitThermoName (const std::string &thermoName, const int nExpectedCmpts)
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *p)
 
template<class Type >
static Type & store (autoPtr< Type > &ptr)
 
template<class Type >
static Type & store (autoPtr< Type > &&ptr)
 
template<class Type >
static Type & store (refPtr< Type > &ptr)
 
template<class Type >
static Type & store (refPtr< Type > &&ptr)
 
template<class Type >
static Type & store (tmp< Type > &ptr)
 
template<class Type >
static Type & store (tmp< Type > &&ptr)
 
- Static Public Member Functions inherited from IOobject
static bool bannerEnabled () noexcept
 
static bool bannerEnabled (bool on) noexcept
 
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 
template<class StringType >
static word groupName (StringType base, const word &group)
 
static word group (const word &name)
 
static word member (const word &name)
 
static word scopedName (const std::string &scope, const word &name)
 
static IOobject selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
 
static OstreamwriteBanner (Ostream &os, const bool noSyntaxHint=false)
 
static OstreamwriteDivider (Ostream &os)
 
static OstreamwriteEndDivider (Ostream &os)
 
- Static Public Member Functions inherited from dictionary
static int reportOptional () noexcept
 
static int reportOptional (const int level) noexcept
 
static autoPtr< dictionaryNew (Istream &is)
 

Static Public Attributes

static const word dictName
 
- Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypesfileCheckTypesNames
 
static char scopeSeparator
 
static fileCheckTypes fileModificationChecking
 
static float fileModificationSkew
 
static int maxFileModificationPolls
 
- Static Public Attributes inherited from dictionary
static int writeOptionalEntries
 
static const dictionary null
 
static refPtr< OSstreamreportingOutput
 

Protected Member Functions

wordList heBoundaryTypes ()
 
wordList heBoundaryBaseTypes ()
 
 basicThermo (const basicThermo &)=delete
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
 
- Protected Member Functions inherited from IOobject
void setBad (const string &s)
 

Protected Attributes

const wordphaseName_
 
bool pOwner_
 
bool TOwner_
 
bool dpdt_
 
volScalarFieldp_
 
volScalarFieldT_
 
volScalarField alpha_
 

Additional Inherited Members

- Public Types inherited from IOobject
enum  objectState : char { GOOD, BAD }
 
enum  readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 
enum  writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }
 
enum  fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
 
- Public Types inherited from dictionary
typedef Searcher< true > const_searcher
 
typedef Searcher< false > searcher
 
- Public Attributes inherited from dictionary
friend const_searcher
 
friend searcher
 
- Static Protected Member Functions inherited from IOobject
static void writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
 
static void writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 

Detailed Description

Abstract base-class for fluid and solid thermodynamic properties.

An important concept is that the thermo can share an existing T (similar to p) in which case it will not try to update it. This gets triggered purely on construction order - the first one to register T is responsible for updating it. Note that the mechanism also means that if multiple thermos are running on the same mesh, only the first one will update the temperature. The behaviour can be overridden using the 'updateT' dictionary entry.

Source files

Definition at line 59 of file basicThermo.H.

Constructor & Destructor Documentation

◆ basicThermo() [1/4]

basicThermo ( const basicThermo )
protecteddelete

◆ basicThermo() [2/4]

basicThermo ( const fvMesh mesh,
const word phaseName 
)

Definition at line 268 of file basicThermo.C.

◆ basicThermo() [3/4]

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

Definition at line 313 of file basicThermo.C.

◆ basicThermo() [4/4]

basicThermo ( const fvMesh mesh,
const word phaseName,
const word dictionaryName 
)

Definition at line 360 of file basicThermo.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), mesh, fvMesh::name(), and Foam::Pout.

Here is the call graph for this function:

◆ ~basicThermo()

~basicThermo ( )
virtual

Definition at line 430 of file basicThermo.C.

Member Function Documentation

◆ heBoundaryTypes()

Foam::wordList heBoundaryTypes ( )
protected

Definition at line 191 of file basicThermo.C.

References forAll, and GeometricField::Boundary::types().

Here is the call graph for this function:

◆ heBoundaryBaseTypes()

Foam::wordList heBoundaryBaseTypes ( )
protected

Definition at line 157 of file basicThermo.C.

References forAll.

◆ TypeName()

TypeName ( "basicThermo"  )

◆ declareRunTimeSelectionTable() [1/2]

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

◆ declareRunTimeSelectionTable() [2/2]

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

◆ New() [1/7]

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

◆ New() [2/7]

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

◆ New() [3/7]

static autoPtr<Thermo> New ( const fvMesh ,
const word phaseName,
const word dictName 
)
static

◆ New() [4/7]

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

Definition at line 419 of file basicThermo.C.

References mesh.

◆ phasePropertyName() [1/2]

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

Definition at line 255 of file basicThermo.H.

References IOobject::groupName(), and baseIOdictionary::name().

Here is the call graph for this function:

◆ phasePropertyName() [2/2]

word phasePropertyName ( const word name) const
inline

Definition at line 263 of file basicThermo.H.

References IOobject::groupName(), baseIOdictionary::name(), and basicThermo::phaseName_.

Here is the call graph for this function:

◆ lookupThermo()

const Foam::basicThermo & lookupThermo ( const fvPatchScalarField pf)
static

◆ printThermoNames()

Foam::Ostream & printThermoNames ( Ostream os,
const wordList cmptNames,
const wordList thermoNames 
)
static

Definition at line 68 of file basicThermo.C.

References os(), Foam::printTable(), and DynamicList::resize().

Referenced by basicSolidChemistryModel::New().

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

◆ validate() [1/4]

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

Definition at line 471 of file basicThermo.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, he, and Foam::name().

Here is the call graph for this function:

◆ validate() [2/4]

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

Definition at line 486 of file basicThermo.C.

References Foam::constant::physicoChemical::b, Foam::exit(), Foam::FatalError, FatalErrorInFunction, he, and Foam::name().

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

Definition at line 509 of file basicThermo.C.

References Foam::constant::physicoChemical::b, Foam::constant::universal::c, Foam::exit(), Foam::FatalError, FatalErrorInFunction, he, and Foam::name().

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

Definition at line 535 of file basicThermo.C.

References Foam::constant::physicoChemical::b, Foam::constant::universal::c, Foam::exit(), Foam::FatalError, FatalErrorInFunction, he, and Foam::name().

Here is the call graph for this function:

◆ splitThermoName()

Foam::wordList splitThermoName ( const std::string &  thermoName,
const int  nExpectedCmpts 
)
static

Definition at line 565 of file basicThermo.C.

References List::resize().

Here is the call graph for this function:

◆ correct()

virtual void correct ( )
pure virtual

Implemented in psiuReactionThermo, phaseSystem, phaseSystem, twoPhaseMixtureEThermo, multiphaseMixtureThermo, twoPhaseSystem, and twoPhaseMixtureThermo.

Referenced by radiation::addSup().

Here is the caller graph for this function:

◆ thermoName()

virtual word thermoName ( ) const
pure virtual

◆ incompressible()

virtual bool incompressible ( ) const
pure virtual

◆ isochoric()

virtual bool isochoric ( ) const
pure virtual

◆ dpdt()

bool dpdt ( ) const
inlinenoexcept

Definition at line 341 of file basicThermo.H.

References basicThermo::dpdt_.

Referenced by phaseModel::dpdt().

Here is the caller graph for this function:

◆ updateT()

bool updateT ( ) const
inlinenoexcept

Definition at line 347 of file basicThermo.H.

References basicThermo::TOwner_.

◆ p() [1/2]

const Foam::volScalarField & p ( )
virtual

◆ p() [2/2]

virtual const volScalarField& p ( ) const
virtual

◆ rho() [1/2]

virtual tmp<volScalarField> rho ( ) const
pure virtual

◆ rho() [2/2]

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

◆ he() [1/5]

virtual volScalarField& he ( )
pure virtual

◆ he() [2/5]

virtual const volScalarField& he ( ) const
pure virtual

◆ he() [3/5]

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

◆ he() [4/5]

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

◆ he() [5/5]

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

◆ hc()

virtual tmp<volScalarField> hc ( ) const
pure virtual

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

Referenced by phaseModel::hc().

Here is the caller graph for this function:

◆ THE() [1/2]

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

◆ THE() [2/2]

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

◆ T() [1/2]

Foam::volScalarField & T ( ) const
virtual

◆ T() [2/2]

virtual volScalarField& T ( )
virtual

◆ Cp() [1/3]

virtual tmp<volScalarField> Cp ( ) const
pure virtual

◆ Cp() [2/3]

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

◆ Cp() [3/3]

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

◆ Cv() [1/2]

virtual tmp<volScalarField> Cv ( ) const
pure virtual

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

Referenced by phaseModel::Cv().

Here is the caller graph for this function:

◆ Cv() [2/2]

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

◆ rhoEoS()

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

◆ gamma() [1/2]

virtual tmp<volScalarField> gamma ( ) const
pure virtual

◆ gamma() [2/2]

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

◆ Cpv() [1/2]

virtual tmp<volScalarField> Cpv ( ) const
pure virtual

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

Referenced by phaseModel::Cpv().

Here is the caller graph for this function:

◆ Cpv() [2/2]

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

◆ CpByCpv() [1/2]

virtual tmp<volScalarField> CpByCpv ( ) const
pure virtual

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

Referenced by phaseModel::CpByCpv().

Here is the caller graph for this function:

◆ CpByCpv() [2/2]

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

◆ W()

virtual tmp<volScalarField> W ( ) const
pure virtual

◆ alpha() [1/2]

const Foam::volScalarField & alpha ( ) const
virtual

Definition at line 619 of file basicThermo.C.

Referenced by phaseModel::alpha(), temperatureCoupledBase::alpha(), and alphatWallBoilingWallFunctionFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

◆ alpha() [2/2]

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

Definition at line 625 of file basicThermo.C.

References GeometricField::boundaryField().

Here is the call graph for this function:

◆ kappa() [1/2]

virtual tmp<volScalarField> kappa ( ) const
pure virtual

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

Referenced by phaseModel::kappa(), and temperatureCoupledBase::kappa().

Here is the caller graph for this function:

◆ kappa() [2/2]

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

◆ alphahe() [1/2]

virtual tmp<volScalarField> alphahe ( ) const
pure virtual

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

Referenced by phaseModel::alphahe().

Here is the caller graph for this function:

◆ alphahe() [2/2]

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

◆ kappaEff() [1/2]

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

◆ kappaEff() [2/2]

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

◆ alphaEff() [1/2]

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

◆ alphaEff() [2/2]

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

◆ read()

bool read ( )
virtual

Reimplemented from regIOobject.

Reimplemented in phaseSystem, phaseSystem, twoPhaseMixtureThermo, twoPhaseMixtureEThermo, solidThermo, and twoPhaseSystem.

Definition at line 631 of file basicThermo.C.

References regIOobject::read().

Here is the call graph for this function:

◆ New() [5/7]

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

Definition at line 125 of file basicThermoTemplates.C.

References TimePaths::constant(), dictName(), mesh, IOobject::MUST_READ_IF_MODIFIED, IOobject::NO_WRITE, thermoDict, and fvMesh::time().

Here is the call graph for this function:

◆ New() [6/7]

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

Definition at line 155 of file basicThermoTemplates.C.

References dict, and mesh.

◆ New() [7/7]

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

Definition at line 173 of file basicThermoTemplates.C.

References TimePaths::constant(), dictName(), mesh, IOobject::MUST_READ_IF_MODIFIED, IOobject::NO_WRITE, thermoDict, and fvMesh::time().

Here is the call graph for this function:

Member Data Documentation

◆ phaseName_

const word& phaseName_
protected

Definition at line 117 of file basicThermo.H.

Referenced by basicThermo::phasePropertyName().

◆ pOwner_

bool pOwner_
protected

Definition at line 120 of file basicThermo.H.

◆ TOwner_

bool TOwner_
protected

Definition at line 123 of file basicThermo.H.

Referenced by basicThermo::updateT().

◆ dpdt_

bool dpdt_
protected

Definition at line 126 of file basicThermo.H.

Referenced by basicThermo::dpdt().

◆ p_

volScalarField& p_
protected

Definition at line 132 of file basicThermo.H.

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

◆ T_

volScalarField& T_
protected

Definition at line 135 of file basicThermo.H.

◆ alpha_

volScalarField alpha_
protected

Definition at line 138 of file basicThermo.H.

◆ dictName

const Foam::word dictName
static

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