Fundamental solid thermodynamic properties. More...

Inheritance diagram for solidThermo:

Collaboration diagram for solidThermo:

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

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

	declareRunTimeSelectionTable (autoPtr, solidThermo, dictionary,(const fvMesh &mesh, const dictionary &dict, const word &phaseName),(mesh, dict, phaseName))

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

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

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

	solidThermo (const fvMesh &, const word &phaseName, const word &dictionaryName)
	Construct from mesh with dictionary name and without. More...

virtual	~solidThermo ()
	Destructor. More...

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

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

virtual volScalarField &	rho ()
	Return non-const access to the local density field [kg/m^3]. More...

virtual tmp< volVectorField >	Kappa () const =0
	Thermal conductivity [W/m/K]. More...

virtual bool	isotropic () const =0
	Return true if thermal conductivity is isotropic. More...

virtual tmp< vectorField >	Kappa (const label patchi) const =0
	Anisotropic thermal conductivity [W/m/K]. More...

virtual bool	read ()
	Read thermophysicalProperties dictionary. More...

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

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

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

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

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

	rhoThermo (const fvMesh &, const word &phaseName, const word &dictionaryName)
	Construct from mesh,dictionary,phase name with a single temperature. More...

virtual	~rhoThermo ()
	Destructor. More...

virtual void	correctRho (const volScalarField &deltaRho, const dimensionedScalar &rhoMin, const dimensionedScalar &rhoMax)
	Add the given density correction to the density field. More...

virtual void	correctRho (const volScalarField &deltaRho)
	Add the given density correction to the density field. More...

virtual const volScalarField &	psi () const
	Compressibility [s^2/m^2]. More...

virtual tmp< volScalarField >	mu () const
	Dynamic viscosity of mixture [kg/m/s]. More...

virtual tmp< scalarField >	mu (const label patchi) const
	Dynamic viscosity of mixture for patch [kg/m/s]. More...

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

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

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

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

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

	fluidThermo (const fvMesh &, const word &phaseName, const word &dictionaryName)
	Construct from mesh,dictionary,phase name with a single temperature. More...

virtual	~fluidThermo ()
	Destructor. More...

virtual tmp< volScalarField >	nu () const
	Kinematic viscosity of mixture [m^2/s]. More...

virtual tmp< scalarField >	nu (const label patchi) const
	Kinematic viscosity of mixture for patch [m^2/s]. More...

Public Member Functions inherited from basicThermo
	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)
	Construct from mesh, phase name and explicit naming of the. More...

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

Switch	dpdt () const
	Should the dpdt term be included in the enthalpy equation. More...

Switch	updateT () const
	Should T be updated. More...

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

virtual const volScalarField &	p () const
	Pressure [Pa]. 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< 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< 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...

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

virtual	~IOdictionary ()
	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 &)
	Construct given an IOobject. More...

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

	baseIOdictionary (const IOobject &, Istream &)
	Construct given an IOobject and Istream. 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 &)
	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 isTime=false)

	regIOobject (const regIOobject &rio)
	Copy construct. More...

	regIOobject (const regIOobject &rio, bool registerCopy)

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)

	regIOobject (const IOobject &io, const regIOobject &rio)
	Copy construct with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

bool	checkIn ()
	Add object to registry, if not already registered. More...

bool	checkOut ()
	Remove all file watches and remove object from registry. More...

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

bool	ownedByRegistry () const
	Is this object owned by the registry? More...

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

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 (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::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)
	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...

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

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

const objectRegistry &	db () const
	Return the local objectRegistry. More...

const Time &	time () const
	Return time. More...

const word &	name () const
	Return name. More...

const word &	headerClassName () const
	Return name of the class name read from header. More...

word &	headerClassName ()
	Return non-constant access to the class name read from header. More...

const string &	note () const
	Return the optional note. More...

string &	note ()
	Return non-constant access to the optional note. More...

bool	registerObject () const
	Should object created with this IOobject be registered? More...

bool &	registerObject ()
	Should object created with this IOobject be registered? More...

bool	globalObject () const
	Is object same for all processors? More...

bool &	globalObject ()
	Is object same for all processors? More...

unsigned	labelByteSize () const
	The label byte-size, possibly read from the header. More...

unsigned	scalarByteSize () const
	The scalar byte-size, possibly read from the header. More...

bool	isHeaderClassName (const word &clsName) const
	Test if headerClassName() equals the given class name. More...

template<class Type >
bool	isHeaderClassName () const
	Test if headerClassName() equals Type::typeName. More...

readOption	readOpt () const
	The read option. More...

readOption &	readOpt ()
	Non-constant access to the read option. More...

writeOption	writeOpt () const
	The write option. More...

writeOption &	writeOpt ()
	Non-constant access to the write option. More...

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const

fileName &	instance ()

const fileName &	local () const

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

fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local. More...

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

fileName	localFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches locally. More...

fileName	globalFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches up if in parallel. More...

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

template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
	Read header (uses typeFilePath to find file) and check its info. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...

bool	writeHeader (Ostream &os) const
	Write header. More...

bool	writeHeader (Ostream &os, const word &objectType) const
	Write header. Allow override of type. More...

bool	good () const

bool	bad () const

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

void	operator= (const IOobject &io)

template<>
bool	isHeaderClassName () const
	Specialization for `void` always returns true (no headerClassName check). More...

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

template<class StringType >
Foam::word	scopedName (StringType scope, const word &name)

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 &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
	The dictionary name. More...

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

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

const dictionary &	parent () const
	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. 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...

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

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

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

	compressibleTransportModel ()
	Construct from components. More...

virtual	~compressibleTransportModel ()
	Destructor. More...

Static Public Member Functions
static autoPtr< solidThermo >	New (const fvMesh &, const word &phaseName=word::null)
	Return a pointer to a new solidThermo created from. More...

static autoPtr< solidThermo >	New (const fvMesh &, const dictionary &, const word &phaseName=word::null)
	Return a pointer to a new solidThermo created from. More...

static autoPtr< solidThermo >	New (const fvMesh &, const word &phaseName, const word &dictName)
	Return a pointer to a new solidThermo created from. More...

Static Public Member Functions inherited from rhoThermo
static autoPtr< rhoThermo >	New (const fvMesh &, const word &phaseName=word::null)
	Selector. More...

static autoPtr< rhoThermo >	New (const fvMesh &, const word &phaseName, const word &dictName)
	Selector. More...

Static Public Member Functions inherited from fluidThermo
static autoPtr< fluidThermo >	New (const fvMesh &, const word &phaseName=word::null)
	Selector. More...

static autoPtr< fluidThermo >	New (const fvMesh &, const word &phaseName, const word &dictName)
	Selector. More...

Static Public Member Functions inherited from basicThermo
template<class Thermo , class Table >
static Table::iterator	lookupThermo (const dictionary &thermoTypeDict, Table tablePtr, std::initializer_list< const char > cmptNames, const word &thermoTypeName)
	Generic lookup for thermodynamics package thermoTypeName. More...

template<class Thermo , class Table >
static Table::iterator	lookupThermo (const dictionary &thermoDict, Table *tablePtr)
	Generic lookup for each of the related thermodynamics packages. More...

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 wordList	splitThermoName (const word &thermoName, const int nCmpt)
	Split name of thermo package into a list of the components names. More...

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *p)

template<class Type >
static Type &	store (autoPtr< Type > &aptr)

template<class Type >
static Type &	store (autoPtr< Type > &&aptr)

template<class Type >
static Type &	store (tmp< Type > &tptr)

template<class Type >
static Type &	store (tmp< Type > &&tptr)

Static Public Member Functions inherited from IOobject
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class StringType >
static word	groupName (StringType 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...

template<class StringType >
static word	scopedName (StringType 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, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider. More...

static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider. More...

Static Public Member Functions inherited from dictionary
static autoPtr< dictionary >	New (Istream &is)
	Construct top-level dictionary on freestore from Istream. 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 Public Attributes inherited from basicThermo
static const word	dictName

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

static int	maxFileModificationPolls

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes. More...

static char	scopeSeparator
	Character for scoping object names (':' or '_') More...

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. 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...

Protected Member Functions inherited from rhoThermo
	rhoThermo (const rhoThermo &)
	Construct as copy (not implemented) More...

Protected Member Functions inherited from basicThermo
	basicThermo (const basicThermo &)
	Construct as copy (not implemented) More...

wordList	heBoundaryTypes ()
	Return the enthalpy/internal energy field boundary types. More...

wordList	heBoundaryBaseTypes ()
	Return the enthalpy/internal energy field boundary base types. More...

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

Istream *	objectStream ()
	Construct and return an IFstream for the object. More...

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

Static Protected Member Functions inherited from basicThermo
static volScalarField &	lookupOrConstruct (const fvMesh &mesh, const word &, bool &isOwner)
	Look up or construct field. More...

Protected Attributes inherited from rhoThermo
volScalarField	rho_
	Density field [kg/m^3]. More...

volScalarField	psi_
	Compressibility [s^2/m^2]. More...

volScalarField	mu_
	Dynamic viscosity [kg/m/s]. More...

Protected Attributes inherited from basicThermo
const word &	phaseName_
	Phase-name. More...

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

bool	pOwner_

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

bool	TOwner_

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

Switch	dpdt_
	Should the dpdt term be included in the enthalpy equation. More...

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects. More...

Detailed Description

Fundamental solid thermodynamic properties.

Source files

Definition at line 52 of file solidThermo.H.

Constructor & Destructor Documentation

◆ solidThermo() [1/3]

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

Construct from mesh and phase name.

Definition at line 47 of file solidThermo.C.

◆ solidThermo() [2/3]

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

Construct from mesh, dictionary and phase name.

Definition at line 57 of file solidThermo.C.

◆ solidThermo() [3/3]

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

Construct from mesh with dictionary name and without.

constructing T phaseName

Definition at line 68 of file solidThermo.C.

◆ ~solidThermo()

~solidThermo ( )

virtual

Destructor.

Definition at line 115 of file solidThermo.C.

Member Function Documentation

◆ TypeName()

TypeName ( "solidThermo" )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/3]

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

◆ declareRunTimeSelectionTable() [2/3]

declareRunTimeSelectionTable	(	autoPtr	,
		solidThermo	,
		dictionary	,
		(const fvMesh &mesh, const dictionary &dict, const word &phaseName)	,
		(mesh, dict, phaseName)
	)

◆ declareRunTimeSelectionTable() [3/3]

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

Declare run-time constructor selection table for dictionary based.

◆ New() [1/3]

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

static

Return a pointer to a new solidThermo created from.

the solidThermophysicalProperties dictionary

Definition at line 82 of file solidThermo.C.

References mesh.

◆ New() [2/3]

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

static

Return a pointer to a new solidThermo created from.

local dictionary

Definition at line 92 of file solidThermo.C.

References dict, and mesh.

◆ New() [3/3]

Foam::autoPtr< Foam::solidThermo > New	(	const fvMesh &	mesh,
		const word &	phaseName,
		const word &	dictName
	)

static

Return a pointer to a new solidThermo created from.

local dictionary and phase name

Definition at line 103 of file solidThermo.C.

References dictName(), and mesh.

Here is the call graph for this function:

◆ rho() [1/3]

Foam::tmp< Foam::volScalarField > rho ( ) const

virtual

Density [kg/m^3].

Reimplemented from rhoThermo.

Definition at line 121 of file solidThermo.C.

Referenced by pyrolysisChemistryModel< CompType, SolidThermo, GasThermo >::pyrolysisChemistryModel().

Here is the caller graph for this function:

◆ rho() [2/3]

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

virtual

Density for patch [kg/m^3].

Reimplemented from rhoThermo.

Definition at line 127 of file solidThermo.C.

◆ rho() [3/3]

Foam::volScalarField & rho ( )

virtual

Return non-const access to the local density field [kg/m^3].

Reimplemented from rhoThermo.

Definition at line 133 of file solidThermo.C.

◆ Kappa() [1/2]

virtual tmp<volVectorField> Kappa ( ) const

pure virtual

Thermal conductivity [W/m/K].

◆ isotropic()

virtual bool isotropic ( ) const

pure virtual

Return true if thermal conductivity is isotropic.

◆ Kappa() [2/2]

virtual tmp<vectorField> Kappa ( const label patchi ) const

pure virtual

Anisotropic thermal conductivity [W/m/K].

◆ read()

bool read ( )

virtual

Read thermophysicalProperties dictionary.

Reimplemented from basicThermo.

Definition at line 139 of file solidThermo.C.

References regIOobject::read().

Here is the call graph for this function:

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

src/thermophysicalModels/solidThermo/solidThermo/solidThermo.H
src/thermophysicalModels/solidThermo/solidThermo/solidThermo.C

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ solidThermo() [1/3]

◆ solidThermo() [2/3]

◆ solidThermo() [3/3]

◆ ~solidThermo()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable() [1/3]

◆ declareRunTimeSelectionTable() [2/3]

◆ declareRunTimeSelectionTable() [3/3]

◆ New() [1/3]

◆ New() [2/3]

◆ New() [3/3]

◆ rho() [1/3]

◆ rho() [2/3]

◆ rho() [3/3]

◆ Kappa() [1/2]

◆ isotropic()

◆ Kappa() [2/2]

◆ read()