Thermo implementation and storage of energy and heat capacities. Provides overloads of the functions defined in the basic thermo type that depend on the primitive thermo model. More...

Inheritance diagram for BasicThermo< MixtureType, BasicThermoType >:

[legend]

Collaboration diagram for BasicThermo< MixtureType, BasicThermoType >:

[legend]

Public Types
typedef MixtureType	mixtureType
	Mixture type. More...

typedef BasicThermoType	basicThermoType
	Basic thermo. More...

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

Public Types inherited from UILList< LListBase, T >
typedef T	value_type
	Type of values the DLList contains. More...

typedef T &	reference
	Type that can be used for storing into DLList::value_type. More...

typedef const T &	const_reference
	Type that can be used for storing into constant. More...

typedef label	size_type
	The type that can represent the size of a DLList. More...

typedef LListBase::iterator	LListBase_iterator

typedef LListBase::const_iterator	LListBase_const_iterator

Public Member Functions
	BasicThermo (const fvMesh &, const word &phaseName)
	Construct from mesh and phase name. More...

	BasicThermo (const BasicThermo< MixtureType, BasicThermoType > &)=delete
	Disallow default bitwise copy construction. More...

virtual	~BasicThermo ()
	Destructor. More...

virtual IOdictionary &	properties ()
	Return the properties dictionary. More...

virtual const IOdictionary &	properties () const
	Return the properties dictionary. More...

const MixtureType &	mixture () const
	Return the mixture. More...

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

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

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

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

virtual tmp< scalarField >	W (const label patchi) const
	Molecular weight for patch [kg/kmol]. More...

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

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

virtual const volScalarField &	Cp () const
	Heat capacity at constant pressure [J/kg/K]. More...

virtual const volScalarField &	Cv () const
	Heat capacity at constant volume [J/kg/K]. More...

virtual const volScalarField &	Cpv () const
	Heat capacity at constant pressure/volume [J/kg/K]. More...

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

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

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

virtual tmp< scalarField >	he (const scalarField &T, const fvSource &source) const
	Enthalpy/Internal energy for source [J/kg]. More...

virtual tmp< volScalarField >	hs () const
	Sensible enthalpy [J/kg/K]. More...

virtual tmp< volScalarField >	hs (const volScalarField &p, const volScalarField &T) const
	Sensible enthalpy. More...

virtual tmp< scalarField >	hs (const scalarField &T, const label patchi) const
	Sensible enthalpy for patch [J/kg/K]. More...

virtual tmp< scalarField >	hs (const scalarField &T, const labelList &cells) const
	Sensible enthalpy for cell-set [J/kg]. More...

virtual tmp< volScalarField >	ha () const
	Absolute enthalpy [J/kg/K]. More...

virtual tmp< volScalarField >	ha (const volScalarField &p, const volScalarField &T) const
	Absolute enthalpy. More...

virtual tmp< scalarField >	ha (const scalarField &T, const label patchi) const
	Absolute enthalpy for patch [J/kg/K]. More...

virtual tmp< scalarField >	ha (const scalarField &T, const labelList &cells) const
	Absolute enthalpy for cell-set [J/kg]. More...

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

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

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

virtual tmp< volScalarField >	The (const volScalarField &h, const volScalarField &p, const volScalarField &T0) const
	Temperature from enthalpy/internal energy. More...

virtual tmp< scalarField >	The (const scalarField &he, const scalarField &T0, const labelList &cells) const
	Temperature from enthalpy/internal energy for cell-set. More...

virtual tmp< scalarField >	The (const scalarField &he, const scalarField &T0, const label patchi) const
	Temperature from enthalpy/internal energy for patch. More...

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

template<class Mixture , class Method , class ... Args>
Foam::tmp< Foam::volScalarField >	volScalarFieldProperty (const word &psiName, const dimensionSet &psiDim, Mixture mixture, Method psiMethod, const Args &... args) const

template<class Mixture , class Method , class ... Args>
Foam::tmp< Foam::scalarField >	cellSetProperty (Mixture mixture, Method psiMethod, const labelList &cells, const Args &... args) const

template<class Mixture , class Method , class ... Args>
Foam::tmp< Foam::scalarField >	patchFieldProperty (Mixture mixture, Method psiMethod, const label patchi, const Args &... args) const

template<class Mixture , class Method , class ... Args>
Foam::tmp< Foam::scalarField >	fieldSourceProperty (Mixture mixture, Method psiMethod, const fvSource &source, const Args &... args) const

Public Member Functions inherited from physicalProperties
	TypeName ("physicalProperties")
	Runtime type information. More...

	physicalProperties (const objectRegistry &obr, const word &group)
	Construct from components. More...

	physicalProperties (const physicalProperties &)=delete
	Disallow default bitwise copy construction. More...

virtual	~physicalProperties ()
	Destructor. More...

void	operator= (const physicalProperties &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from IOdictionary
	TypeName ("dictionary")

	IOdictionary (const IOobject &)
	Construct given an IOobject. More...

	IOdictionary (const IOobject &, const dictionary &)
	Construct given an IOobject and dictionary. More...

	IOdictionary (const IOobject &, Istream &)
	Construct given an IOobject and Istream. More...

	IOdictionary (const IOdictionary &)
	Copy constructor. More...

	IOdictionary (IOdictionary &&)
	Move constructor. More...

virtual	~IOdictionary ()
	Destructor. More...

virtual bool	global () const
	Return true as object is global, i.e. same for all processors. More...

virtual bool	readData (Istream &)
	ReadData function required for regIOobject read operation. More...

virtual bool	writeData (Ostream &) const
	WriteData function required for regIOobject write operation. More...

void	operator= (const IOdictionary &)
	Assignment of dictionary entries only. More...

void	operator= (IOdictionary &&)
	Move assignment of dictionary entries only. 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 &)
	Copy constructor. More...

	regIOobject (const regIOobject &&)
	Move constructor. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Copy constructor, transferring registry registration to copy. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy constructor with new name, transferring registry registration. More...

	regIOobject (const IOobject &, const regIOobject &)
	Copy constructor with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

virtual bool	globalFile () const
	Return true if object is global, i.e. same for all processors. More...

const fileName &	caseName () const

fileName	path () const
	Return complete path. More...

fileName	objectPath () const
	Return complete path + object name. More...

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

bool	checkIn ()
	Add object to registry. More...

bool	checkOut ()
	Remove object from registry. More...

void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) More...

bool	registered () const
	Is this object registered with the registry? 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...

bool	headerOk ()
	Read and check header info. More...

Istream &	readStream (const word &, const bool read=true)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. 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	dependenciesModified () const
	Return true if the object's dependencies have been modified. 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 write) const
	Write using given format, version and compression. More...

virtual bool	write (const bool write=true) const
	Write using setting from DB. More...

void	operator= (const IOobject &)
	Assign to IOobject. More...

void	operator= (const regIOobject &)=delete
	Disallow default assignment. More...

const fileName &	caseName (const bool global) const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

fileName	filePath (const word &typeName, const bool global) const
	Return complete path + object name if the file exists. More...

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Runtime type information. More...

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, registry, io options. 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)
	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)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Construct from copy resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Construct from copy resetting name. More...

	IOobject (const IOobject &io)=default
	Copy constructor. More...

autoPtr< IOobject >	clone () const
	Clone. More...

autoPtr< IOobject >	clone (const objectRegistry &registry) 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...

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 bool global) const

fileName &	instance () const
	Return the instance directory, constant, system, <time> etc. More...

void	updateInstance () const
	If the instance is a time directory update to the current time. More...

const fileName &	local () const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

fileName	relativePath () const
	Return the path relative to the case directory. More...

fileName	relativeObjectPath () const
	Return complete relativePath + object name. More...

fileName	filePath (const word &typeName, const bool global) const
	Return complete path + object name if the file exists. More...

bool	readHeader (Istream &)
	Read header. More...

bool	headerOk ()
	Read header of local object without type-checking. 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)

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

	dictionary ()
	Construct top-level dictionary null. More...

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

	dictionary (const fileName &name, const dictionary &parentDict, Istream &)
	Construct given the entry name, parent dictionary and Istream,. More...

	dictionary (Istream &, const bool keepHeader=false)
	Construct top-level dictionary from Istream,. More...

template<class T , class ... KeysAndTs>
	dictionary (const keyType &k, const T &t, const KeysAndTs &... keysAndTs)
	Construct top-level dictionary with given T entries. More...

template<class T , class ... KeysAndTs>
	dictionary (const fileName &name, const keyType &k, const T &t, const KeysAndTs &... keysAndTs)
	Construct top-level dictionary with given name and T entries. More...

	dictionary (const dictionary &parentDict, const dictionary &)
	Construct as copy given the parent dictionary. More...

	dictionary (const dictionary &)
	Construct top-level dictionary as copy. More...

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

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

virtual	~dictionary ()
	Destructor. More...

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

bool	isNull () const
	Return whether this dictionary is null. More...

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

word	topDictKeyword () const
	Return the scoped keyword with which this dictionary can be. 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 &, bool recursive=false, bool patternMatch=true) const
	Search dictionary for given keyword. More...

const entry *	lookupEntryPtr (const word &, bool recursive, bool patternMatch) const
	Find and return an entry data stream pointer if present. More...

entry *	lookupEntryPtr (const word &, bool recursive, bool patternMatch)
	Find and return an entry data stream pointer for manipulation. More...

const entry *	lookupEntryPtrBackwardsCompatible (const wordList &, bool recursive, bool patternMatch) const
	Find and return an entry data stream if present, trying a list. More...

const entry &	lookupEntry (const word &, bool recursive, bool patternMatch) const
	Find and return an entry data stream if present otherwise error. More...

const entry &	lookupEntryBackwardsCompatible (const wordList &, bool recursive, bool patternMatch) const
	Find and return an entry data stream if present, trying a list. More...

ITstream &	lookup (const word &, bool recursive=false, bool patternMatch=true) const
	Find and return an entry data stream. More...

ITstream &	lookupBackwardsCompatible (const wordList &, bool recursive=false, bool patternMatch=true) const
	Find and return an entry data stream, trying a list of keywords. More...

template<class T >
T	lookup (const word &, bool recursive=false, bool patternMatch=true) const
	Find and return a T, if not found throw a fatal error. More...

template<class T >
T	lookup (const word &, const unitConversion &, bool recursive=false, bool patternMatch=true) const
	Find and return a T, with dimension checking and unit. More...

template<class T >
T	lookupBackwardsCompatible (const wordList &, bool recursive=false, bool patternMatch=true) const
	Find and return a T, trying a list of keywords in sequence,. More...

template<class T >
T	lookupBackwardsCompatible (const wordList &, const unitConversion &, bool recursive=false, bool patternMatch=true) const
	Find and return a T, with dimension checking and unit. More...

template<class T >
T	lookupOrDefault (const word &, const T &, bool recursive=false, bool patternMatch=true) const
	Find and return a T, if not found return the given default. More...

template<class T >
T	lookupOrDefault (const word &, const unitConversion &, const T &, bool recursive=false, bool patternMatch=true) const
	Find and return a T with dimension checking and unit. More...

template<class T >
T	lookupOrDefaultBackwardsCompatible (const wordList &, const T &, bool recursive=false, bool patternMatch=true) const
	Find and return a T, trying a list of keywords in sequence,. More...

template<class T >
T	lookupOrDefaultBackwardsCompatible (const wordList &, const unitConversion &, const T &, bool recursive=false, bool patternMatch=true) const
	Find and return a T, with dimension checking and unit. More...

template<class T >
T	lookupOrAddDefault (const word &, const T &, bool recursive=false, bool patternMatch=true)
	Find and return a T, if not found return the given. More...

template<class T >
bool	readIfPresent (const word &, T &, bool recursive=false, bool patternMatch=true) const
	Find an entry if present, and assign to T. More...

template<class T >
bool	readIfPresent (const word &, const unitConversion &, T &, bool recursive=false, bool patternMatch=true) const
	Find an entry if present, and assign to T, with dimension. More...

const entry *	lookupScopedEntryPtr (const word &, bool recursive, bool patternMatch) const
	Find and return an entry data stream pointer if present,. More...

template<class T >
T	lookupScoped (const word &, bool recursive=false, bool patternMatch=true) const
	Find and return a T,. More...

template<class T >
const T &	lookupCompoundScoped (const word &keyword, bool recursive, bool patternMatch) const
	Find return the reference to the compound T,. More...

bool	isDict (const word &) const
	Check if entry is a sub-dictionary. More...

const dictionary *	subDictPtr (const word &) const
	Find and return a sub-dictionary pointer if present. More...

dictionary *	subDictPtr (const word &)
	Find and return a sub-dictionary pointer if present. More...

const dictionary &	subDict (const word &) const
	Find and return a sub-dictionary. More...

dictionary &	subDict (const word &)
	Find and return a sub-dictionary for manipulation. More...

const dictionary &	subDictBackwardsCompatible (const wordList &) const
	Find and return a sub-dictionary, trying a list of keywords in. More...

dictionary	subOrEmptyDict (const word &, const bool mustRead=false) const
	Find and return a sub-dictionary as a copy, or. More...

const dictionary &	optionalSubDict (const word &) const
	Find and return a sub-dictionary if found. More...

const dictionary &	scopedDict (const word &) const
	Find and return a sub-dictionary by scoped lookup. More...

dictionary &	scopedDict (const word &)
	Find and return a sub-dictionary by scoped lookup. More...

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

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

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

bool	substituteKeyword (const word &keyword)
	Substitute the given keyword prepended by '$' with the. More...

bool	substituteScopedKeyword (const word &keyword)
	Substitute the given scoped keyword prepended by '$' with the. More...

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

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

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

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

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

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

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

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

void	set (entry *)
	Assign a new entry, overwrite any existing entry. More...

void	set (const entry &)
	Assign a new entry, overwrite any existing entry. More...

void	set (const keyType &, const dictionary &)
	Assign a dictionary entry, overwrite any existing entry. More...

template<class T >
void	set (const keyType &, const T &)
	Assign a T entry, overwrite any existing entry. More...

template<class T , class ... KeysAndTs>
void	set (const keyType &, const T &, const KeysAndTs &...)
	Assign multiple T entries, overwriting any existing entries. More...

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

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

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

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

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

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

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

ITstream &	operator[] (const word &) const
	Find and return entry. More...

void	operator= (const dictionary &)

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

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

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

template<class T , class ... KeysAndTs>
void	set (const keyType &k, const T &t, const KeysAndTs &... keysAndTs)

Public Member Functions inherited from dictionaryName
	dictionaryName ()
	Construct dictionaryName null. More...

	dictionaryName (const fileName &name)
	Construct dictionaryName as copy of the given fileName. More...

	dictionaryName (dictionaryName &&name)
	Move constructor. More...

const fileName &	name () const
	Return the dictionary name. More...

fileName &	name ()
	Return the dictionary name. More...

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

void	operator= (const dictionaryName &name)

void	operator= (dictionaryName &&name)

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

	ILList (T *a)
	Construct given initial T. More...

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

	ILList (const ILList< LListBase, T > &)
	Copy constructor. More...

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

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

template<class INew >
	ILList (Istream &, const 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 *p)
	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 > &)
	Transfer the contents of the argument into this List. More...

void	operator= (const ILList< LListBase, T > &)
	Assignment operator. More...

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

Public Member Functions inherited from UILList< LListBase, T >
	UILList ()
	Null construct. More...

	UILList (T *a)
	Construct given initial T. More...

	UILList (const UILList< LListBase, T > &)
	Copy constructor. More...

	UILList (UILList< LListBase, T > &&)
	Move constructor. More...

T *	first ()
	Return the first entry. More...

const T *	first () const
	Return the first entry. More...

T *	last ()
	Return the last entry. More...

const T *	last () const
	Return the last entry. More...

T *	removeHead ()
	Remove and return head. More...

T *	remove (T *p)
	Remove and return element. More...

T *	remove (iterator &it)
	Remove and return specified by iterator. More...

void	operator= (const UILList< LListBase, T > &)
	Assignment operator. More...

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

iterator	begin ()

const iterator &	end ()

const_iterator	cbegin () const

const const_iterator &	cend () const

const_iterator	begin () const

const const_iterator &	end () const

const_reverse_iterator	crbegin () const

const const_reverse_iterator &	crend () const

const_reverse_iterator	rbegin () const

const const_reverse_iterator &	rend () const

bool	operator== (const UILList< LListBase, T > &) const
	Equality operation on ULists of the same type. More...

bool	operator!= (const UILList< LListBase, T > &) const
	The opposite of the equality operation. Takes linear time. More...

Protected Member Functions
template<class Mixture , class Method , class ... Args>
tmp< volScalarField >	volScalarFieldProperty (const word &psiName, const dimensionSet &psiDim, Mixture mixture, Method psiMethod, const Args &... args) const
	Return a volScalarField of the given property. More...

template<class Mixture , class Method , class ... Args>
tmp< scalarField >	cellSetProperty (Mixture mixture, Method psiMethod, const labelList &cells, const Args &... args) const
	Return a scalarField of the given property on a cell set. More...

template<class Mixture , class Method , class ... Args>
tmp< scalarField >	patchFieldProperty (Mixture mixture, Method psiMethod, const label patchi, const Args &... args) const
	Return a scalarField of the given property on a patch. More...

template<class Mixture , class Method , class ... Args>
tmp< scalarField >	fieldSourceProperty (Mixture mixture, Method psiMethod, const fvSource &source, const Args &... args) const
	Return a scalarField of the given property for a source. More...

void	heBoundaryCorrection (volScalarField &he)
	Correct the enthalpy/internal energy field boundaries. More...

Protected Member Functions inherited from IOdictionary
	IOdictionary (const IOobject &io, const word &wantedType)
	Construct given an IOobject, supply wanted typeName. More...

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
	Read header, check readOpt flags and read data if necessary. More...

Protected Member Functions inherited from IOobject
void	setBad (const string &)
	Set the object state to bad. More...

template<class Type >
bool	typeHeaderOk (const bool checkType)
	Read header using typeGlobalFile to find file. More...

Static Protected Member Functions
static UIndirectList< scalar >	cellSetScalarList (const volScalarField &psi, const labelUList &cells)
	Return an indirect list of a field for the given set of cells. More...

static UniformField< scalar >	cellSetScalarList (const uniformGeometricScalarField &psi, const labelUList &)
	Return an indirect list of a field for the given set of cells. More...

Protected Attributes
volScalarField	he_
	Energy field. More...

volScalarField	Cp_
	Heat capacity at constant pressure field [J/kg/K]. More...

volScalarField	Cv_

Additional Inherited Members
Static Public Member Functions inherited from physicalProperties
static IOobject	findModelDict (const objectRegistry &obr, const word &group, bool registerObject=false)
	Find the physicalProperties dictionary and return the IOobject. 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 Member Functions inherited from dictionary
static autoPtr< dictionary >	New (Istream &)
	Construct top-level dictionary on freestore from Istream. More...

Static Public Attributes inherited from IOdictionary
static bool	writeDictionaries

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

Static Public Attributes inherited from IOobject
static constexpr const char *	foamFile = "FoamFile"
	Keyword for the FoamFile header sub-dictionary. More...

static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

Static Public Attributes inherited from dictionary
static const dictionary	null
	Null dictionary. More...

static bool	writeOptionalEntries
	If true write optional keywords and values. More...

Detailed Description

template<class MixtureType, class BasicThermoType>
class Foam::BasicThermo< MixtureType, BasicThermoType >

Thermo implementation and storage of energy and heat capacities. Provides overloads of the functions defined in the basic thermo type that depend on the primitive thermo model.

Source files

Definition at line 60 of file BasicThermo.H.

Member Typedef Documentation

◆ mixtureType

typedef MixtureType mixtureType

Mixture type.

Definition at line 147 of file BasicThermo.H.

◆ basicThermoType

typedef BasicThermoType basicThermoType

Basic thermo.

Definition at line 150 of file BasicThermo.H.

Constructor & Destructor Documentation

◆ BasicThermo() [1/2]

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

Construct from mesh and phase name.

Definition at line 229 of file BasicThermo.C.

References BasicThermo< MixtureType, BasicThermoType >::he_, and BasicThermo< MixtureType, BasicThermoType >::heBoundaryCorrection().

Here is the call graph for this function:

◆ BasicThermo() [2/2]

BasicThermo ( const BasicThermo< MixtureType, BasicThermoType > & )

delete

Disallow default bitwise copy construction.

◆ ~BasicThermo()

~BasicThermo

virtual

Destructor.

Definition at line 298 of file BasicThermo.C.

Member Function Documentation

◆ volScalarFieldProperty() [1/2]

tmp<volScalarField> volScalarFieldProperty	(	const word &	psiName,
		const dimensionSet &	psiDim,
		Mixture	mixture,
		Method	psiMethod,
		const Args &...	args
	)		const

protected

Return a volScalarField of the given property.

◆ cellSetProperty() [1/2]

tmp<scalarField> cellSetProperty	(	Mixture	mixture,
		Method	psiMethod,
		const labelList &	cells,
		const Args &...	args
	)		const

protected

Return a scalarField of the given property on a cell set.

◆ patchFieldProperty() [1/2]

tmp<scalarField> patchFieldProperty	(	Mixture	mixture,
		Method	psiMethod,
		const label	patchi,
		const Args &...	args
	)		const

protected

Return a scalarField of the given property on a patch.

◆ fieldSourceProperty() [1/2]

tmp<scalarField> fieldSourceProperty	(	Mixture	mixture,
		Method	psiMethod,
		const fvSource &	source,
		const Args &...	args
	)		const

protected

Return a scalarField of the given property for a source.

◆ cellSetScalarList() [1/2]

Foam::UIndirectList< Foam::scalar > cellSetScalarList	(	const volScalarField &	psi,
		const labelUList &	cells
	)

staticprotected

Return an indirect list of a field for the given set of cells.

Definition at line 182 of file BasicThermo.C.

References cells, and psi.

◆ cellSetScalarList() [2/2]

Foam::UniformField< Foam::scalar > cellSetScalarList	(	const uniformGeometricScalarField &	psi,
		const labelUList &
	)

staticprotected

Return an indirect list of a field for the given set of cells.

Definition at line 194 of file BasicThermo.C.

References psi.

◆ heBoundaryCorrection()

void heBoundaryCorrection ( volScalarField & he )

protected

Correct the enthalpy/internal energy field boundaries.

Definition at line 205 of file BasicThermo.C.

References forAll, Foam::constant::universal::h, and patchi.

Referenced by BasicThermo< MixtureType, BasicThermoType >::BasicThermo().

Here is the caller graph for this function:

◆ properties() [1/2]

virtual IOdictionary& properties ( )

inlinevirtual

Return the properties dictionary.

Definition at line 173 of file BasicThermo.H.

◆ properties() [2/2]

virtual const IOdictionary& properties ( ) const

inlinevirtual

Return the properties dictionary.

Definition at line 179 of file BasicThermo.H.

◆ mixture()

const MixtureType& mixture ( ) const

inline

Return the mixture.

Definition at line 185 of file BasicThermo.H.

◆ thermoName()

virtual word thermoName ( ) const

inlinevirtual

Return the name of the thermo physics.

Definition at line 191 of file BasicThermo.H.

◆ incompressible()

virtual bool incompressible ( ) const

inlinevirtual

Return true if the equation of state is incompressible.

i.e. rho != f(p)

Definition at line 198 of file BasicThermo.H.

◆ isochoric()

virtual bool isochoric ( ) const

inlinevirtual

Return true if the equation of state is isochoric.

i.e. rho = const

Definition at line 205 of file BasicThermo.H.

◆ W() [1/2]

Foam::tmp< Foam::volScalarField > W

virtual

Molecular weight [kg/kmol].

Definition at line 306 of file BasicThermo.C.

References Foam::dimMass, Foam::dimMoles, and W().

Here is the call graph for this function:

◆ W() [2/2]

Foam::tmp< Foam::scalarField > W ( const label patchi ) const

virtual

Molecular weight for patch [kg/kmol].

Definition at line 320 of file BasicThermo.C.

References patchi, and W().

Here is the call graph for this function:

◆ he() [1/6]

virtual const volScalarField& he ( ) const

inlinevirtual

Enthalpy/Internal energy [J/kg].

Definition at line 223 of file BasicThermo.H.

References BasicThermo< MixtureType, BasicThermoType >::he_.

◆ he() [2/6]

virtual volScalarField& he ( )

inlinevirtual

Enthalpy/Internal energy [J/kg].

Non-const access allowed for transport equations

Definition at line 230 of file BasicThermo.H.

◆ Cp() [1/2]

virtual const volScalarField& Cp ( ) const

inlinevirtual

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

Definition at line 236 of file BasicThermo.H.

References BasicThermo< MixtureType, BasicThermoType >::Cp_.

◆ Cv() [1/2]

virtual const volScalarField& Cv ( ) const

inlinevirtual

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

Definition at line 242 of file BasicThermo.H.

References BasicThermo< MixtureType, BasicThermoType >::Cv_.

◆ Cpv() [1/2]

const Foam::volScalarField & Cpv

virtual

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

Definition at line 336 of file BasicThermo.C.

◆ he() [3/6]

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

virtual

Enthalpy/Internal energy.

for given pressure and temperature [J/kg]

Definition at line 351 of file BasicThermo.C.

References Foam::dimEnergy, Foam::dimMass, he(), p, and Foam::T().

Here is the call graph for this function:

◆ he() [4/6]

Foam::tmp< Foam::scalarField > he	(	const scalarField &	T,
		const labelList &	cells
	)		const

virtual

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

Definition at line 371 of file BasicThermo.C.

References cells, he(), and Foam::T().

Here is the call graph for this function:

◆ he() [5/6]

Foam::tmp< Foam::scalarField > he	(	const scalarField &	T,
		const label	patchi
	)		const

virtual

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

Definition at line 390 of file BasicThermo.C.

References he(), patchi, and Foam::T().

Here is the call graph for this function:

◆ he() [6/6]

Foam::tmp< Foam::scalarField > he	(	const scalarField &	T,
		const fvSource &	source
	)		const

virtual

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

Definition at line 409 of file BasicThermo.C.

References fvSource::cells(), he(), and Foam::T().

Here is the call graph for this function:

◆ hs() [1/4]

Foam::tmp< Foam::volScalarField > hs

virtual

Sensible enthalpy [J/kg/K].

Definition at line 428 of file BasicThermo.C.

References Foam::dimEnergy, Foam::dimMass, and hs().

Here is the call graph for this function:

◆ hs() [2/4]

Foam::tmp< Foam::volScalarField > hs	(	const volScalarField &	p,
		const volScalarField &	T
	)		const

virtual

Sensible enthalpy.

for given pressure and temperature [J/kg]

Definition at line 444 of file BasicThermo.C.

References Foam::dimEnergy, Foam::dimMass, hs(), p, and Foam::T().

Here is the call graph for this function:

◆ hs() [3/4]

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

virtual

Sensible enthalpy for patch [J/kg/K].

Definition at line 483 of file BasicThermo.C.

References hs(), patchi, and Foam::T().

Here is the call graph for this function:

◆ hs() [4/4]

Foam::tmp< Foam::scalarField > hs	(	const scalarField &	T,
		const labelList &	cells
	)		const

virtual

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

Definition at line 464 of file BasicThermo.C.

References cells, hs(), and Foam::T().

Here is the call graph for this function:

◆ ha() [1/4]

Foam::tmp< Foam::volScalarField > ha

virtual

Absolute enthalpy [J/kg/K].

Definition at line 502 of file BasicThermo.C.

References Foam::dimEnergy, Foam::dimMass, and ha().

Here is the call graph for this function:

◆ ha() [2/4]

Foam::tmp< Foam::volScalarField > ha	(	const volScalarField &	p,
		const volScalarField &	T
	)		const

virtual

Absolute enthalpy.

for given pressure and temperature [J/kg]

Definition at line 518 of file BasicThermo.C.

References Foam::dimEnergy, Foam::dimMass, ha(), p, and Foam::T().

Here is the call graph for this function:

◆ ha() [3/4]

Foam::tmp< Foam::scalarField > ha	(	const scalarField &	T,
		const label	patchi
	)		const

virtual

Absolute enthalpy for patch [J/kg/K].

Definition at line 557 of file BasicThermo.C.

References ha(), patchi, and Foam::T().

Here is the call graph for this function:

◆ ha() [4/4]

Foam::tmp< Foam::scalarField > ha	(	const scalarField &	T,
		const labelList &	cells
	)		const

virtual

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

Definition at line 538 of file BasicThermo.C.

References cells, ha(), and Foam::T().

Here is the call graph for this function:

◆ Cp() [2/2]

Foam::tmp< Foam::scalarField > Cp	(	const scalarField &	T,
		const label	patchi
	)		const

virtual

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

Definition at line 576 of file BasicThermo.C.

References Cp(), patchi, and Foam::T().

Here is the call graph for this function:

◆ Cv() [2/2]

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

virtual

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

Definition at line 595 of file BasicThermo.C.

References Cv(), patchi, and Foam::T().

Here is the call graph for this function:

◆ Cpv() [2/2]

Foam::tmp< Foam::scalarField > Cpv	(	const scalarField &	T,
		const label	patchi
	)		const

virtual

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

Definition at line 614 of file BasicThermo.C.

References Cp(), Cv(), patchi, and Foam::T().

Here is the call graph for this function:

◆ The() [1/3]

Foam::tmp< Foam::volScalarField > The	(	const volScalarField &	h,
		const volScalarField &	p,
		const volScalarField &	T0
	)		const

virtual

Temperature from enthalpy/internal energy.

Definition at line 633 of file BasicThermo.C.

References Foam::dimTemperature, Foam::constant::universal::h, p, and T0.

◆ The() [2/3]

Foam::tmp< Foam::scalarField > The	(	const scalarField &	he,
		const scalarField &	T0,
		const labelList &	cells
	)		const

virtual

Temperature from enthalpy/internal energy for cell-set.

Definition at line 655 of file BasicThermo.C.

References cells, Foam::constant::universal::h, and T0.

◆ The() [3/3]

Foam::tmp< Foam::scalarField > The	(	const scalarField &	he,
		const scalarField &	T0,
		const label	patchi
	)		const

virtual

Temperature from enthalpy/internal energy for patch.

Definition at line 676 of file BasicThermo.C.

References Foam::constant::universal::h, patchi, and T0.

◆ read()

bool read

virtual

Read thermophysical properties dictionary.

Reimplemented from physicalProperties.

Definition at line 696 of file BasicThermo.C.

References physicalProperties::read(), and Foam::blockMeshTools::read().

Here is the call graph for this function:

◆ volScalarFieldProperty() [2/2]

Foam::tmp<Foam::volScalarField> volScalarFieldProperty	(	const word &	psiName,
		const dimensionSet &	psiDim,
		Mixture	mixture,
		Method	psiMethod,
		const Args &...	args
	)		const

Definition at line 35 of file BasicThermo.C.

References args, forAll, Foam::constant::atomic::group, Foam::compressible::New(), patchi, psi, and tmp< T >::ref().

Here is the call graph for this function:

◆ cellSetProperty() [2/2]

Foam::tmp<Foam::scalarField> cellSetProperty	(	Mixture	mixture,
		Method	psiMethod,
		const labelList &	cells,
		const Args &...	args
	)		const

Definition at line 90 of file BasicThermo.C.

References args, cells, forAll, psi, tmp< T >::ref(), and scalarField().

Here is the call graph for this function:

◆ patchFieldProperty() [2/2]

Foam::tmp<Foam::scalarField> patchFieldProperty	(	Mixture	mixture,
		Method	psiMethod,
		const label	patchi,
		const Args &...	args
	)		const

Definition at line 120 of file BasicThermo.C.

References args, forAll, patchi, psi, tmp< T >::ref(), and scalarField().

Here is the call graph for this function:

◆ fieldSourceProperty() [2/2]

Foam::tmp<Foam::scalarField> fieldSourceProperty	(	Mixture	mixture,
		Method	psiMethod,
		const fvSource &	source,
		const Args &...	args
	)		const

Definition at line 152 of file BasicThermo.C.

References args, cells, fvSource::cells(), forAll, psi, tmp< T >::ref(), and scalarField().

Here is the call graph for this function:

Member Data Documentation

◆ he_

volScalarField he_

protected

Energy field.

Definition at line 72 of file BasicThermo.H.

Referenced by BasicThermo< MixtureType, BasicThermoType >::BasicThermo(), and BasicThermo< MixtureType, BasicThermoType >::he().

◆ Cp_

volScalarField Cp_

protected

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

Definition at line 75 of file BasicThermo.H.

Referenced by BasicThermo< MixtureType, BasicThermoType >::Cp().

◆ Cv_

volScalarField Cv_

protected

Definition at line 78 of file BasicThermo.H.

Referenced by BasicThermo< MixtureType, BasicThermoType >::Cv().

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

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

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class MixtureType, class BasicThermoType> class Foam::BasicThermo< MixtureType, BasicThermoType >

Member Typedef Documentation

◆ mixtureType

◆ basicThermoType

Constructor & Destructor Documentation

◆ BasicThermo() [1/2]

◆ BasicThermo() [2/2]

◆ ~BasicThermo()

Member Function Documentation

◆ volScalarFieldProperty() [1/2]

◆ cellSetProperty() [1/2]

◆ patchFieldProperty() [1/2]

◆ fieldSourceProperty() [1/2]

◆ cellSetScalarList() [1/2]

◆ cellSetScalarList() [2/2]

◆ heBoundaryCorrection()

◆ properties() [1/2]

◆ properties() [2/2]

◆ mixture()

◆ thermoName()

◆ incompressible()

◆ isochoric()

◆ W() [1/2]

◆ W() [2/2]

◆ he() [1/6]

◆ he() [2/6]

◆ Cp() [1/2]

◆ Cv() [1/2]

◆ Cpv() [1/2]

◆ he() [3/6]

◆ he() [4/6]

◆ he() [5/6]

◆ he() [6/6]

◆ hs() [1/4]

◆ hs() [2/4]

◆ hs() [3/4]

◆ hs() [4/4]

◆ ha() [1/4]

◆ ha() [2/4]

◆ ha() [3/4]

◆ ha() [4/4]

◆ Cp() [2/2]

◆ Cv() [2/2]

◆ Cpv() [2/2]

◆ The() [1/3]

◆ The() [2/3]

◆ The() [3/3]

◆ read()

◆ volScalarFieldProperty() [2/2]

◆ cellSetProperty() [2/2]

◆ patchFieldProperty() [2/2]

◆ fieldSourceProperty() [2/2]

Member Data Documentation

◆ he_

◆ Cp_

◆ Cv_

template<class MixtureType, class BasicThermoType>
class Foam::BasicThermo< MixtureType, BasicThermoType >