Thermo package for (S)olids (L)iquids and (G)ases Takes reference to thermo package, and provides: More...
Public Member Functions | |
TypeName ("SLGThermo") | |
Runtime type information. More... | |
SLGThermo (const fvMesh &mesh, fluidThermo &thermo) | |
Construct from mesh. More... | |
virtual | ~SLGThermo () |
Destructor. More... | |
const fluidThermo & | thermo () const |
Return reference to the thermo database. More... | |
const basicSpecieMixture & | carrier () const |
Return reference to the gaseous components. More... | |
const liquidMixtureProperties & | liquids () const |
Return reference to the global (additional) liquids. More... | |
const solidMixtureProperties & | solids () const |
Return reference to the global (additional) solids. More... | |
label | carrierId (const word &cmptName, bool allowNotFound=false) const |
Index of carrier component. More... | |
label | liquidId (const word &cmptName, bool allowNotFound=false) const |
Index of liquid component. More... | |
label | solidId (const word &cmptName, bool allowNotFound=false) const |
Index of solid component. More... | |
bool | hasMultiComponentCarrier () const |
Thermo database has multi-component carrier flag. More... | |
bool | hasLiquids () const |
Thermo database has liquid components flag. More... | |
bool | hasSolids () const |
Thermo database has solid components flag. More... | |
bool | writeData (Foam::Ostream &) const |
Pure virtual writeData function. More... | |
Public Member Functions inherited from regIOobject | |
TypeName ("regIOobject") | |
Runtime type information. More... | |
regIOobject (const IOobject &io, const bool isTime=false) | |
regIOobject (const regIOobject &rio) | |
Copy construct. More... | |
regIOobject (const regIOobject &rio, bool registerCopy) | |
regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
regIOobject (const IOobject &io, const regIOobject &rio) | |
Copy construct with new IO parameters. More... | |
virtual | ~regIOobject () |
Destructor. More... | |
bool | checkIn () |
Add object to registry, if not already registered. More... | |
bool | checkOut () |
Remove all file watches and remove object from registry. More... | |
virtual void | addWatch () |
Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
bool | ownedByRegistry () const |
Is this object owned by the registry? More... | |
void | store () |
Transfer ownership of this object to its registry. More... | |
void | release (const bool unregister=false) |
Release ownership of this object from its registry. More... | |
label | eventNo () const |
Event number at last update. More... | |
label & | eventNo () |
Event number at last update. More... | |
bool | upToDate (const regIOobject &) const |
Return true if up-to-date with respect to given object. More... | |
bool | upToDate (const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
void | setUpToDate () |
Set as up-to-date. More... | |
virtual void | rename (const word &newName) |
Rename. More... | |
virtual fileName | filePath () const |
Return complete path + object name if the file exists. More... | |
bool | headerOk () |
Read and check header info. More... | |
Istream & | readStream (const word &, const bool valid=true) |
Return Istream and check object type against that given. More... | |
void | close () |
Close Istream. More... | |
virtual bool | readData (Istream &) |
Virtual readData function. More... | |
virtual bool | read () |
Read object. More... | |
virtual label | addWatch (const fileName &) |
Add file watch for fileName on object if not yet watched. Return. More... | |
const labelList & | watchIndices () const |
Return file-monitoring handles. More... | |
labelList & | watchIndices () |
Return file-monitoring handles. More... | |
virtual bool | modified () const |
Return true if the object's file (or files for objectRegistry) More... | |
virtual bool | readIfModified () |
Read object if modified (as set by call to modified) More... | |
virtual bool | writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool valid) const |
Write using given format, version and compression. More... | |
virtual bool | write (const bool valid=true) const |
Write using setting from DB. More... | |
virtual bool | global () const |
Is object global. More... | |
void | operator= (const IOobject &) |
Public Member Functions inherited from IOobject | |
TypeName ("IOobject") | |
Runtime type information. More... | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
Construct from name, instance, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from path, registry, io options. More... | |
IOobject (const IOobject &io, const objectRegistry ®istry) | |
Construct as copy resetting registry. More... | |
IOobject (const IOobject &io, const word &name) | |
Construct as copy resetting name. More... | |
autoPtr< IOobject > | clone () const |
Clone. More... | |
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
Clone resetting registry. More... | |
virtual | ~IOobject ()=default |
Destructor. More... | |
const objectRegistry & | db () const |
Return the local objectRegistry. More... | |
const Time & | time () const |
Return time. More... | |
const word & | name () const |
Return name. More... | |
const word & | headerClassName () const |
Return name of the class name read from header. More... | |
word & | headerClassName () |
Return non-constant access to the class name read from header. More... | |
const string & | note () const |
Return the optional note. More... | |
string & | note () |
Return non-constant access to the optional note. More... | |
bool | registerObject () const |
Should object created with this IOobject be registered? More... | |
bool & | registerObject () |
Should object created with this IOobject be registered? More... | |
bool | globalObject () const |
Is object same for all processors? More... | |
bool & | globalObject () |
Is object same for all processors? More... | |
unsigned | labelByteSize () const |
The label byte-size, possibly read from the header. More... | |
unsigned | scalarByteSize () const |
The scalar byte-size, possibly read from the header. More... | |
bool | isHeaderClassName (const word &clsName) const |
Test if headerClassName() equals the given class name. More... | |
template<class Type > | |
bool | isHeaderClassName () const |
Test if headerClassName() equals Type::typeName. More... | |
readOption | readOpt () const |
The read option. More... | |
readOption & | readOpt () |
Non-constant access to the read option. More... | |
writeOption | writeOpt () const |
The write option. More... | |
writeOption & | writeOpt () |
Non-constant access to the write option. More... | |
word | group () const |
Return group (extension part of name) More... | |
word | member () const |
Return member (name without the extension) More... | |
const fileName & | rootPath () const |
const fileName & | caseName () const |
const fileName & | instance () const |
fileName & | instance () |
const fileName & | local () const |
fileName | path () const |
The complete path. More... | |
fileName | path (const word &instance, const fileName &local=fileName::null) const |
The complete path with alternative instance and local. More... | |
fileName | objectPath () const |
The complete path + object name. More... | |
fileName | localFilePath (const word &typeName, const bool search=true) const |
Helper for filePath that searches locally. More... | |
fileName | globalFilePath (const word &typeName, const bool search=true) const |
Helper for filePath that searches up if in parallel. More... | |
bool | readHeader (Istream &is) |
Read header. More... | |
template<class Type > | |
bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
Read header (uses typeFilePath to find file) and check its info. More... | |
template<class Type > | |
void | warnNoRereading () const |
Helper: warn that type does not support re-reading. More... | |
bool | writeHeader (Ostream &os) const |
Write header. More... | |
bool | writeHeader (Ostream &os, const word &objectType) const |
Write header. Allow override of type. More... | |
bool | good () const |
bool | bad () const |
InfoProxy< IOobject > | info () const |
Return info proxy. More... | |
void | operator= (const IOobject &io) |
template<> | |
bool | isHeaderClassName () const |
Specialization for void always returns true (no headerClassName check). More... | |
template<class StringType > | |
Foam::word | groupName (StringType name, const word &group) |
Additional Inherited Members | |
Public Types inherited from IOobject | |
enum | objectState : char { GOOD, BAD } |
Enumeration defining the valid states of an IOobject. More... | |
enum | readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ } |
Enumeration defining the read options. More... | |
enum | writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 } |
Enumeration defining the write options. More... | |
enum | fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster } |
Enumeration defining the file checking options. More... | |
Static Public Member Functions inherited from regIOobject | |
template<class Type > | |
static Type & | store (Type *p) |
Transfer ownership of the given object pointer to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &aptr) |
Transfer ownership of the given object pointer to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &&aptr) |
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 StringType > | |
static word | groupName (StringType name, const word &group) |
Create dot-delimited name.group. More... | |
static word | group (const word &name) |
Return group (extension part of name) More... | |
static word | member (const word &name) |
Return member (name without the extension) More... | |
static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
Return the IOobject, but also consider an alternative file name. More... | |
static Ostream & | writeBanner (Ostream &os, bool noHint=false) |
Write the standard OpenFOAM file/dictionary banner. More... | |
static Ostream & | writeDivider (Ostream &os) |
Write the standard file section divider. More... | |
static Ostream & | writeEndDivider (Ostream &os) |
Write the standard end file divider. More... | |
Static Public Attributes inherited from regIOobject | |
static float | fileModificationSkew |
static int | maxFileModificationPolls |
Static Public Attributes inherited from IOobject | |
static const Enum< fileCheckTypes > | fileCheckTypesNames |
Names for the fileCheckTypes. More... | |
static fileCheckTypes | fileModificationChecking |
Type of file modification checking. More... | |
Protected Member Functions inherited from regIOobject | |
bool | readHeaderOk (const IOstream::streamFormat PstreamFormat, const word &typeName) |
Helper: check readOpt flags and read if necessary. More... | |
Istream * | objectStream () |
Construct and return an IFstream for the object. More... | |
Protected Member Functions inherited from IOobject | |
void | setBad (const string &s) |
Set the object state to bad. More... | |
Static Protected Attributes inherited from regIOobject | |
static bool | masterOnlyReading = false |
To flag master-only reading of objects. More... | |
Thermo package for (S)olids (L)iquids and (G)ases Takes reference to thermo package, and provides:
- carrier : components of thermo - access to elemental properties
If thermo is not a multi-component thermo package, carrier is nullptr. Similarly, if no liquids or solids are specified, their respective pointers will also be nullptr.
Registered to the mesh so that it can be looked-up
Definition at line 64 of file SLGThermo.H.
SLGThermo | ( | const fvMesh & | mesh, |
fluidThermo & | thermo | ||
) |
Construct from mesh.
Definition at line 40 of file SLGThermo.C.
References Foam::endl(), Foam::Info, solidMixtureProperties::New(), liquidMixtureProperties::New(), basicMultiComponentMixture::species(), and SLGThermo::thermo().
|
virtual |
Destructor.
Definition at line 98 of file SLGThermo.C.
TypeName | ( | "SLGThermo" | ) |
Runtime type information.
const Foam::fluidThermo & thermo | ( | ) | const |
Return reference to the thermo database.
Definition at line 104 of file SLGThermo.C.
Referenced by SLGThermo::SLGThermo().
const Foam::basicSpecieMixture & carrier | ( | ) | const |
Return reference to the gaseous components.
Definition at line 110 of file SLGThermo.C.
References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.
const Foam::liquidMixtureProperties & liquids | ( | ) | const |
Return reference to the global (additional) liquids.
Definition at line 123 of file SLGThermo.C.
References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.
const Foam::solidMixtureProperties & solids | ( | ) | const |
Return reference to the global (additional) solids.
Definition at line 136 of file SLGThermo.C.
References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.
Foam::label carrierId | ( | const word & | cmptName, |
bool | allowNotFound = false |
||
) | const |
Index of carrier component.
Definition at line 150 of file SLGThermo.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, and Foam::nl.
Referenced by standardPhaseChange::correctModel(), and waxSolventEvaporation::correctModel().
Foam::label liquidId | ( | const word & | cmptName, |
bool | allowNotFound = false |
||
) | const |
Index of liquid component.
Definition at line 176 of file SLGThermo.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, and Foam::nl.
Foam::label solidId | ( | const word & | cmptName, |
bool | allowNotFound = false |
||
) | const |
Index of solid component.
Definition at line 201 of file SLGThermo.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, and Foam::nl.
bool hasMultiComponentCarrier | ( | ) | const |
Thermo database has multi-component carrier flag.
Definition at line 225 of file SLGThermo.C.
bool hasLiquids | ( | ) | const |
Thermo database has liquid components flag.
Definition at line 231 of file SLGThermo.C.
bool hasSolids | ( | ) | const |
Thermo database has solid components flag.
Definition at line 237 of file SLGThermo.C.
|
inlinevirtual |
Pure virtual writeData function.
Must be defined in derived types
Implements regIOobject.
Definition at line 153 of file SLGThermo.H.