Abstract base-class for fluid and solid thermodynamic properties. More...

Inheritance diagram for basicThermo:

Collaboration diagram for basicThermo:

Public Member Functions
	TypeName ("basicThermo")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, basicThermo, fvMesh,(const fvMesh &mesh, const word &phaseName),(mesh, phaseName))
	Declare run-time constructor selection table. More...

	declareRunTimeSelectionTable (autoPtr, basicThermo, fvMeshDictPhase,(const fvMesh &mesh, const word &phaseName, const word &dictName),(mesh, phaseName, dictName))
	Declare run-time constructor selection table for dictionary based. More...

	basicThermo (const fvMesh &, const word &phaseName)
	Construct from mesh and phase name. More...

	basicThermo (const fvMesh &, const dictionary &, const word &phaseName)
	Construct from mesh, dictionary and phase name. More...

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

virtual	~basicThermo ()
	Destructor. More...

word	phasePropertyName (const word &name) const

void	validate (const string &app, const word &) const
	Check that the thermodynamics package is consistent. More...

void	validate (const string &app, const word &, const word &) const
	Check that the thermodynamics package is consistent. More...

void	validate (const string &app, const word &, const word &, const word &) const
	Check that the thermodynamics package is consistent. More...

void	validate (const string &app, const word &, const word &, const word &, const word &) const
	Check that the thermodynamics package is consistent. More...

virtual void	correct ()=0
	Update properties. More...

virtual word	thermoName () const =0
	Return the name of the thermo physics. More...

virtual bool	incompressible () const =0
	Return true if the equation of state is incompressible. More...

virtual bool	isochoric () const =0
	Return true if the equation of state is isochoric. More...

bool	dpdt () const noexcept
	True if dpdt term should be included in enthalpy equation. More...

bool	updateT () const noexcept
	True if T should be updated. More...

virtual volScalarField &	p ()
	Pressure [Pa]. More...

virtual const volScalarField &	p () const
	Pressure [Pa]. More...

virtual tmp< volScalarField >	rho () const =0
	Density [kg/m^3]. More...

virtual tmp< scalarField >	rho (const label patchi) const =0
	Density for patch [kg/m^3]. More...

virtual volScalarField &	he ()=0
	Enthalpy/Internal energy [J/kg]. More...

virtual const volScalarField &	he () const =0
	Enthalpy/Internal energy [J/kg]. More...

virtual tmp< volScalarField >	he (const volScalarField &p, const volScalarField &T) const =0
	Enthalpy/Internal energy. More...

virtual tmp< scalarField >	he (const scalarField &p, const scalarField &T, const labelList &cells) const =0
	Enthalpy/Internal energy for cell-set [J/kg]. More...

virtual tmp< scalarField >	he (const scalarField &p, const scalarField &T, const label patchi) const =0
	Enthalpy/Internal energy for patch [J/kg]. More...

virtual tmp< volScalarField >	hc () const =0
	Chemical enthalpy [J/kg]. More...

virtual tmp< scalarField >	THE (const scalarField &h, const scalarField &p, const scalarField &T0, const labelList &cells) const =0
	Temperature from enthalpy/internal energy for cell-set. More...

virtual tmp< scalarField >	THE (const scalarField &h, const scalarField &p, const scalarField &T0, const label patchi) const =0
	Temperature from enthalpy/internal energy for patch. More...

virtual const volScalarField &	T () const
	Temperature [K]. More...

virtual volScalarField &	T ()
	Temperature [K]. More...

virtual tmp< volScalarField >	Cp () const =0
	Heat capacity at constant pressure [J/kg/K]. More...

virtual tmp< scalarField >	Cp (const scalarField &p, const scalarField &T, const label patchi) const =0
	Heat capacity at constant pressure for patch [J/kg/K]. More...

virtual tmp< scalarField >	Cp (const scalarField &p, const scalarField &T, const labelList &cells) const =0
	Heat capacity using pressure and temperature [J/kg/K]. More...

virtual tmp< volScalarField >	Cv () const =0
	Heat capacity at constant volume [J/kg/K]. More...

virtual tmp< scalarField >	Cv (const scalarField &p, const scalarField &T, const label patchi) const =0
	Heat capacity at constant volume for patch [J/kg/K]. More...

virtual tmp< scalarField >	rhoEoS (const scalarField &p, const scalarField &T, const labelList &cells) const =0
	Density from pressure and temperature from EoS. More...

virtual tmp< volScalarField >	gamma () const =0
	Gamma = Cp/Cv []. More...

virtual tmp< scalarField >	gamma (const scalarField &p, const scalarField &T, const label patchi) const =0
	Gamma = Cp/Cv for patch []. More...

virtual tmp< volScalarField >	Cpv () const =0
	Heat capacity at constant pressure/volume [J/kg/K]. More...

virtual tmp< scalarField >	Cpv (const scalarField &p, const scalarField &T, const label patchi) const =0
	Heat capacity at constant pressure/volume for patch [J/kg/K]. More...

virtual tmp< volScalarField >	CpByCpv () const =0
	Heat capacity ratio []. More...

virtual tmp< scalarField >	CpByCpv (const scalarField &p, const scalarField &T, const label patchi) const =0
	Heat capacity ratio for patch []. More...

virtual tmp< volScalarField >	W () const =0
	Molecular weight [kg/kmol]. More...

virtual const volScalarField &	alpha () const
	Thermal diffusivity for enthalpy of mixture [kg/m/s]. More...

virtual const scalarField &	alpha (const label patchi) const
	Thermal diffusivity for enthalpy of mixture for patch [kg/m/s]. More...

virtual tmp< volScalarField >	kappa () const =0
	Thermal diffusivity for temperature of mixture [J/m/s/K]. More...

virtual tmp< scalarField >	kappa (const label patchi) const =0
	Thermal diffusivity for temperature. More...

virtual tmp< volScalarField >	alphahe () const =0
	Thermal diffusivity for energy of mixture [kg/m/s]. More...

virtual tmp< scalarField >	alphahe (const label patchi) const =0
	Thermal diffusivity for energy of mixture for patch [kg/m/s]. More...

virtual tmp< volScalarField >	kappaEff (const volScalarField &) const =0
	Effective thermal diffusivity for temperature. More...

virtual tmp< scalarField >	kappaEff (const scalarField &alphat, const label patchi) const =0
	Effective thermal diffusivity for temperature. More...

virtual tmp< volScalarField >	alphaEff (const volScalarField &alphat) const =0
	Effective thermal diffusivity of mixture [kg/m/s]. More...

virtual tmp< scalarField >	alphaEff (const scalarField &alphat, const label patchi) const =0
	Effective thermal diffusivity of mixture for patch [kg/m/s]. More...

virtual bool	read ()
	Read thermophysical properties dictionary. More...

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)
	Construct given an IOobject and Istream. More...

virtual	~IOdictionary ()=default
	Destructor. More...

virtual bool	global () const
	Is object global. More...

virtual fileName	filePath () const
	Return complete path + object name if the file exists. More...

Public Member Functions inherited from baseIOdictionary
	TypeName ("dictionary")
	Declare type-name, virtual type (with debug switch) More...

	baseIOdictionary (const baseIOdictionary &)=default
	Copy construct. More...

	baseIOdictionary (baseIOdictionary &&)=default
	Move construct. More...

virtual	~baseIOdictionary ()=default
	Destructor. More...

	baseIOdictionary (const IOobject &io, const dictionary *fallback=nullptr)

	baseIOdictionary (const IOobject &io, const dictionary &dict)

	baseIOdictionary (const IOobject &io, Istream &is)
	Construct given an IOobject and Istream (ununsed) More...

const word &	name () const

virtual bool	readData (Istream &)
	The readData function required by regIOobject read operation. More...

virtual bool	writeData (Ostream &) const
	The writeData function required by regIOobject write operation. More...

void	operator= (const baseIOdictionary &rhs)
	Copy assignment of dictionary entries (leave regIOobject untouched) More...

void	operator= (const dictionary &rhs)
	Copy assignment of dictionary entries. 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	ownedByRegistry () const
	Is this object owned by the registry? More...

bool	store ()

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...

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...

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 label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched. More...

const labelList &	watchIndices () const
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	Return file-monitoring handles. More...

virtual bool	modified () const

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) 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...

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 r=NO_READ, writeOption w=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 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 &registry, 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 &registry)
	Copy construct, resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name. More...

	IOobject (const IOobject &io, readOption, writeOption)
	Copy construct, resetting io 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 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
	Return non-constant access to the optional note. 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	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 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

const fileName &	caseName () const

const fileName &	instance () const noexcept

fileName &	instance () noexcept

const fileName &	local () const noexcept

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

bool	bad () const noexcept

InfoProxy< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &io)

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	isHeaderClassName () const
	Specialization for `void` always returns true (no headerClassName check). More...

template<class StringType >
Foam::word	groupName (StringType base, const word &group)

Public Member Functions inherited from dictionary
	ClassName ("dictionary")

	dictionary ()
	Default construct, a top-level empty dictionary. More...

	dictionary (const fileName &name)
	Construct top-level empty dictionary with given name. More...

	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)
	Copy construct given the parent dictionary. More...

	dictionary (const dictionary &dict)
	Copy construct top-level dictionary. More...

	dictionary (const dictionary *dict)
	Construct top-level dictionary as copy from pointer to dictionary. More...

	dictionary (const dictionary &parentDict, dictionary &&dict)
	Move construct for given parent dictionary. More...

	dictionary (dictionary &&dict)
	Move construct top-level dictionary. More...

autoPtr< dictionary >	clone () const
	Construct and return clone. More...

virtual	~dictionary ()
	Destructor. More...

const fileName &	name () const noexcept
	The dictionary name. More...

fileName &	name () noexcept
	The dictionary name for modification (use with caution). More...

word	dictName () const
	The local dictionary name (final part of scoped name) More...

fileName	relativeName (const bool caseTag=false) const
	The dictionary name relative to the case. More...

bool	isNullDict () const noexcept
	The dictionary is actually dictionary::null (root dictionary) More...

const dictionary &	parent () const noexcept
	Return the parent dictionary. More...

const dictionary &	topDict () const
	Return the top of the tree. More...

label	startLineNumber () const
	Return line number of first token in dictionary. More...

label	endLineNumber () const
	Return line number of last token in dictionary. More...

SHA1Digest	digest () const
	Return the SHA1 digest of the dictionary contents. More...

tokenList	tokens () const
	Return the dictionary as a list of tokens. More...

bool	found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Search for an entry (const access) with the given keyword. More...

entry *	findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find for an entry (non-const access) with the given keyword. More...

const entry *	findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find an entry (const access) with the given keyword. More...

const entry *	findScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Search for a scoped entry (const access) with the given keyword. More...

dictionary *	findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary pointer if present. More...

const dictionary *	findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary pointer if present. More...

const entry &	lookupEntry (const word &keyword, enum keyType::option matchOpt) const
	Search for an entry (const access) with the given keyword. More...

ITstream &	lookup (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
	Check if entry is found and is a sub-dictionary. More...

const dictionary &	subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary. More...

dictionary &	subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary for manipulation. More...

dictionary &	subDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary for manipulation. More...

dictionary	subOrEmptyDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX, const bool mandatory=false) const

const dictionary &	optionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary, otherwise return this dictionary. More...

wordList	toc () const
	Return the table of contents. More...

wordList	sortedToc () const
	Return the sorted table of contents. More...

template<class Compare >
wordList	sortedToc (const Compare &comp) const
	Return table of contents sorted using the specified comparator. More...

List< keyType >	keys (bool patterns=false) const
	Return the list of available keys or patterns. More...

bool	substituteKeyword (const word &keyword, bool mergeEntry=false)
	Substitute the given keyword (which is prefixed by '$') More...

bool	substituteScopedKeyword (const word &keyword, bool mergeEntry=false)
	Substitute the given scoped keyword (which is prefixed by '$') More...

entry *	add (entry *entryPtr, bool mergeEntry=false)
	Add a new entry. More...

entry *	add (const entry &e, bool mergeEntry=false)
	Add an entry. More...

entry *	add (const keyType &k, const word &v, bool overwrite=false)
	Add a word entry. More...

entry *	add (const keyType &k, const string &v, bool overwrite=false)
	Add a string entry. More...

entry *	add (const keyType &k, const label v, bool overwrite=false)
	Add a label entry. More...

entry *	add (const keyType &k, const scalar v, bool overwrite=false)
	Add a scalar entry. More...

entry *	add (const keyType &k, const dictionary &d, bool mergeEntry=false)
	Add a dictionary entry. More...

template<class T >
entry *	add (const keyType &k, const T &v, bool overwrite=false)
	Add a T entry. More...

entry *	set (entry *entryPtr)
	Assign a new entry, overwriting any existing entry. More...

entry *	set (const entry &e)
	Assign a new entry, overwriting any existing entry. More...

entry *	set (const keyType &k, const dictionary &v)
	Assign a dictionary entry, overwriting any existing entry. More...

template<class T >
entry *	set (const keyType &k, const T &v)
	Assign a T entry, overwriting any existing entry. More...

bool	remove (const word &keyword)
	Remove an entry specified by keyword. More...

bool	changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false)
	Change the keyword for an entry,. More...

bool	merge (const dictionary &dict)
	Merge entries from the given dictionary. More...

void	clear ()
	Clear the dictionary. More...

void	transfer (dictionary &dict)
	Transfer the contents of the argument and annul the argument. More...

void	checkITstream (const ITstream &is, const word &keyword) const

bool	read (Istream &is)
	Read dictionary from Istream. Discards the header. More...

bool	read (Istream &is, bool keepHeader)
	Read dictionary from Istream, optionally keeping the header. More...

void	writeEntry (Ostream &os) const
	Write sub-dictionary with its dictName as its header. More...

void	writeEntry (const keyType &keyword, Ostream &os) const
	Write sub-dictionary with the keyword as its header. More...

void	writeEntries (Ostream &os, const bool extraNewLine=false) const
	Write dictionary entries. More...

void	write (Ostream &os, const bool subDict=true) const
	Write dictionary, normally with sub-dictionary formatting. More...

const_searcher	csearch (const word &keyword, enum keyType::option=keyType::REGEX) const
	Search dictionary for given keyword. More...

const_searcher	search (const word &keyword, enum keyType::option=keyType::REGEX) const
	Search dictionary for given keyword. More...

searcher	search (const word &keyword, enum keyType::option=keyType::REGEX)
	Search dictionary for given keyword. More...

const_searcher	csearchScoped (const word &keyword, enum keyType::option) const
	Search using scoping. More...

const_searcher	searchScoped (const word &keyword, enum keyType::option) const
	Search using dot or slash scoping. More...

searcher	searchScoped (const word &keyword, enum keyType::option)
	Search using dot or slash scoping. More...

const dictionary *	cfindScopedDict (const fileName &dictPath) const
	Locate a sub-dictionary using slash-scoping. More...

const dictionary *	findScopedDict (const fileName &dictPath) const
	Locate a sub-dictionary using slash-scoping. More...

dictionary *	findScopedDict (const fileName &dictPath)
	Locate a sub-dictionary using slash-scoping. More...

dictionary *	makeScopedDict (const fileName &dictPath)
	Locate existing or create sub-dictionary using slash-scoping. More...

const_searcher	csearchCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
	Search dictionary for given keyword and any compatibility names. More...

bool	foundCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
	Search dictionary for given keyword and any compatibility names. More...

const entry *	findCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const

const entry &	lookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const

ITstream &	lookupCompat (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)
	Copy assignment. More...

void	operator+= (const dictionary &rhs)
	Include entries from the given dictionary. More...

void	operator\|= (const dictionary &rhs)
	Conditionally include entries from the given dictionary. More...

void	operator<<= (const dictionary &rhs)
	Unconditionally include entries from the given dictionary. More...

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

ITstream &	operator[] (const word &keyword) const
	Deprecated(2018-07) find and return an entry data stream. More...

bool	found (const word &keyword, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...

entry *	lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch)
	Deprecated(2018-10) More...

const entry *	lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10) More...

const entry *	lookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10) More...

const dictionary *	subDictPtr (const word &keyword) const
	Deprecated(2018-10) More...

dictionary *	subDictPtr (const word &keyword)

const entry &	lookupEntry (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10) More...

ITstream &	lookup (const word &keyword, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...

template<class T >
T	lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...

template<class T >
T	lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true)
	Deprecated(2018-10) More...

template<class T >
bool	readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...

template<class T >
T	lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const
	Deprecated(2018-10) find and return a T. More...

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::entry *	add (const keyType &k, const T &v, bool overwrite)

template<class T >
Foam::entry *	set (const keyType &k, const T &v)

Public Member Functions inherited from ILList< LListBase, T >
	ILList ()=default
	Default construct. More...

	ILList (T *item)
	Construct and insert the initial T item pointer. More...

	ILList (Istream &is)
	Construct from Istream. More...

	ILList (const ILList< LListBase, T > &lst)
	Copy construct using the 'clone()' method for each element. More...

	ILList (ILList< LListBase, T > &&lst)
	Move construct. More...

template<class CloneArg >
	ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
	Copy constructor with additional argument for clone 'clone()'. More...

template<class INew >
	ILList (Istream &is, const INew &inew)
	Construct from Istream using given Istream constructor class. More...

	~ILList ()
	Destructor. More...

bool	eraseHead ()
	Remove the head element specified from the list and delete it. More...

bool	erase (T *item)
	Remove the specified element from the list and delete it. More...

void	clear ()
	Clear the contents of the list. More...

void	transfer (ILList< LListBase, T > &lst)

void	operator= (const ILList< LListBase, T > &lst)
	Copy assignment using the 'clone()' method for each element. More...

void	operator= (ILList< LListBase, T > &&lst)
	Move assignment. More...

Static Public Member Functions
template<class Thermo >
static autoPtr< Thermo >	New (const fvMesh &, const word &phaseName=word::null)
	Generic New for each of the related thermodynamics packages. More...

template<class Thermo >
static autoPtr< Thermo >	New (const fvMesh &, const dictionary &, const word &phaseName=word::null)
	Generic New for each of the related thermodynamics packages. More...

template<class Thermo >
static autoPtr< Thermo >	New (const fvMesh &, const word &phaseName, const word &dictName)
	Generic New for each of the related thermodynamics packages. More...

static autoPtr< basicThermo >	New (const fvMesh &, const word &phaseName=word::null)
	Specialisation of the Generic New for basicThermo. More...

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

static const basicThermo &	lookupThermo (const fvPatchScalarField &pf)

static Ostream &	printThermoNames (Ostream &os, const wordList &cmptNames, const wordList &thermoNames)
	Print (filtered) table of thermo names, splits on `" ,<>"`. More...

static wordList	splitThermoName (const std::string &thermoName, const int nExpectedCmpts)
	Split thermo package name into a list of components names. 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 an 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 Member Functions inherited from dictionary
static int	reportOptional () noexcept
	Return the state of reporting optional (default) entries. More...

static int	reportOptional (const int level) noexcept
	Change the state of reporting optional (default) entries. More...

static autoPtr< dictionary >	New (Istream &is)
	Construct top-level dictionary on freestore from Istream. More...

Static Public Attributes
static const word	dictName

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...

Static Public Attributes inherited from dictionary
static int	writeOptionalEntries
	Report optional keywords and values if not present in dictionary. More...

static const dictionary	null
	An empty dictionary, which is also the parent for all dictionaries. More...

static refPtr< OSstream >	reportingOutput
	Output location when reporting default values. More...

Protected Member Functions
wordList	heBoundaryTypes ()

wordList	heBoundaryBaseTypes ()

	basicThermo (const basicThermo &)=delete
	No copy construct. 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...

Protected Attributes
const word &	phaseName_
	Phase-name. More...

bool	pOwner_
	Pressure created and stored by this instance. More...

bool	TOwner_
	Temperature created and stored by this instance. More...

bool	dpdt_
	Include dpdt term in the enthalpy equation? More...

volScalarField &	p_
	Pressure [Pa]. More...

volScalarField &	T_
	Temperature [K]. More...

volScalarField	alpha_
	Laminar thermal diffusivity [kg/m/s]. More...

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...

Public Types inherited from dictionary
typedef Searcher< true >	const_searcher
	Searcher with const access. More...

typedef Searcher< false >	searcher
	Searcher with non-const access. More...

Public Attributes inherited from dictionary
friend	const_searcher
	Declare friendship with the searcher classes. More...

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
	To flag master-only reading of objects. More...

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 63 of file basicThermo.H.

Constructor & Destructor Documentation

◆ basicThermo() [1/4]

basicThermo ( const basicThermo & )

protecteddelete

No copy construct.

◆ basicThermo() [2/4]

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

Construct from mesh and phase name.

Definition at line 275 of file basicThermo.C.

◆ basicThermo() [3/4]

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

Construct from mesh, dictionary and phase name.

Definition at line 320 of file basicThermo.C.

◆ basicThermo() [4/4]

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

Construct from mesh, phase name and explicit naming of the dictionary (so it can be shared amongst phases).

Definition at line 367 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

Destructor.

Definition at line 437 of file basicThermo.C.

Member Function Documentation

◆ heBoundaryTypes()

Foam::wordList heBoundaryTypes ( )

protected

Return the enthalpy/internal energy field boundary types by interrogating the temperature field boundary types

Definition at line 198 of file basicThermo.C.

References forAll.

◆ heBoundaryBaseTypes()

Foam::wordList heBoundaryBaseTypes ( )

protected

Return the enthalpy/internal energy field boundary base types by interrogating the temperature field boundary types

Definition at line 164 of file basicThermo.C.

References forAll.

◆ TypeName()

TypeName ( "basicThermo" )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

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

Declare run-time constructor selection table.

◆ declareRunTimeSelectionTable() [2/2]

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

Declare run-time constructor selection table for dictionary based.

◆ New() [1/7]

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

static

Generic New for each of the related thermodynamics packages.

◆ New() [2/7]

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

static

Generic New for each of the related thermodynamics packages.

◆ New() [3/7]

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

static

Generic New for each of the related thermodynamics packages.

◆ New() [4/7]

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

static

Specialisation of the Generic New for basicThermo.

Definition at line 426 of file basicThermo.C.

References mesh.

◆ phasePropertyName() [1/2]

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

inlinestatic

Definition at line 259 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 267 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

Definition at line 446 of file basicThermo.C.

References fvPatchField< Type >::db(), dictName(), objectRegistry::findObject(), forAllConstIters(), fvPatchField< Type >::internalField(), objectRegistry::lookupClass(), objectRegistry::lookupObject(), thermo, and thermos().

Referenced by mixedEnergyFvPatchScalarField::manipulateMatrix(), energyJumpAMIFvPatchScalarField::updateCoeffs(), energyJumpFvPatchScalarField::updateCoeffs(), fixedEnergyFvPatchScalarField::updateCoeffs(), mixedEnergyFvPatchScalarField::updateCoeffs(), and gradientEnergyFvPatchScalarField::updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ printThermoNames()

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

static

Print (filtered) table of thermo names, splits on " ,<>".

Definition at line 75 of file basicThermo.C.

References os(), Foam::printTable(), and DynamicList< T, SizeMin >::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

Check that the thermodynamics package is consistent.

with energy forms supported by the application

Definition at line 478 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

Check that the thermodynamics package is consistent.

with energy forms supported by the application

Definition at line 493 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

Check that the thermodynamics package is consistent.

with energy forms supported by the application

Definition at line 516 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

Check that the thermodynamics package is consistent.

with energy forms supported by the application

Definition at line 542 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

Split thermo package name into a list of components names.

Splits on " ,<>"

Returns: empty list if the split name does not have the expected number of components (non-zero).

Definition at line 572 of file basicThermo.C.

References List< T >::resize().

Here is the call graph for this function:

◆ correct()

virtual void correct ( )

pure virtual

Update properties.

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

Return the name of the thermo physics.

Implemented in phaseSystem, twoPhaseMixtureEThermo, multiphaseMixtureThermo, and twoPhaseMixtureThermo.

◆ incompressible()

virtual bool incompressible ( ) const

pure virtual

Return true if the equation of state is incompressible.

i.e. rho != f(p)

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureEThermo, and twoPhaseMixtureThermo.

◆ isochoric()

virtual bool isochoric ( ) const

pure virtual

Return true if the equation of state is isochoric.

i.e. rho = const

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureEThermo, and twoPhaseMixtureThermo.

◆ dpdt()

bool dpdt ( ) const

inlinenoexcept

True if dpdt term should be included in enthalpy equation.

Definition at line 345 of file basicThermo.H.

References basicThermo::dpdt_.

Referenced by phaseModel::dpdt().

Here is the caller graph for this function:

◆ updateT()

bool updateT ( ) const

inlinenoexcept

True if T should be updated.

Definition at line 351 of file basicThermo.H.

References basicThermo::TOwner_.

◆ p() [1/2]

Foam::volScalarField & p ( )

virtual

Pressure [Pa].

Non-const access allowed for transport equations

Definition at line 602 of file basicThermo.C.

Referenced by pyrolysisChemistryModel< CompType, SolidThermo, GasThermo >::calculate(), phaseSystem::correctKinematics(), twoPhaseMixtureEThermo::Cp(), twoPhaseMixtureThermo::Cp(), multiphaseMixtureThermo::Cp(), phaseSystem::Cp(), twoPhaseMixtureEThermo::he(), twoPhaseMixtureEThermo::rhoEoS(), twoPhaseMixtureThermo::rhoEoS(), multiphaseMixtureThermo::rhoEoS(), solidChemistryModel< CompType, SolidThermo >::RRsHs(), and pyrolysisChemistryModel< CompType, SolidThermo, GasThermo >::solve().

Here is the caller graph for this function:

◆ p() [2/2]

const Foam::volScalarField & p ( ) const

virtual

Pressure [Pa].

Definition at line 608 of file basicThermo.C.

◆ rho() [1/2]

virtual tmp<volScalarField> rho ( ) const

pure virtual

Density [kg/m^3].

Implemented in phaseSystem, phaseSystem, multiphaseMixtureThermo, psiThermo, rhoThermo, twoPhaseMixtureEThermo, solidThermo, and twoPhaseSystem.

◆ rho() [2/2]

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

pure virtual

Density for patch [kg/m^3].

Implemented in phaseSystem, multiphaseMixtureThermo, psiThermo, rhoThermo, twoPhaseMixtureEThermo, and solidThermo.

◆ he() [1/5]

virtual volScalarField& he ( )

pure virtual

Enthalpy/Internal energy [J/kg].

Non-const access allowed for transport equations

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

Referenced by energyJumpFvPatchScalarField::updateCoeffs(), and energyJumpAMIFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

◆ he() [2/5]

virtual const volScalarField& he ( ) const

pure virtual

Enthalpy/Internal energy [J/kg].

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

◆ he() [3/5]

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

pure virtual

Enthalpy/Internal energy.

for given pressure and temperature [J/kg]

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

◆ he() [4/5]

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

pure virtual

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

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

◆ he() [5/5]

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

pure virtual

Enthalpy/Internal energy for patch [J/kg].

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

◆ hc()

virtual tmp<volScalarField> hc ( ) const

pure virtual

Chemical enthalpy [J/kg].

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

Temperature from enthalpy/internal energy for cell-set.

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

◆ THE() [2/2]

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

pure virtual

Temperature from enthalpy/internal energy for patch.

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

◆ T() [1/2]

const Foam::volScalarField & T ( ) const

virtual

Temperature [K].

Definition at line 614 of file basicThermo.C.

Referenced by pyrolysisChemistryModel< CompType, SolidThermo, GasThermo >::calculate(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), OneResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), laminarFlameSpeed::New(), solidChemistryModel< CompType, SolidThermo >::RRsHs(), and pyrolysisChemistryModel< CompType, SolidThermo, GasThermo >::solve().

Here is the caller graph for this function:

◆ T() [2/2]

Foam::volScalarField & T ( )

virtual

Temperature [K].

Non-const access allowed for transport equations

Definition at line 620 of file basicThermo.C.

◆ Cp() [1/3]

virtual tmp<volScalarField> Cp ( ) const

pure virtual

Heat capacity at constant pressure [J/kg/K].

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

Referenced by tabulatedNTUHeatTransfer::calculateHtc(), BreenWestwater::htcFilmBoil(), and Bromley::htcFilmBoil().

Here is the caller graph for this function:

◆ Cp() [2/3]

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

pure virtual

Heat capacity at constant pressure for patch [J/kg/K].

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

◆ Cp() [3/3]

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

pure virtual

Heat capacity using pressure and temperature [J/kg/K].

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

◆ Cv() [1/2]

virtual tmp<volScalarField> Cv ( ) const

pure virtual

Heat capacity at constant volume [J/kg/K].

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

Heat capacity at constant volume for patch [J/kg/K].

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

◆ rhoEoS()

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

pure virtual

Density from pressure and temperature from EoS.

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

Referenced by Zuber::CHF(), Tatsumoto::CHFSubCool(), HuaXu::CHFSubCool(), BreenWestwater::htcFilmBoil(), Bromley::htcFilmBoil(), Jeschar::MHF(), and Kutadeladze::qNucleate().

Here is the caller graph for this function:

◆ gamma() [1/2]

virtual tmp<volScalarField> gamma ( ) const

pure virtual

Gamma = Cp/Cv [].

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

Referenced by phaseModel::gamma(), and outletMachNumberPressureFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

◆ gamma() [2/2]

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

pure virtual

Gamma = Cp/Cv for patch [].

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

◆ Cpv() [1/2]

virtual tmp<volScalarField> Cpv ( ) const

pure virtual

Heat capacity at constant pressure/volume [J/kg/K].

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

Heat capacity at constant pressure/volume for patch [J/kg/K].

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

◆ CpByCpv() [1/2]

virtual tmp<volScalarField> CpByCpv ( ) const

pure virtual

Heat capacity ratio [].

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

Heat capacity ratio for patch [].

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

◆ W()

virtual tmp<volScalarField> W ( ) const

pure virtual

Molecular weight [kg/kmol].

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

◆ alpha() [1/2]

const Foam::volScalarField & alpha ( ) const

virtual

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

Definition at line 626 of file basicThermo.C.

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

Here is the caller graph for this function:

◆ alpha() [2/2]

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

virtual

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

Definition at line 632 of file basicThermo.C.

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

Here is the call graph for this function:

◆ kappa() [1/2]

virtual tmp<volScalarField> kappa ( ) const

pure virtual

Thermal diffusivity for temperature of mixture [J/m/s/K].

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

Thermal diffusivity for temperature.

of mixture for patch [J/m/s/K]

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

◆ alphahe() [1/2]

virtual tmp<volScalarField> alphahe ( ) const

pure virtual

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

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

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

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

◆ kappaEff() [1/2]

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

pure virtual

Effective thermal diffusivity for temperature.

of mixture [J/m/s/K]

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

◆ kappaEff() [2/2]

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

pure virtual

Effective thermal diffusivity for temperature.

of mixture for patch [J/m/s/K]

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

◆ alphaEff() [1/2]

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

pure virtual

Effective thermal diffusivity of mixture [kg/m/s].

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

◆ alphaEff() [2/2]

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

pure virtual

Effective thermal diffusivity of mixture for patch [kg/m/s].

Implemented in phaseSystem, multiphaseMixtureThermo, twoPhaseMixtureThermo, and twoPhaseMixtureEThermo.

◆ read()

bool read ( )

virtual

Read thermophysical properties dictionary.

Reimplemented from regIOobject.

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

Definition at line 638 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 132 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 162 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 180 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

Phase-name.

Definition at line 121 of file basicThermo.H.

Referenced by basicThermo::phasePropertyName().

◆ pOwner_

bool pOwner_

protected

Pressure created and stored by this instance.

Definition at line 124 of file basicThermo.H.

◆ TOwner_

bool TOwner_

protected

Temperature created and stored by this instance.

Definition at line 127 of file basicThermo.H.

Referenced by basicThermo::updateT().

◆ dpdt_

bool dpdt_

protected

Include dpdt term in the enthalpy equation?

Definition at line 130 of file basicThermo.H.

Referenced by basicThermo::dpdt().

◆ p_

volScalarField& p_

protected

Pressure [Pa].

Definition at line 136 of file basicThermo.H.

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

◆ T_

volScalarField& T_

protected

Temperature [K].

Definition at line 139 of file basicThermo.H.

◆ alpha_

volScalarField alpha_

protected

Laminar thermal diffusivity [kg/m/s].

Definition at line 142 of file basicThermo.H.

◆ dictName

const Foam::word dictName

static

Definition at line 256 of file basicThermo.H.

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

src/thermophysicalModels/basic/basicThermo/basicThermo.H
src/thermophysicalModels/basic/basicThermo/basicThermo.C
src/thermophysicalModels/basic/basicThermo/basicThermoTemplates.C

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ basicThermo() [1/4]

◆ basicThermo() [2/4]

◆ basicThermo() [3/4]

◆ basicThermo() [4/4]

◆ ~basicThermo()

Member Function Documentation

◆ heBoundaryTypes()

◆ heBoundaryBaseTypes()

◆ TypeName()

◆ declareRunTimeSelectionTable() [1/2]

◆ declareRunTimeSelectionTable() [2/2]

◆ New() [1/7]

◆ New() [2/7]

◆ New() [3/7]

◆ New() [4/7]

◆ phasePropertyName() [1/2]

◆ phasePropertyName() [2/2]

◆ lookupThermo()

◆ printThermoNames()

◆ validate() [1/4]

◆ validate() [2/4]

◆ validate() [3/4]

◆ validate() [4/4]

◆ splitThermoName()

◆ correct()

◆ thermoName()

◆ incompressible()

◆ isochoric()

◆ dpdt()

◆ updateT()

◆ p() [1/2]

◆ p() [2/2]

◆ rho() [1/2]

◆ rho() [2/2]

◆ he() [1/5]

◆ he() [2/5]

◆ he() [3/5]

◆ he() [4/5]

◆ he() [5/5]

◆ hc()

◆ THE() [1/2]

◆ THE() [2/2]

◆ T() [1/2]

◆ T() [2/2]

◆ Cp() [1/3]

◆ Cp() [2/3]

◆ Cp() [3/3]

◆ Cv() [1/2]

◆ Cv() [2/2]

◆ rhoEoS()

◆ gamma() [1/2]

◆ gamma() [2/2]

◆ Cpv() [1/2]

◆ Cpv() [2/2]

◆ CpByCpv() [1/2]

◆ CpByCpv() [2/2]

◆ W()

◆ alpha() [1/2]

◆ alpha() [2/2]

◆ kappa() [1/2]

◆ kappa() [2/2]

◆ alphahe() [1/2]

◆ alphahe() [2/2]

◆ kappaEff() [1/2]

◆ kappaEff() [2/2]

◆ alphaEff() [1/2]

◆ alphaEff() [2/2]

◆ read()

◆ New() [5/7]

◆ New() [6/7]

◆ New() [7/7]

Member Data Documentation