Liquid thermo model. More...

#include <liquidFilmThermo.H>

Inheritance diagram for liquidFilmThermo:

Collaboration diagram for liquidFilmThermo:

[legend]

Public Member Functions
	TypeName ("liquid")
	Runtime type information.
	liquidFilmThermo (surfaceFilmRegionModel &film, const dictionary &dict)
	Construct from surface film model and dictionary.
virtual	~liquidFilmThermo ()
	Destructor.
virtual const word &	name () const
	Return the specie name.
virtual scalar	rho (const scalar p, const scalar T) const
	Return density [kg/m3].
virtual scalar	mu (const scalar p, const scalar T) const
	Return dynamic viscosity [Pa.s].
virtual scalar	sigma (const scalar p, const scalar T) const
	Return surface tension [kg/s2].
virtual scalar	Cp (const scalar p, const scalar T) const
	Return specific heat capacity [J/kg/K].
virtual scalar	kappa (const scalar p, const scalar T) const
	Return thermal conductivity [W/m/K].
virtual scalar	D (const scalar p, const scalar T) const
	Return diffusivity [m2/s].
virtual scalar	hl (const scalar p, const scalar T) const
	Return latent heat [J/kg].
virtual scalar	pv (const scalar p, const scalar T) const
	Return vapour pressure [Pa].
virtual scalar	W () const
	Return molecular weight [kg/kmol].
virtual scalar	Tb (const scalar p) const
	Return boiling temperature [K].
virtual tmp< volScalarField >	rho () const
	Return density [kg/m3].
virtual tmp< volScalarField >	mu () const
	Return dynamic viscosity [Pa.s].
virtual tmp< volScalarField >	sigma () const
	Return surface tension [kg/s2].
virtual tmp< volScalarField >	Cp () const
	Return specific heat capacity [J/kg/K].
virtual tmp< volScalarField >	kappa () const
	Return thermal conductivity [W/m/K].
Public Member Functions inherited from filmThermoModel
	TypeName ("filmThermoModel")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, filmThermoModel, dictionary,(surfaceFilmRegionModel &film, const dictionary &dict),(film, dict))
	filmThermoModel (surfaceFilmRegionModel &film)
	Construct null.
	filmThermoModel (const word &modelType, surfaceFilmRegionModel &film, const dictionary &dict)
	Construct from type name, dictionary and surface film model.
virtual	~filmThermoModel ()
	Destructor.
Public Member Functions inherited from filmSubModelBase
	filmSubModelBase (surfaceFilmRegionModel &film)
	Construct null.
	filmSubModelBase (surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from film film without name.
	filmSubModelBase (const word &modelName, surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from film film with name.
virtual	~filmSubModelBase ()
	Destructor.
virtual bool	writeTime () const
	Flag to indicate when to write a property.
const surfaceFilmRegionModel &	film () const
	Return const access to the film surface film model.
surfaceFilmRegionModel &	film ()
	Return the reference to the film surface film model.
template<class FilmType>
const FilmType &	filmType () const
Public Member Functions inherited from subModelBase
	subModelBase (dictionary &properties)
	Construct null.
	subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from components without name.
	subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from components with name.
	subModelBase (const subModelBase &smb)
	Construct as copy.
virtual	~subModelBase ()=default
	Destructor.
const word &	modelName () const
	Return const access to the name of the sub-model.
const dictionary &	dict () const
	Return const access to the cloud dictionary.
const word &	baseName () const
	Return const access to the base name of the sub-model.
const word &	modelType () const
	Return const access to the sub-model type.
const dictionary &	coeffDict () const
	Return const access to the coefficients dictionary.
const dictionary &	properties () const
	Return const access to the properties dictionary.
virtual bool	defaultCoeffs (const bool printMsg) const
	Returns true if defaultCoeffs is true and outputs on printMsg.
virtual bool	active () const
	Return the model 'active' status - default active = true.
virtual void	cacheFields (const bool store)
	Cache dependent sub-model fields.
virtual fileName	localPath () const
	Output directory.
template<class Type>
Type	getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the base model.
template<class Type>
void	getBaseProperty (const word &entryName, Type &value) const
	Retrieve generic property from the base model.
template<class Type>
void	setBaseProperty (const word &entryName, const Type &value)
	Add generic property to the base model.
bool	getModelDict (const word &entryName, dictionary &dict) const
	Retrieve dictionary, return true if set.
template<class Type>
bool	getModelProperty (const word &entryName, Type &value) const
	Retrieve generic property from the sub-model.
template<class Type>
Type	getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the sub-model.
template<class Type>
void	setModelProperty (const word &entryName, const Type &value)
	Add generic property to the sub-model.
virtual void	write (Ostream &os) const
	Write.

Protected Member Functions
const thermoSingleLayer &	thermoFilm () const
	Return a reference to a thermo film.
void	initLiquid (const dictionary &dict)
	Initialise the liquid pointer.
	liquidFilmThermo (const liquidFilmThermo &)=delete
	No copy construct.
void	operator= (const liquidFilmThermo &)=delete
	No copy assignment.
Protected Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line.

Protected Attributes
word	name_
	Liquid name.
const liquidProperties *	liquidPtr_
	Pointer to the liquid properties.
bool	ownLiquid_
	Flag to indicate that model owns the liquid object.
bool	useReferenceValues_
	Flag to indicate that reference values of p and T should be used.
scalar	pRef_
	Reference pressure [pa].
scalar	TRef_
	Reference temperature [K].
Protected Attributes inherited from filmSubModelBase
surfaceFilmRegionModel &	filmModel_
	Reference to the film surface film model.
Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model.
dictionary &	properties_
	Reference to properties dictionary e.g. for restart.
const dictionary	dict_
	Copy of dictionary used during construction.
const word	baseName_
	Name of the sub-model base class.
const word	modelType_
	Type of the sub-model.
const dictionary	coeffDict_
	Coefficients dictionary.

Additional Inherited Members
Static Public Member Functions inherited from filmThermoModel
static autoPtr< filmThermoModel >	New (surfaceFilmRegionModel &film, const dictionary &dict)
	Return a reference to the selected phase change model.
Public Attributes inherited from subModelBase
bool	log
	Flag to write log into Info.

Detailed Description

Liquid thermo model.

Source files

Definition at line 54 of file liquidFilmThermo.H.

Constructor & Destructor Documentation

◆ liquidFilmThermo() [1/2]

liquidFilmThermo ( const liquidFilmThermo & )

protecteddelete

No copy construct.

References liquidFilmThermo().

Referenced by liquidFilmThermo(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ liquidFilmThermo() [2/2]

liquidFilmThermo	(	surfaceFilmRegionModel &	film,
		const dictionary &	dict )

Construct from surface film model and dictionary.

Definition at line 104 of file liquidFilmThermo.C.

References subModelBase::coeffDict_, subModelBase::dict(), filmSubModelBase::film(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, initLiquid(), liquidPtr_, name_, ownLiquid_, pRef_, TRef_, and useReferenceValues_.

Here is the call graph for this function:

◆ ~liquidFilmThermo()

~liquidFilmThermo ( )

virtual

Destructor.

Definition at line 130 of file liquidFilmThermo.C.

References Foam::deleteDemandDrivenData(), liquidPtr_, and ownLiquid_.

Here is the call graph for this function:

Member Function Documentation

◆ thermoFilm()

const thermoSingleLayer & thermoFilm ( ) const

protected

Return a reference to a thermo film.

Definition at line 52 of file liquidFilmThermo.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, filmSubModelBase::filmModel_, Foam::isA(), and Foam::refCast().

Referenced by Cp(), kappa(), mu(), rho(), and sigma().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initLiquid()

void initLiquid ( const dictionary & dict )

protected

Initialise the liquid pointer.

Definition at line 68 of file liquidFilmThermo.C.

References subModelBase::dict(), filmSubModelBase::filmModel_, liquidPtr_, name_, liquidProperties::New(), and ownLiquid_.

Referenced by liquidFilmThermo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const liquidFilmThermo & )

protecteddelete

No copy assignment.

References liquidFilmThermo().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "liquid" )

Runtime type information.

References subModelBase::dict(), filmSubModelBase::film(), p, and Foam::T().

Here is the call graph for this function:

◆ name()

const word & name ( ) const

virtual

Return the specie name.

Implements filmThermoModel.

Definition at line 141 of file liquidFilmThermo.C.

References name_.

◆ rho() [1/2]

scalar rho	(	const scalar	p,
		const scalar	T ) const

virtual

Return density [kg/m3].

Implements filmThermoModel.

Definition at line 147 of file liquidFilmThermo.C.

References liquidPtr_, p, and Foam::T().

Referenced by rho().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mu() [1/2]

scalar mu	(	const scalar	p,
		const scalar	T ) const

virtual

Return dynamic viscosity [Pa.s].

Implements filmThermoModel.

Definition at line 157 of file liquidFilmThermo.C.

References liquidPtr_, p, and Foam::T().

Referenced by mu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sigma() [1/2]

scalar sigma	(	const scalar	p,
		const scalar	T ) const

virtual

Return surface tension [kg/s2].

Implements filmThermoModel.

Definition at line 167 of file liquidFilmThermo.C.

References liquidPtr_, p, and Foam::T().

Referenced by sigma().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Cp() [1/2]

scalar Cp	(	const scalar	p,
		const scalar	T ) const

virtual

Return specific heat capacity [J/kg/K].

Implements filmThermoModel.

Definition at line 177 of file liquidFilmThermo.C.

References liquidPtr_, p, and Foam::T().

Referenced by Cp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ kappa() [1/2]

scalar kappa	(	const scalar	p,
		const scalar	T ) const

virtual

Return thermal conductivity [W/m/K].

Implements filmThermoModel.

Definition at line 187 of file liquidFilmThermo.C.

References liquidPtr_, p, and Foam::T().

Referenced by kappa().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ D()

scalar D	(	const scalar	p,
		const scalar	T ) const

virtual

Return diffusivity [m2/s].

Implements filmThermoModel.

Definition at line 197 of file liquidFilmThermo.C.

References liquidPtr_, p, and Foam::T().

Here is the call graph for this function:

◆ hl()

scalar hl	(	const scalar	p,
		const scalar	T ) const

virtual

Return latent heat [J/kg].

Implements filmThermoModel.

Definition at line 207 of file liquidFilmThermo.C.

References liquidPtr_, p, and Foam::T().

Here is the call graph for this function:

◆ pv()

scalar pv	(	const scalar	p,
		const scalar	T ) const

virtual

Return vapour pressure [Pa].

Implements filmThermoModel.

Definition at line 217 of file liquidFilmThermo.C.

References liquidPtr_, p, and Foam::T().

Here is the call graph for this function:

◆ W()

scalar W ( ) const

virtual

Return molecular weight [kg/kmol].

Implements filmThermoModel.

Definition at line 227 of file liquidFilmThermo.C.

References liquidPtr_.

◆ Tb()

scalar Tb ( const scalar p ) const

virtual

Return boiling temperature [K].

Implements filmThermoModel.

Definition at line 233 of file liquidFilmThermo.C.

References liquidPtr_, and p.

◆ rho() [2/2]

tmp< volScalarField > rho ( ) const

virtual

Return density [kg/m3].

Implements filmThermoModel.

Definition at line 239 of file liquidFilmThermo.C.

References Foam::dimDensity, fvPatchFieldBase::extrapolatedCalculatedType(), filmSubModelBase::film(), forAll, GeometricField< scalar, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, p, pRef_, rho(), rho(), IOobject::scopedName(), Foam::T(), thermoFilm(), TRef_, trho, Foam::type(), useReferenceValues_, and Foam::Zero.

Referenced by rho().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mu() [2/2]

tmp< volScalarField > mu ( ) const

virtual

Return dynamic viscosity [Pa.s].

Implements filmThermoModel.

Definition at line 274 of file liquidFilmThermo.C.

References Foam::dimPressure, Foam::dimTime, filmSubModelBase::film(), forAll, mu(), mu(), GeometricField< scalar, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, p, pRef_, IOobject::scopedName(), Foam::T(), thermoFilm(), TRef_, Foam::type(), useReferenceValues_, and Foam::Zero.

Referenced by mu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sigma() [2/2]

tmp< volScalarField > sigma ( ) const

virtual

Return surface tension [kg/s2].

Implements filmThermoModel.

Definition at line 309 of file liquidFilmThermo.C.

References Foam::dimMass, Foam::dimTime, filmSubModelBase::film(), forAll, GeometricField< scalar, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, p, pRef_, IOobject::scopedName(), sigma(), sigma(), Foam::sqr(), Foam::T(), thermoFilm(), TRef_, Foam::type(), useReferenceValues_, and Foam::Zero.

Referenced by sigma().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Cp() [2/2]

tmp< volScalarField > Cp ( ) const

virtual

Return specific heat capacity [J/kg/K].

Implements filmThermoModel.

Definition at line 344 of file liquidFilmThermo.C.

References Cp(), Cp(), Foam::dimEnergy, Foam::dimMass, Foam::dimTemperature, filmSubModelBase::film(), forAll, GeometricField< scalar, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, p, pRef_, IOobject::scopedName(), Foam::T(), tCp, thermoFilm(), TRef_, Foam::type(), useReferenceValues_, and Foam::Zero.

Referenced by Cp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ kappa() [2/2]

tmp< volScalarField > kappa ( ) const

virtual

Return thermal conductivity [W/m/K].

Implements filmThermoModel.

Definition at line 379 of file liquidFilmThermo.C.

References Foam::dimLength, Foam::dimPower, Foam::dimTemperature, filmSubModelBase::film(), forAll, kappa(), kappa(), GeometricField< scalar, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, p, pRef_, IOobject::scopedName(), Foam::T(), thermoFilm(), TRef_, Foam::type(), useReferenceValues_, and Foam::Zero.

Referenced by kappa().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ name_

word name_

protected

Liquid name.

Definition at line 65 of file liquidFilmThermo.H.

Referenced by initLiquid(), liquidFilmThermo(), and name().

◆ liquidPtr_

const liquidProperties* liquidPtr_

protected

Pointer to the liquid properties.

Definition at line 70 of file liquidFilmThermo.H.

Referenced by Cp(), D(), hl(), initLiquid(), kappa(), liquidFilmThermo(), mu(), pv(), rho(), sigma(), Tb(), W(), and ~liquidFilmThermo().

◆ ownLiquid_

bool ownLiquid_

protected

Flag to indicate that model owns the liquid object.

Definition at line 75 of file liquidFilmThermo.H.

Referenced by initLiquid(), liquidFilmThermo(), and ~liquidFilmThermo().

◆ useReferenceValues_

bool useReferenceValues_

protected

Flag to indicate that reference values of p and T should be used.

Definition at line 80 of file liquidFilmThermo.H.

Referenced by Cp(), kappa(), liquidFilmThermo(), mu(), rho(), and sigma().

◆ pRef_

scalar pRef_

protected

Reference pressure [pa].

Definition at line 85 of file liquidFilmThermo.H.

Referenced by Cp(), kappa(), liquidFilmThermo(), mu(), rho(), and sigma().

◆ TRef_

scalar TRef_

protected

Reference temperature [K].

Definition at line 90 of file liquidFilmThermo.H.

Referenced by Cp(), kappa(), liquidFilmThermo(), mu(), rho(), and sigma().

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

src/regionModels/surfaceFilmModels/submodels/kinematic/filmThermoModel/liquidFilmThermo/liquidFilmThermo.H
src/regionModels/surfaceFilmModels/submodels/kinematic/filmThermoModel/liquidFilmThermo/liquidFilmThermo.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ liquidFilmThermo() [1/2]

◆ liquidFilmThermo() [2/2]

◆ ~liquidFilmThermo()

Member Function Documentation

◆ thermoFilm()

◆ initLiquid()

◆ operator=()

◆ TypeName()

◆ name()

◆ rho() [1/2]

◆ mu() [1/2]

◆ sigma() [1/2]

◆ Cp() [1/2]

◆ kappa() [1/2]

◆ D()

◆ hl()

◆ pv()

◆ W()

◆ Tb()

◆ rho() [2/2]

◆ mu() [2/2]

◆ sigma() [2/2]

◆ Cp() [2/2]

◆ kappa() [2/2]

Member Data Documentation

◆ name_

◆ liquidPtr_

◆ ownLiquid_

◆ useReferenceValues_

◆ pRef_

◆ TRef_