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 writaData function. 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, transferring 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... | |
virtual void | addWatch () |
Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
bool | ownedByRegistry () const |
Is this object owned by the registry? More... | |
void | store () |
Transfer ownership of this object to its registry. More... | |
void | release () |
Release ownership of this object from its registry. More... | |
label | eventNo () const |
Event number at last update. More... | |
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 up to date (obviously) 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 from copy resetting registry. More... | |
IOobject (const IOobject &io, const word &name) | |
Construct from copy resetting name. More... | |
autoPtr< IOobject > | clone () const |
Clone. More... | |
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
Clone resetting registry. More... | |
virtual | ~IOobject () |
Destructor. More... | |
const Time & | time () const |
Return time. More... | |
const objectRegistry & | db () const |
Return the local objectRegistry. 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 name of the class name read from header. More... | |
string & | note () |
Return non-constant access to the optional note. More... | |
const string & | note () 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... | |
bool & | globalObject () |
Is object same for all processors. More... | |
bool | globalObject () const |
Is object same for all processors. More... | |
readOption | readOpt () const |
readOption & | readOpt () |
writeOption | writeOpt () const |
writeOption & | writeOpt () |
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 |
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 | localFilePath (const word &typeName) const |
Helper for filePath that searches locally. More... | |
fileName | globalFilePath (const word &typeName) const |
Helper for filePath that searches up if in parallel. More... | |
bool | readHeader (Istream &) |
Read header. More... | |
template<class Type > | |
bool | typeHeaderOk (const bool checkType=true) |
Read header (uses typeFilePath to find file) and check header. More... | |
template<class Type > | |
void | warnNoRereading () const |
Helper: warn that type does not support re-reading. More... | |
bool | writeHeader (Ostream &) const |
Write header. More... | |
bool | writeHeader (Ostream &, const word &objectType) const |
Write header. Allow override of type. More... | |
bool | good () const |
bool | bad () const |
InfoProxy< IOobject > | info () const |
Return info proxy. More... | |
void | operator= (const IOobject &) |
template<class Name > | |
Foam::word | groupName (Name name, const word &group) |
Additional Inherited Members | |
Public Types inherited from IOobject | |
enum | objectState { GOOD, BAD } |
Enumeration defining the valid states of an IOobject. More... | |
enum | readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ } |
Enumeration defining the read options. More... | |
enum | writeOption { AUTO_WRITE = 0, NO_WRITE = 1 } |
Enumeration defining the write options. More... | |
enum | fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster } |
Enumeration defining the file checking options. More... | |
Static Public Member Functions inherited from regIOobject | |
template<class Type > | |
static Type & | store (Type *) |
Transfer ownership of the given object pointer to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &) |
Transfer ownership of the given object pointer to its registry. More... | |
Static Public Member Functions inherited from IOobject | |
static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
Split path into instance, local, name components. More... | |
template<class Name > | |
static word | groupName (Name name, const word &group) |
static word | group (const word &name) |
Return group (extension part of name) More... | |
static word | member (const word &name) |
Return member (name without the extension) More... | |
template<class 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 Attributes inherited from regIOobject | |
static float | fileModificationSkew |
Static Public Attributes inherited from IOobject | |
static const NamedEnum< fileCheckTypes, 4 > | fileCheckTypesNames |
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... | |
Protected Member Functions inherited from IOobject | |
void | setBad (const string &) |
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 62 of file SLGThermo.H.
SLGThermo | ( | const fvMesh & | mesh, |
fluidThermo & | thermo | ||
) |
Construct from mesh.
Definition at line 38 of file SLGThermo.C.
References Foam::endl(), dictionary::found(), Foam::Info, solidMixtureProperties::New(), liquidMixtureProperties::New(), List< T >::size(), basicMultiComponentMixture::species(), dictionary::subDict(), and SLGThermo::thermo().
|
virtual |
Destructor.
Definition at line 96 of file SLGThermo.C.
TypeName | ( | "SLGThermo" | ) |
Runtime type information.
const Foam::fluidThermo & thermo | ( | ) | const |
Return reference to the thermo database.
Definition at line 102 of file SLGThermo.C.
Referenced by SLGThermo::SLGThermo().
const Foam::basicSpecieMixture & carrier | ( | ) | const |
Return reference to the gaseous components.
Definition at line 108 of file SLGThermo.C.
References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.
Referenced by COxidationDiffusionLimitedRate< CloudType >::calculate(), COxidationKineticDiffusionLimitedRate< CloudType >::calculate(), COxidationHurtMitchell< CloudType >::calculate(), COxidationIntrinsicRate< CloudType >::calculate(), COxidationMurphyShaddix< CloudType >::calculate(), SLGThermo::carrierId(), waxSolventEvaporation::correctModel(), ReactingParcel< ParcelType >::correctSurfaceValues(), ReactingCloud< Foam::DSMCCloud >::ReactingCloud(), and thermoSingleLayer::thermoSingleLayer().
const Foam::liquidMixtureProperties & liquids | ( | ) | const |
Return reference to the global (additional) liquids.
Definition at line 121 of file SLGThermo.C.
References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.
Referenced by liquidFilmThermo::initLiquid(), and SLGThermo::liquidId().
const Foam::solidMixtureProperties & solids | ( | ) | const |
Return reference to the global (additional) solids.
Definition at line 134 of file SLGThermo.C.
References Foam::abort(), SLGThermo::carrierId(), Foam::FatalError, and FatalErrorInFunction.
Referenced by COxidationDiffusionLimitedRate< CloudType >::calculate(), COxidationKineticDiffusionLimitedRate< CloudType >::calculate(), COxidationHurtMitchell< CloudType >::calculate(), COxidationIntrinsicRate< CloudType >::calculate(), COxidationMurphyShaddix< CloudType >::calculate(), and SLGThermo::solidId().
Foam::label carrierId | ( | const word & | cmptName, |
bool | allowNotFound = false |
||
) | const |
Index of carrier component.
Definition at line 148 of file SLGThermo.C.
References SLGThermo::carrier(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, SLGThermo::liquidId(), Foam::nl, and basicMultiComponentMixture::species().
Referenced by waxSolventEvaporation::correctModel(), standardPhaseChange::correctModel(), SLGThermo::solids(), and thermoSingleLayer::Srho().
Foam::label liquidId | ( | const word & | cmptName, |
bool | allowNotFound = false |
||
) | const |
Index of liquid component.
Definition at line 174 of file SLGThermo.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, SLGThermo::liquids(), Foam::nl, and SLGThermo::solidId().
Referenced by SLGThermo::carrierId(), and liquidFilmThermo::initLiquid().
Foam::label solidId | ( | const word & | cmptName, |
bool | allowNotFound = false |
||
) | const |
Index of solid component.
Definition at line 199 of file SLGThermo.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::nl, and SLGThermo::solids().
Referenced by SLGThermo::liquidId().
bool hasMultiComponentCarrier | ( | ) | const |
Thermo database has multi-component carrier flag.
Definition at line 223 of file SLGThermo.C.
Referenced by thermoSingleLayer::thermoSingleLayer().
bool hasLiquids | ( | ) | const |
Thermo database has liquid components flag.
Definition at line 229 of file SLGThermo.C.
bool hasSolids | ( | ) | const |
Thermo database has solid components flag.
Definition at line 235 of file SLGThermo.C.
|
inlinevirtual |
Pure virtual writaData function.
Must be defined in derived types
Implements regIOobject.
Definition at line 151 of file SLGThermo.H.