Liquid thermo model. More...

Inheritance diagram for liquidFilmThermo:

Collaboration diagram for liquidFilmThermo:

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

	liquidFilmThermo (surfaceFilmRegionModel &film, const dictionary &dict)
	Construct from surface film model and dictionary. More...

virtual	~liquidFilmThermo ()
	Destructor. More...

virtual const word &	name () const
	Return the specie name. More...

virtual scalar	rho (const scalar p, const scalar T) const
	Return density [kg/m3]. More...

virtual scalar	mu (const scalar p, const scalar T) const
	Return dynamic viscosity [Pa.s]. More...

virtual scalar	sigma (const scalar p, const scalar T) const
	Return surface tension [kg/s2]. More...

virtual scalar	Cp (const scalar p, const scalar T) const
	Return specific heat capacity [J/kg/K]. More...

virtual scalar	kappa (const scalar p, const scalar T) const
	Return thermal conductivity [W/m/K]. More...

virtual scalar	D (const scalar p, const scalar T) const
	Return diffusivity [m2/s]. More...

virtual scalar	hl (const scalar p, const scalar T) const
	Return latent heat [J/kg]. More...

virtual scalar	pv (const scalar p, const scalar T) const
	Return vapour pressure [Pa]. More...

virtual scalar	W () const
	Return molecular weight [kg/kmol]. More...

virtual scalar	Tb (const scalar p) const
	Return boiling temperature [K]. More...

virtual tmp< volScalarField >	rho () const
	Return density [kg/m3]. More...

virtual tmp< volScalarField >	mu () const
	Return dynamic viscosity [Pa.s]. More...

virtual tmp< volScalarField >	sigma () const
	Return surface tension [kg/s2]. More...

virtual tmp< volScalarField >	Cp () const
	Return specific heat capacity [J/kg/K]. More...

virtual tmp< volScalarField >	kappa () const
	Return thermal conductivity [W/m/K]. More...

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

	declareRunTimeSelectionTable (autoPtr, filmThermoModel, dictionary,(surfaceFilmRegionModel &film, const dictionary &dict),(film, dict))

	filmThermoModel (surfaceFilmRegionModel &film)
	Construct null. More...

	filmThermoModel (const word &modelType, surfaceFilmRegionModel &film, const dictionary &dict)
	Construct from type name, dictionary and surface film model. More...

virtual	~filmThermoModel ()
	Destructor. More...

virtual const word &	name () const =0
	Return the specie name. More...

virtual scalar	rho (const scalar p, const scalar T) const =0
	Return density [kg/m3]. More...

virtual scalar	mu (const scalar p, const scalar T) const =0
	Return dynamic viscosity [Pa.s]. More...

virtual scalar	sigma (const scalar p, const scalar T) const =0
	Return surface tension [kg/s2]. More...

virtual scalar	Cp (const scalar p, const scalar T) const =0
	Return specific heat capacity [J/kg/K]. More...

virtual scalar	kappa (const scalar p, const scalar T) const =0
	Return thermal conductivity [W/m/K]. More...

virtual scalar	D (const scalar p, const scalar T) const =0
	Return diffusivity [m2/s]. More...

virtual scalar	hl (const scalar p, const scalar T) const =0
	Return latent heat [J/kg]. More...

virtual scalar	pv (const scalar p, const scalar T) const =0
	Return vapour pressure [Pa]. More...

virtual scalar	W () const =0
	Return molecular weight [kg/kmol]. More...

virtual scalar	Tb (const scalar p) const =0
	Return boiling temperature [K]. More...

virtual tmp< volScalarField >	rho () const =0
	Return density [kg/m3]. More...

virtual tmp< volScalarField >	mu () const =0
	Return dynamic viscosity [Pa.s]. More...

virtual tmp< volScalarField >	sigma () const =0
	Return surface tension [kg/s2]. More...

virtual tmp< volScalarField >	Cp () const =0
	Return specific heat capacity [J/kg/K]. More...

virtual tmp< volScalarField >	kappa () const =0
	Return thermal conductivity [W/m/K]. More...

Public Member Functions inherited from filmSubModelBase
	filmSubModelBase (surfaceFilmRegionModel &film)
	Construct null. More...

	filmSubModelBase (surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from film film without name. More...

	filmSubModelBase (const word &modelName, surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from film film with name. More...

virtual	~filmSubModelBase ()
	Destructor. More...

virtual bool	writeTime () const
	Flag to indicate when to write a property. More...

const surfaceFilmRegionModel &	film () const
	Return const access to the film surface film model. More...

surfaceFilmRegionModel &	film ()
	Return the reference to the film surface film model. More...

template<class FilmType >
const FilmType &	filmType () const

Public Member Functions inherited from subModelBase
	subModelBase (dictionary &properties)
	Construct null. More...

	subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from components without name. More...

	subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from components with name. More...

	subModelBase (const subModelBase &smb)
	Construct as copy. More...

virtual	~subModelBase ()
	Destructor. More...

const word &	modelName () const
	Return const access to the name of the sub-model. More...

const dictionary &	dict () const
	Return const access to the cloud dictionary. More...

const word &	baseName () const
	Return const access to the base name of the sub-model. More...

const word &	modelType () const
	Return const access to the sub-model type. More...

const dictionary &	coeffDict () const
	Return const access to the coefficients dictionary. More...

const dictionary &	properties () const
	Return const access to the properties dictionary. More...

virtual bool	defaultCoeffs (const bool printMsg) const
	Returns true if defaultCoeffs is true and outputs on printMsg. More...

virtual bool	active () const
	Return the model 'active' status - default active = true. More...

virtual void	cacheFields (const bool store)
	Cache dependent sub-model fields. More...

virtual bool	writeTime () const
	Flag to indicate when to write a property. More...

virtual fileName	localPath () const
	Output directory. More...

template<class Type >
Type	getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the base model. More...

template<class Type >
void	getBaseProperty (const word &entryName, Type &value) const
	Retrieve generic property from the base model. More...

template<class Type >
void	setBaseProperty (const word &entryName, const Type &value)
	Add generic property to the base model. More...

bool	getModelDict (const word &entryName, dictionary &dict) const
	Retrieve dictionary, return true if set. More...

template<class Type >
bool	getModelProperty (const word &entryName, Type &value) const
	Retrieve generic property from the sub-model. More...

template<class Type >
Type	getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the sub-model. More...

template<class Type >
void	setModelProperty (const word &entryName, const Type &value)
	Add generic property to the sub-model. More...

virtual void	write (Ostream &os) const
	Write. More...

Protected Member Functions
const thermoSingleLayer &	thermoFilm () const
	Return a reference to a thermo film. More...

void	initLiquid (const dictionary &dict)
	Initialise the liquid pointer. More...

	liquidFilmThermo (const liquidFilmThermo &)=delete
	No copy construct. More...

void	operator= (const liquidFilmThermo &)=delete
	No copy assignment. More...

Protected Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line. More...

Protected Attributes
word	name_
	Liquid name. More...

const liquidProperties *	liquidPtr_
	Pointer to the liquid properties. More...

bool	ownLiquid_
	Flag to indicate that model owns the liquid object. More...

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

scalar	pRef_
	Reference pressure [pa]. More...

scalar	TRef_
	Reference temperature [K]. More...

Protected Attributes inherited from filmSubModelBase
surfaceFilmRegionModel &	filmModel_
	Reference to the film surface film model. More...

Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model. More...

dictionary &	properties_
	Reference to properties dictionary e.g. for restart. More...

const dictionary	dict_
	Copy of dictionary used during construction. More...

const word	baseName_
	Name of the sub-model base class. More...

const word	modelType_
	Type of the sub-model. More...

const dictionary	coeffDict_
	Coefficients dictionary. More...

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

Detailed Description

Liquid thermo model.

Source files

Definition at line 58 of file liquidFilmThermo.H.

Constructor & Destructor Documentation

◆ liquidFilmThermo() [1/2]

liquidFilmThermo ( const liquidFilmThermo & )

protecteddelete

No copy construct.

◆ liquidFilmThermo() [2/2]

liquidFilmThermo	(	surfaceFilmRegionModel &	film,
		const dictionary &	dict
	)

Construct from surface film model and dictionary.

Definition at line 110 of file liquidFilmThermo.C.

References subModelBase::coeffDict_, liquidFilmThermo::initLiquid(), liquidFilmThermo::pRef_, dictionary::readEntry(), liquidFilmThermo::TRef_, and liquidFilmThermo::useReferenceValues_.

Here is the call graph for this function:

◆ ~liquidFilmThermo()

~liquidFilmThermo ( )

virtual

Destructor.

Definition at line 136 of file liquidFilmThermo.C.

References Foam::deleteDemandDrivenData(), liquidFilmThermo::liquidPtr_, and liquidFilmThermo::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 58 of file liquidFilmThermo.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, filmSubModelBase::filmModel_, and ensightPTraits< Type >::typeName.

Referenced by liquidFilmThermo::Cp(), liquidFilmThermo::kappa(), liquidFilmThermo::mu(), liquidFilmThermo::rho(), and liquidFilmThermo::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 74 of file liquidFilmThermo.C.

References subModelBase::dict(), filmSubModelBase::filmModel_, objectRegistry::findObject(), liquidFilmThermo::liquidPtr_, liquidFilmThermo::name_, Time::New(), dictionary::optionalSubDict(), liquidFilmThermo::ownLiquid_, regionModel::primaryMesh(), and dictionary::readEntry().

Referenced by liquidFilmThermo::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.

◆ TypeName()

TypeName ( "liquid" )

Runtime type information.

◆ name()

const word & name ( ) const

virtual

Return the specie name.

Implements filmThermoModel.

Definition at line 147 of file liquidFilmThermo.C.

References liquidFilmThermo::name_.

◆ rho() [1/2]

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

virtual

Return density [kg/m3].

Implements filmThermoModel.

Definition at line 153 of file liquidFilmThermo.C.

References liquidFilmThermo::liquidPtr_, p, thermophysicalProperties::rho(), and T.

Here is the call 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 163 of file liquidFilmThermo.C.

References liquidFilmThermo::liquidPtr_, liquidProperties::mu(), p, and T.

Here is the call 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 173 of file liquidFilmThermo.C.

References liquidFilmThermo::liquidPtr_, p, liquidProperties::sigma(), and T.

Here is the call 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 183 of file liquidFilmThermo.C.

References thermophysicalProperties::Cp(), liquidFilmThermo::liquidPtr_, p, and T.

Here is the call 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 193 of file liquidFilmThermo.C.

References liquidProperties::kappa(), liquidFilmThermo::liquidPtr_, p, and T.

Here is the call graph for this function:

◆ D()

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

virtual

Return diffusivity [m2/s].

Implements filmThermoModel.

Definition at line 203 of file liquidFilmThermo.C.

References liquidProperties::D(), liquidFilmThermo::liquidPtr_, p, and 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 213 of file liquidFilmThermo.C.

References liquidProperties::hl(), liquidFilmThermo::liquidPtr_, p, and 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 223 of file liquidFilmThermo.C.

References liquidFilmThermo::liquidPtr_, p, liquidProperties::pv(), and T.

Here is the call graph for this function:

◆ W()

scalar W ( ) const

virtual

Return molecular weight [kg/kmol].

Implements filmThermoModel.

Definition at line 233 of file liquidFilmThermo.C.

References liquidFilmThermo::liquidPtr_, and thermophysicalProperties::W().

Here is the call graph for this function:

◆ Tb()

scalar Tb ( const scalar p ) const

virtual

Return boiling temperature [K].

Implements filmThermoModel.

Definition at line 239 of file liquidFilmThermo.C.

References liquidFilmThermo::liquidPtr_, p, and liquidProperties::pvInvert().

Here is the call graph for this function:

◆ rho() [2/2]

tmp< volScalarField > rho ( ) const

virtual

Return density [kg/m3].

Implements filmThermoModel.

Definition at line 245 of file liquidFilmThermo.C.

References Foam::dimDensity, filmSubModelBase::film(), forAll, IOobject::NO_READ, IOobject::NO_WRITE, p, liquidFilmThermo::pRef_, liquidFilmThermo::rho(), T, surfaceFilmRegionModel::T(), liquidFilmThermo::thermoFilm(), timeName, liquidFilmThermo::TRef_, trho, Foam::type(), liquidFilmThermo::useReferenceValues_, and Foam::Zero.

Referenced by liquidFilmThermo::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 290 of file liquidFilmThermo.C.

References Foam::dimPressure, Foam::dimTime, filmSubModelBase::film(), forAll, liquidFilmThermo::mu(), IOobject::NO_READ, IOobject::NO_WRITE, p, liquidFilmThermo::pRef_, tmp< T >::ref(), T, surfaceFilmRegionModel::T(), liquidFilmThermo::thermoFilm(), timeName, liquidFilmThermo::TRef_, Foam::type(), liquidFilmThermo::useReferenceValues_, and Foam::Zero.

Referenced by liquidFilmThermo::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 335 of file liquidFilmThermo.C.

References Foam::dimMass, Foam::dimTime, filmSubModelBase::film(), forAll, IOobject::NO_READ, IOobject::NO_WRITE, p, liquidFilmThermo::pRef_, tmp< T >::ref(), liquidFilmThermo::sigma(), Foam::sqr(), T, surfaceFilmRegionModel::T(), liquidFilmThermo::thermoFilm(), timeName, liquidFilmThermo::TRef_, Foam::type(), liquidFilmThermo::useReferenceValues_, and Foam::Zero.

Referenced by liquidFilmThermo::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 380 of file liquidFilmThermo.C.

References liquidFilmThermo::Cp(), Foam::dimEnergy, Foam::dimMass, Foam::dimTemperature, filmSubModelBase::film(), forAll, IOobject::NO_READ, IOobject::NO_WRITE, p, liquidFilmThermo::pRef_, T, surfaceFilmRegionModel::T(), tCp, liquidFilmThermo::thermoFilm(), timeName, liquidFilmThermo::TRef_, Foam::type(), liquidFilmThermo::useReferenceValues_, and Foam::Zero.

Referenced by liquidFilmThermo::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 425 of file liquidFilmThermo.C.

References Foam::dimLength, Foam::dimPower, Foam::dimTemperature, filmSubModelBase::film(), forAll, liquidFilmThermo::kappa(), IOobject::NO_READ, IOobject::NO_WRITE, p, liquidFilmThermo::pRef_, tmp< T >::ref(), T, surfaceFilmRegionModel::T(), liquidFilmThermo::thermoFilm(), timeName, liquidFilmThermo::TRef_, Foam::type(), liquidFilmThermo::useReferenceValues_, and Foam::Zero.

Referenced by liquidFilmThermo::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 67 of file liquidFilmThermo.H.

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

◆ liquidPtr_

const liquidProperties* liquidPtr_

protected

Pointer to the liquid properties.

Definition at line 70 of file liquidFilmThermo.H.

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

◆ ownLiquid_

bool ownLiquid_

protected

Flag to indicate that model owns the liquid object.

Definition at line 73 of file liquidFilmThermo.H.

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

◆ useReferenceValues_

bool useReferenceValues_

protected

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

Definition at line 76 of file liquidFilmThermo.H.

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

◆ pRef_

scalar pRef_

protected

Reference pressure [pa].

Definition at line 79 of file liquidFilmThermo.H.

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

◆ TRef_

scalar TRef_

protected

Reference temperature [K].

Definition at line 82 of file liquidFilmThermo.H.

Referenced by liquidFilmThermo::Cp(), liquidFilmThermo::kappa(), liquidFilmThermo::liquidFilmThermo(), liquidFilmThermo::mu(), liquidFilmThermo::rho(), and liquidFilmThermo::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_