FreeFOAM The Cross-Platform CFD Toolkit
basicThermo Class Reference

Basic thermodynamic properties. More...

#include <basicThermophysicalModels/basicThermo.H>


Detailed Description

Basic thermodynamic properties.

Source files

Definition at line 53 of file basicThermo.H.

+ Inheritance diagram for basicThermo:
+ Collaboration diagram for basicThermo:

List of all members.

Public Member Functions

 TypeName ("basicThermo")
 Runtime type information.
 basicThermo (const fvMesh &)
 Construct from mesh.
virtual ~basicThermo ()
 Destructor.
virtual void correct ()=0
 Update properties.
virtual volScalarFieldp ()
 Pressure [Pa].
virtual const volScalarFieldp () const
 Pressure [Pa].
virtual tmp< volScalarFieldrho () const =0
 Density [kg/m^3].
virtual const volScalarFieldpsi () const
 Compressibility [s^2/m^2].
virtual volScalarFieldh ()
 Total enthalpy [J/kg].
virtual const volScalarFieldh () const
 Total enthalpy [J/kg].
virtual tmp< scalarFieldh (const scalarField &T, const labelList &cells) const
 Total enthalpy for cell-set [J/kg].
virtual tmp< scalarFieldh (const scalarField &T, const label patchi) const
 Total enthalpy for patch [J/kg].
virtual volScalarFieldhs ()
 Sensible enthalpy [J/kg].
virtual const volScalarFieldhs () const
 Sensible enthalpy [J/kg].
virtual tmp< scalarFieldhs (const scalarField &T, const labelList &cells) const
 Sensible enthalpy for cell-set [J/kg].
virtual tmp< scalarFieldhs (const scalarField &T, const label patchi) const
 Sensible enthalpy for patch [J/kg].
virtual tmp< volScalarFieldhc () const
 Chemical enthalpy [J/kg].
virtual volScalarFielde ()
 Internal energy [J/kg].
virtual const volScalarFielde () const
 Internal energy [J/kg].
virtual tmp< scalarFielde (const scalarField &T, const labelList &cells) const
 Internal energy for cell-set [J/kg].
virtual tmp< scalarFielde (const scalarField &T, const label patchi) const
 Internal energy for patch [J/kg].
virtual const volScalarFieldT () const
 Temperature [K].
virtual tmp< scalarFieldCp (const scalarField &T, const label patchi) const
 Heat capacity at constant pressure for patch [J/kg/K].
virtual tmp< volScalarFieldCp () const
 Heat capacity at constant pressure [J/kg/K].
virtual tmp< scalarFieldCv (const scalarField &T, const label patchi) const
 Heat capacity at constant volume for patch [J/kg/K].
virtual tmp< volScalarFieldCv () const
 Heat capacity at constant volume [J/kg/K].
virtual const volScalarFieldmu () const
 Dynamic viscosity of mixture [kg/m/s].
virtual const volScalarFieldalpha () const
 Thermal diffusivity for enthalpy of mixture [kg/m/s].
virtual bool read ()
 Read thermophysicalProperties dictionary.
- Public Member Functions inherited from IOdictionary
 TypeName ("dictionary")
 IOdictionary (const IOobject &)
 Construct given an IOobject.
 IOdictionary (const IOobject &, const dictionary &)
 Construct given an IOobject and dictionary.
virtual ~IOdictionary ()
const wordname () const
 Name function is needed to disambiguate those inherited.
bool readData (Istream &)
 ReadData function required for regIOobject read operation.
bool writeData (Ostream &) const
 WriteData function required for regIOobject write operation.
virtual bool write () const
 Write using setting from DB.
void operator= (const IOdictionary &)
 Assignment of other IOdictionary's entries to this IOdictionary.
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information.
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the.
 regIOobject (const regIOobject &)
 Construct as copy.
 regIOobject (const regIOobject &, bool registerCopy)
 Construct as copy, and transferring registry registration to copy.
virtual ~regIOobject ()
bool checkIn ()
 Add object to registry.
bool checkOut ()
 Remove object from registry.
bool ownedByRegistry () const
 Is this object owned by the registry?
void store ()
 Transfer ownership of this object to its registry.
void release ()
 Release ownership of this object from its registry.
label eventNo () const
 Event number at last update.
label & eventNo ()
 Event number at last update.
bool upToDate (const word &) const
 Am I uptodate with respect to other regIOobjects.
bool upToDate (const word &, const word &) const
bool upToDate (const word &, const word &, const word &) const
bool upToDate (const word &, const word &, const word &, const word &) const
void setUpToDate ()
 Flag me as up to date.
virtual void rename (const word &newName)
 Rename.
IstreamreadStream (const word &)
 Return Istream and check object type against that given.
void close ()
 Close Istream.
virtual bool modified () const
 Return true if the object's file has been modified.
virtual bool readIfModified ()
 Read object if modified.
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const
 Write using given format, version and compression.
void operator= (const IOobject &)
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information.
 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.
 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.
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options.
Foam::autoPtr< IOobjectclone () const
 Clone.
virtual ~IOobject ()
const Timetime () const
 Return time.
const objectRegistrydb () const
 Return the local objectRegistry.
const wordheaderClassName () const
 Return name of the class name read from header.
stringnote ()
 Return non-constant access to the optional note.
const stringnote () const
 Return the optional note.
bool registerObject () const
 Register object created from this IOobject with registry if true.
readOption readOpt () const
readOptionreadOpt ()
writeOption writeOpt () const
writeOptionwriteOpt ()
const fileNamerootPath () const
const fileNamecaseName () const
const fileNameinstance () const
fileNameinstance ()
const fileNamelocal () const
fileName path () const
 Return complete path.
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local.
fileName objectPath () const
 Return complete path + object name.
fileName filePath () const
 Return complete path + object name if the file exists.
bool readHeader (Istream &)
 Read header.
bool headerOk ()
 Read and check header info.
bool writeHeader (Ostream &) const
 Write header.
bool good () const
bool bad () const
InfoProxy< IOobjectinfo () const
 Return info proxy.
- Public Member Functions inherited from dictionary
 ClassName ("dictionary")
 dictionary ()
 Construct top-level dictionary null.
 dictionary (const fileName &name)
 Construct top-level empty dictionary with given name.
 dictionary (const fileName &name, const dictionary &parentDict, Istream &)
 Construct given the entry name, parent dictionary and Istream,.
 dictionary (Istream &)
 Construct top-level dictionary from Istream, reading entries.
 dictionary (const dictionary &parentDict, const dictionary &)
 Construct as copy given the parent dictionary.
 dictionary (const dictionary &)
 Construct top-level dictionary as copy.
 dictionary (const dictionary *)
 Construct top-level dictionary as copy from pointer to dictionary.
 dictionary (const dictionary &parentDict, const Xfer< dictionary > &)
 Construct by transferring parameter contents given parent dictionary.
 dictionary (const Xfer< dictionary > &)
 Construct top-level dictionary by transferring parameter contents.
autoPtr< dictionaryclone () const
 Construct and return clone.
 ~dictionary ()
const dictionaryparent () const
 Return the parent dictionary.
label startLineNumber () const
 Return line number of first token in dictionary.
label endLineNumber () const
 Return line number of last token in dictionary.
SHA1Digest digest () const
 Return the SHA1 digest of the dictionary contents.
bool found (const word &, bool recursive=false) const
 Search dictionary for given keyword.
const entrylookupEntryPtr (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream pointer if present.
entrylookupEntryPtr (const word &, bool recursive, bool patternMatch)
 Find and return an entry data stream pointer for manipulation.
const entrylookupEntry (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream if present otherwise error.
ITstreamlookup (const word &, bool recursive=false, bool patternMatch=true) const
 Find and return an entry data stream.
template<class T >
T lookupOrDefault (const word &, const T &, bool recursive=false, bool patternMatch=true) const
 Find and return a T,.
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.
template<class T >
bool readIfPresent (const word &, T &, bool recursive=false, bool patternMatch=true) const
 Find an entry if present, and assign to T.
bool isDict (const word &) const
 Check if entry is a sub-dictionary.
const dictionarysubDictPtr (const word &) const
 Find and return a sub-dictionary pointer if present.
const dictionarysubDict (const word &) const
 Find and return a sub-dictionary.
dictionarysubDict (const word &)
 Find and return a sub-dictionary for manipulation.
dictionary subOrEmptyDict (const word &) const
 Find and return a sub-dictionary as a copy, or.
wordList toc () const
 Return the table of contents.
List< keyTypekeys (bool patterns=false) const
 Return the list of available keys or patterns.
bool substituteKeyword (const word &keyword)
 Substitute the given keyword prepended by '$' with the.
bool add (entry *, bool mergeEntry=false)
 Add a new entry.
void add (const entry &, bool mergeEntry=false)
 Add an entry.
void add (const keyType &, const word &, bool overwrite=false)
 Add a word entry.
void add (const keyType &, const string &, bool overwrite=false)
 Add a string entry.
void add (const keyType &, const label, bool overwrite=false)
 Add a label entry.
void add (const keyType &, const scalar, bool overwrite=false)
 Add a scalar entry.
void add (const keyType &, const dictionary &, bool mergeEntry=false)
 Add a dictionary entry.
template<class T >
void add (const keyType &, const T &, bool overwrite=false)
 Add a T entry.
void set (entry *)
 Assign a new entry, overwrite any existing entry.
void set (const entry &)
 Assign a new entry, overwrite any existing entry.
void set (const keyType &, const dictionary &)
 Assign a dictionary entry, overwrite any existing entry.
template<class T >
void set (const keyType &, const T &)
 Assign a T entry, overwrite any existing entry.
bool remove (const word &)
 Remove an entry specified by keyword.
bool changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool forceOverwrite=false)
 Change the keyword for an entry,.
bool merge (const dictionary &)
 Merge entries from the given dictionary.
void clear ()
 Clear the dictionary.
void transfer (dictionary &)
 Transfer the contents of the argument and annul the argument.
Xfer< dictionaryxfer ()
 Transfer contents to the Xfer container.
bool read (Istream &)
 Read dictionary from Istream.
void write (Ostream &, bool subDict=true) const
ITstreamoperator[] (const word &) const
 Find and return entry.
void operator= (const dictionary &)
void operator+= (const dictionary &)
 Include entries from the given dictionary.
void operator|= (const dictionary &)
 Conditionally include entries from the given dictionary.
void operator<<= (const dictionary &)
 Unconditionally include entries from the given dictionary.
- Public Member Functions inherited from dictionaryName
 dictionaryName ()
 Construct dictionaryName null.
 dictionaryName (const fileName &name)
 Construct dictionaryName as copy of the given fileName.
fileNamename ()
 Return the dictionary name.
- Public Member Functions inherited from IDLList< entry >
 IDLList ()
 Null construct.
 IDLList (const entry &a)
 Construct given initial T.
 IDLList (Istream &is, const INew &inewt)
 Construct from Istream using given Istream constructor class.
 IDLList (Istream &is)
 Construct from Istream.
 IDLList (const IDLList< entry > &idll, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone.
- Public Member Functions inherited from ILList< DLListBase, entry >
 ILList ()
 Null construct.
 ILList (entry *a)
 Construct given initial T.
 ILList (Istream &)
 Construct from Istream.
 ILList (const ILList< DLListBase, entry > &)
 Construct as copy.
 ILList (const ILList< DLListBase, entry > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone.
 ILList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class.
 ~ILList ()
bool eraseHead ()
 Remove the head element specified from the list and delete it.
bool erase (entry *p)
 Remove the specified element from the list and delete it.
void transfer (ILList< DLListBase, entry > &)
 Transfer the contents of the argument into this List.
void operator= (const ILList< DLListBase, entry > &)
- Public Member Functions inherited from UILList< DLListBase, entry >
 UILList ()
 Null construct.
 UILList (entry *a)
 Construct given initial T.
 UILList (const UILList< DLListBase, entry > &)
 Construct as copy.
entryfirst ()
 Return the first entry.
const entryfirst () const
 Return the first entry.
entrylast ()
 Return the last entry.
const entrylast () const
 Return the last entry.
entryremoveHead ()
 Remove and return head.
entryremove (entry *p)
 Remove and return element.
entryremove (iterator &it)
 Remove and return specified by iterator.
void operator= (const UILList< DLListBase, entry > &)
bool operator== (const UILList< DLListBase, entry > &) const
 Equality operation on ULists of the same type.
bool operator!= (const UILList< DLListBase, entry > &) const
 The opposite of the equality operation. Takes linear time.
- Public Member Functions inherited from DLListBase
 DLListBase ()
 Null construct.
 DLListBase (link *)
 Construct given initial entry.
 ~DLListBase ()
label size () const
 Return number of elements in list.
bool empty () const
 Return true if the list is empty.
void insert (link *)
 Add at head of list.
void append (link *)
 Add at tail of list.
bool swapUp (link *)
 Swap this element with the one above unless it is at the top.
bool swapDown (link *)
 Swap this element with the one below unless it is at the bottom.
linkremove (link *)
 Remove and return element.
linkreplace (link *oldLink, link *newLink)
 Replace oldLink with newLink and return element.
linkreplace (iterator &oldIter, link *newLink)
 Replace oldIter with newLink and return element.
void transfer (DLListBase &)
 Transfer the contents of the argument into this List.
iterator begin ()
const iteratorend ()
const_iterator cbegin () const
const const_iteratorcend () const
const_iterator begin () const
const const_iteratorend () const

Protected Member Functions

wordList hBoundaryTypes ()
 Return the enthalpy field boundary types by interrogating the.
void hBoundaryCorrection (volScalarField &h)
 Correct the enthalpy field boundaries.
wordList eBoundaryTypes ()
 Return the internal energy field boundary types by.
void eBoundaryCorrection (volScalarField &e)
 Correct the internal energy field boundaries.
 basicThermo (const basicThermo &)
 Construct as copy (not implemented)

Protected Attributes

volScalarField p_
 Pressure [Pa].
volScalarField psi_
 Compressibility [s^2/m^2].
volScalarField T_
 Temperature [K].
volScalarField mu_
 Laminar dynamic viscosity [kg/m/s].
volScalarField alpha_
 Laminar thermal diffusuvity [kg/m/s].

Constructor & Destructor Documentation

basicThermo ( const basicThermo )
protected

Construct as copy (not implemented)

basicThermo ( const fvMesh mesh)

Construct from mesh.

Definition at line 147 of file basicThermo.C.

~basicThermo ( )
virtual

Destructor.

Definition at line 233 of file basicThermo.C.


Member Function Documentation

Foam::wordList hBoundaryTypes ( )
protected

Return the enthalpy field boundary types by interrogating the.

temperature field boundary types

Definition at line 46 of file basicThermo.C.

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

Foam::wordList eBoundaryTypes ( )
protected

Return the internal energy field boundary types by.

interrogating the temperature field boundary types

Definition at line 96 of file basicThermo.C.

References forAll, and patchi.

void eBoundaryCorrection ( volScalarField e)
protected

Correct the internal energy field boundaries.

Definition at line 126 of file basicThermo.C.

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

Referenced by ePsiThermo< MixtureType >::ePsiThermo().

TypeName ( "basicThermo"  )

Runtime type information.

Foam::volScalarField & p ( )
virtual

Pressure [Pa].

Non-const access allowed for transport equations

Definition at line 239 of file basicThermo.C.

const Foam::volScalarField & p ( ) const
virtual

Pressure [Pa].

Definition at line 245 of file basicThermo.C.

virtual tmp<volScalarField> rho ( ) const
pure virtual

Density [kg/m^3].

Implemented in basicRhoThermo, and basicPsiThermo.

const Foam::volScalarField & psi ( ) const
virtual

Compressibility [s^2/m^2].

Definition at line 251 of file basicThermo.C.

Referenced by basicPsiThermo::rho().

const Foam::volScalarField & h ( ) const
virtual
Foam::tmp< Foam::scalarField > h ( const scalarField T,
const labelList cells 
) const
virtual
Foam::tmp< Foam::scalarField > h ( const scalarField T,
const label  patchi 
) const
virtual
const Foam::volScalarField & hs ( ) const
virtual
Foam::tmp< Foam::scalarField > hs ( const scalarField T,
const labelList cells 
) const
virtual

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

Reimplemented in hsPsiThermo< MixtureType >, hsRhoThermo< MixtureType >, hsRhoMixtureThermo< MixtureType >, and hsPsiMixtureThermo< MixtureType >.

Definition at line 316 of file basicThermo.C.

References notImplemented.

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

Sensible enthalpy for patch [J/kg].

Reimplemented in hsPsiThermo< MixtureType >, hsRhoThermo< MixtureType >, hsRhoMixtureThermo< MixtureType >, and hsPsiMixtureThermo< MixtureType >.

Definition at line 331 of file basicThermo.C.

References notImplemented.

const Foam::volScalarField & e ( ) const
virtual

Internal energy [J/kg].

Reimplemented in ePsiThermo< MixtureType >.

Definition at line 359 of file basicThermo.C.

References notImplemented, and GeometricField< scalar, fvPatchField, volMesh >::null().

Foam::tmp< Foam::scalarField > e ( const scalarField T,
const labelList cells 
) const
virtual

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

Reimplemented in ePsiThermo< MixtureType >.

Definition at line 367 of file basicThermo.C.

References notImplemented.

Foam::tmp< Foam::scalarField > e ( const scalarField T,
const label  patchi 
) const
virtual

Internal energy for patch [J/kg].

Reimplemented in ePsiThermo< MixtureType >.

Definition at line 382 of file basicThermo.C.

References notImplemented.

Foam::tmp< Foam::scalarField > Cv ( const scalarField T,
const label  patchi 
) const
virtual
const Foam::volScalarField & mu ( ) const
virtual

Dynamic viscosity of mixture [kg/m/s].

Definition at line 446 of file basicThermo.C.

Referenced by forces::devRhoReff(), and turbulenceModel::mu().

const Foam::volScalarField & alpha ( ) const
virtual

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

Definition at line 452 of file basicThermo.C.

Referenced by turbulenceModel::alpha(), and wallHeatTransferFvPatchScalarField::updateCoeffs().


Member Data Documentation

volScalarField p_
protected

Pressure [Pa].

Definition at line 65 of file basicThermo.H.

Referenced by basicPsiThermo::rho(), hhuCombustionThermo::rhob(), and hhuCombustionThermo::rhou().

volScalarField mu_
protected

Laminar dynamic viscosity [kg/m/s].

Definition at line 74 of file basicThermo.H.

volScalarField alpha_
protected

Laminar thermal diffusuvity [kg/m/s].

Definition at line 77 of file basicThermo.H.


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