SLGThermo Class Reference

Thermo package for (S)olids (L)iquids and (G)ases Takes reference to thermo package, and provides: More...

Inheritance diagram for SLGThermo:

Collaboration diagram for SLGThermo:

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 isTimeObject=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	registered () const noexcept
bool	ownedByRegistry () const noexcept
	Is this object owned by the registry? More...
bool	store ()
void	release (const bool unregister=false) noexcept
	Set object as not ownedByRegistry. More...
label	eventNo () const noexcept
	Event number at last update. More...
label &	eventNo () noexcept
	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...
const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data or nullptr. More...
dictionary &	getMetaData () noexcept
	Get or create meta-data. More...
void	removeMetaData ()
	Remove meta-data. More...
virtual void	updateMetaData ()
	Update internal meta-data (eg, prior to writing) More...
virtual fileName	filePath () const
	Return complete path + object name if the file exists. More...
bool	headerOk ()
	Read and check header info. Does not check the headerClassName. 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. More...
const labelList &	watchIndices () const noexcept
	Read access to file-monitoring handles. More...
labelList &	watchIndices () noexcept
	Write access to file-monitoring handles. More...
virtual bool	modified () const
virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...
virtual bool	writeData (Ostream &) const =0
	Pure virtual writeData function. More...
virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const
	Write using stream options. 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 &io)
	Copy assignment. More...
virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const
	Write using given format, version and compression. More...
Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Declare type-name, virtual type (with debug switch) More...
	IOobject (const IOobject &)=default
	Copy construct. More...
virtual	~IOobject ()=default
	Destructor. More...
	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, registry, io options. More...
	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, local, registry, io options. More...
	IOobject (const fileName &path, const objectRegistry &registry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from path, registry, io options. More...
	IOobject (const IOobject &io, const objectRegistry &registry)
	Copy construct, resetting registry. More...
	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name. More...
	IOobject (const IOobject &io, const word &name, const fileName &local)
	Copy construct, resetting name and local component. More...
	IOobject (const IOobject &io, readOption rOpt, writeOption wOpt)
	Copy construct, resetting read/write options. More...
autoPtr< IOobject >	clone () const
	Clone. More...
autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...
const objectRegistry &	db () const noexcept
	Return the local objectRegistry. More...
const Time &	time () const
	Return Time associated with the objectRegistry. More...
const word &	name () const noexcept
	Return the object name. More...
const word &	headerClassName () const noexcept
	Return name of the class name read from header. More...
word &	headerClassName () noexcept
	Return non-constant access to the class name read from header. More...
const string &	note () const noexcept
	Return the optional note. More...
string &	note () noexcept
	Modifiable access to the optional note. More...
virtual void	rename (const word &newName)
	Rename the object. More...
bool	registerObject () const noexcept
	Should object created with this IOobject be registered? More...
bool	registerObject (bool on) noexcept
	Change registration preference, return previous value. More...
bool	globalObject () const noexcept
	Is object same for all processors? More...
bool	globalObject (bool on) noexcept
	Change global-object status, return previous value. More...
unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes, possibly read from the header. More...
unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes, possibly read from the header. More...
bool	hasHeaderClass () const noexcept
	True if headerClassName() is non-empty (after reading) More...
template<class Type >
bool	isHeaderClass () const
	Check if headerClassName() equals Type::typeName. More...
template<class Type >
bool	isHeaderClassName () const
	Same as isHeaderClass() More...
virtual const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data (if any) or nullptr. More...
readOption	readOpt () const noexcept
	The read option. More...
readOption	readOpt (readOption opt) noexcept
	Change the read option, return previous value. More...
writeOption	writeOpt () const noexcept
	The write option. More...
writeOption	writeOpt (writeOption opt) noexcept
	Change the write option, return previous value. 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
	Return the Time::rootPath() More...
const fileName &	caseName () const
	Return the Time::caseName() More...
const fileName &	instance () const noexcept
	Read access to instance path component. More...
fileName &	instance () noexcept
	Write access to instance path component. More...
const fileName &	local () const noexcept
	Read access to local path component. More...
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	objectRelPath () const
	The object path relative to the root. 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...
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)
	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 with current type() More...
bool	writeHeader (Ostream &os, const word &objectType) const
	Write header with override of type. More...
void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const
void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
bool	good () const noexcept
	Did last readHeader() succeed? More...
bool	bad () const noexcept
	Did last readHeader() fail? More...
InfoProxy< IOobject >	info () const
	Return info proxy, for printing information to a stream. More...
void	operator= (const IOobject &io)
	Copy assignment, copies all values (except the registry) More...
readOption &	readOpt () noexcept
	Access to the read option. More...
writeOption &	writeOpt () noexcept
	Access to the write option. More...
bool &	registerObject () noexcept
	Access to the register object option. More...
bool &	globalObject () noexcept
	Access to the global object option. More...
template<>
bool	isHeaderClass () const
	Specialization for void always returns true (no headerClassName check). More...
template<class StringType >
Foam::word	groupName (StringType base, const word &group)

Additional Inherited Members
Public Types inherited from IOobject
enum	readOption : char { NO_READ = 0 , MUST_READ = 1 , MUST_READ_IF_MODIFIED = 3 , READ_IF_PRESENT = 4 }
	Enumeration defining the read options. More...
enum	writeOption : char { NO_WRITE = 0 , AUTO_WRITE = 0x10 }
	Enumeration defining the write options. More...
enum	objectState : char { GOOD , BAD }
	Enumeration defining the valid states of an IOobject. 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 pointer ownership to its registry. More...
template<class Type >
static Type &	store (autoPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...
template<class Type >
static Type &	store (autoPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...
template<class Type >
static Type &	store (refPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...
template<class Type >
static Type &	store (refPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...
template<class Type >
static Type &	store (tmp< Type > &ptr)
	Transfer pointer ownership to its registry. More...
template<class Type >
static Type &	store (tmp< Type > &&ptr)
	Transfer pointer ownership to its registry. More...
Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept
	Status of output file banner. More...
static bool	bannerEnabled (bool on) noexcept
	Enable/disable output file banner. More...
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 base, const word &group)
	Create dot-delimited name.group string. 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 word	scopedName (const std::string &scope, const word &name)
	Create scope:name or scope_name string. 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, const bool noSyntaxHint=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 IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes. More...
static char	scopeSeparator
	Character for scoping object names (':' or '_') More...
static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...
static float	fileModificationSkew
	Time skew (seconds) for file modification checks. More...
static int	maxFileModificationPolls
	Max number of times to poll for file modification changes. More...
Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
	Helper: check readOpt flags and read if necessary. More...
Protected Member Functions inherited from IOobject
void	setBad (const string &s)
	Set the object state to bad. More...
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
	To flag master-only reading of objects. More...

Detailed Description

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

• liquids : liquid components - access to elemental properties
• solids : solid components - 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

Source files

• SLGThermo.H
• SLGThermo.C

Definition at line 64 of file SLGThermo.H.

Constructor & Destructor Documentation

SLGThermo()

SLGThermo	(	const fvMesh &	mesh,
		fluidThermo &	thermo
	)

Construct from mesh.

Definition at line 41 of file SLGThermo.C.

References Foam::endl(), Foam::Info, Time::New(), UList< T >::size(), basicMultiComponentMixture::species(), and SLGThermo::thermo().

Here is the call graph for this function:

~SLGThermo()

~SLGThermo ( )

virtual

Destructor.

Definition at line 99 of file SLGThermo.C.

Member Function Documentation

TypeName()

TypeName

(

"SLGThermo"

)

Runtime type information.

thermo()

const Foam::fluidThermo & thermo

(

)

const

Return reference to the thermo database.

Definition at line 105 of file SLGThermo.C.

Referenced by SLGThermo::SLGThermo().

Here is the caller graph for this function:

carrier()

const Foam::basicSpecieMixture & carrier

(

)

const

Return reference to the gaseous components.

Definition at line 111 of file SLGThermo.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Referenced by ReactingCloud< Foam::DSMCCloud >::ReactingCloud(), and thermoSingleLayer::thermoSingleLayer().

Here is the call graph for this function:

Here is the caller graph for this function:

liquids()

const Foam::liquidMixtureProperties & liquids

(

)

const

Return reference to the global (additional) liquids.

Definition at line 124 of file SLGThermo.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

solids()

const Foam::solidMixtureProperties & solids

(

)

const

Return reference to the global (additional) solids.

Definition at line 137 of file SLGThermo.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

carrierId()

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 thermoSingleLayer::Srho().

Here is the call graph for this function:

Here is the caller graph for this function:

liquidId()

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.

Here is the call graph for this function:

solidId()

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.

Here is the call graph for this function:

hasMultiComponentCarrier()

bool hasMultiComponentCarrier

(

)

const

Thermo database has multi-component carrier flag.

Definition at line 226 of file SLGThermo.C.

Referenced by thermoSingleLayer::thermoSingleLayer().

Here is the caller graph for this function:

hasLiquids()

bool hasLiquids

(

)

const

Thermo database has liquid components flag.

Definition at line 232 of file SLGThermo.C.

References bool.

hasSolids()

bool hasSolids

(

)

const

Thermo database has solid components flag.

Definition at line 238 of file SLGThermo.C.

References bool.

writeData()

bool writeData ( Foam::Ostream &  ) const

inlinevirtual

Pure virtual writeData function.

Must be defined in derived types

Implements regIOobject.

Definition at line 153 of file SLGThermo.H.

---

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

• src/thermophysicalModels/SLGThermo/SLGThermo/SLGThermo.H
• src/thermophysicalModels/SLGThermo/SLGThermo/SLGThermo.C