Constant thermo model. More...

Inheritance diagram for constantFilmThermo:

Collaboration diagram for constantFilmThermo:

Classes
struct	thermoData

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

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

virtual	~constantFilmThermo ()
	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...

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

Protected Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line. 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...

Detailed Description

Constant thermo model.

Source files

Definition at line 55 of file constantFilmThermo.H.

Constructor & Destructor Documentation

◆ constantFilmThermo()

constantFilmThermo	(	surfaceFilmRegionModel &	film,
		const dictionary &	dict
	)

Construct from surface film model and dictionary.

Definition at line 64 of file constantFilmThermo.C.

◆ ~constantFilmThermo()

~constantFilmThermo ( )

virtual

Destructor.

Definition at line 98 of file constantFilmThermo.C.

Member Function Documentation

◆ TypeName()

TypeName ( "constant" )

Runtime type information.

◆ name()

const word & name ( ) const

virtual

Return the specie name.

Implements filmThermoModel.

Definition at line 104 of file constantFilmThermo.C.

◆ rho() [1/2]

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

virtual

Return density [kg/m3].

Implements filmThermoModel.

Definition at line 110 of file constantFilmThermo.C.

References subModelBase::coeffDict_, constantFilmThermo::thermoData::name_, dictionary::readEntry(), constantFilmThermo::thermoData::set_, and constantFilmThermo::thermoData::value_.

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 126 of file constantFilmThermo.C.

References subModelBase::coeffDict_, constantFilmThermo::thermoData::name_, dictionary::readEntry(), constantFilmThermo::thermoData::set_, and constantFilmThermo::thermoData::value_.

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 142 of file constantFilmThermo.C.

References subModelBase::coeffDict_, constantFilmThermo::thermoData::name_, dictionary::readEntry(), constantFilmThermo::thermoData::set_, and constantFilmThermo::thermoData::value_.

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 158 of file constantFilmThermo.C.

References subModelBase::coeffDict_, constantFilmThermo::thermoData::name_, dictionary::readEntry(), constantFilmThermo::thermoData::set_, and constantFilmThermo::thermoData::value_.

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 174 of file constantFilmThermo.C.

References subModelBase::coeffDict_, constantFilmThermo::thermoData::name_, dictionary::readEntry(), constantFilmThermo::thermoData::set_, and constantFilmThermo::thermoData::value_.

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 190 of file constantFilmThermo.C.

References subModelBase::coeffDict_, constantFilmThermo::thermoData::name_, dictionary::readEntry(), constantFilmThermo::thermoData::set_, and constantFilmThermo::thermoData::value_.

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 206 of file constantFilmThermo.C.

References subModelBase::coeffDict_, constantFilmThermo::thermoData::name_, dictionary::readEntry(), constantFilmThermo::thermoData::set_, and constantFilmThermo::thermoData::value_.

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 222 of file constantFilmThermo.C.

References subModelBase::coeffDict_, constantFilmThermo::thermoData::name_, dictionary::readEntry(), constantFilmThermo::thermoData::set_, and constantFilmThermo::thermoData::value_.

Here is the call graph for this function:

◆ W()

scalar W ( ) const

virtual

Return molecular weight [kg/kmol].

Implements filmThermoModel.

Definition at line 238 of file constantFilmThermo.C.

References subModelBase::coeffDict_, constantFilmThermo::thermoData::name_, dictionary::readEntry(), constantFilmThermo::thermoData::set_, and constantFilmThermo::thermoData::value_.

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 250 of file constantFilmThermo.C.

References subModelBase::coeffDict_, constantFilmThermo::thermoData::name_, dictionary::readEntry(), constantFilmThermo::thermoData::set_, and constantFilmThermo::thermoData::value_.

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 262 of file constantFilmThermo.C.

References Foam::dimDensity, filmSubModelBase::film(), constantFilmThermo::thermoData::name_, IOobject::NO_READ, IOobject::NO_WRITE, tmp< T >::ref(), constantFilmThermo::rho(), timeName, trho, Foam::type(), and Foam::Zero.

Referenced by constantFilmThermo::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 289 of file constantFilmThermo.C.

References Foam::dimPressure, Foam::dimTime, filmSubModelBase::film(), constantFilmThermo::mu(), constantFilmThermo::thermoData::name_, IOobject::NO_READ, IOobject::NO_WRITE, tmp< T >::ref(), timeName, Foam::type(), and Foam::Zero.

Referenced by constantFilmThermo::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 316 of file constantFilmThermo.C.

References Foam::dimMass, Foam::dimTime, filmSubModelBase::film(), constantFilmThermo::thermoData::name_, IOobject::NO_READ, IOobject::NO_WRITE, tmp< T >::ref(), constantFilmThermo::sigma(), Foam::sqr(), timeName, Foam::type(), and Foam::Zero.

Referenced by constantFilmThermo::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 343 of file constantFilmThermo.C.

References constantFilmThermo::Cp(), Foam::dimEnergy, Foam::dimMass, Foam::dimTemperature, filmSubModelBase::film(), constantFilmThermo::thermoData::name_, IOobject::NO_READ, IOobject::NO_WRITE, tmp< T >::ref(), tCp, timeName, Foam::type(), and Foam::Zero.

Referenced by constantFilmThermo::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 370 of file constantFilmThermo.C.

References Foam::dimLength, Foam::dimPower, Foam::dimTemperature, filmSubModelBase::film(), constantFilmThermo::kappa(), constantFilmThermo::thermoData::name_, IOobject::NO_READ, IOobject::NO_WRITE, tmp< T >::ref(), timeName, Foam::type(), and Foam::Zero.

Referenced by constantFilmThermo::kappa().

Here is the call graph for this function:

Here is the caller graph for this function:

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

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

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ constantFilmThermo()

◆ ~constantFilmThermo()

Member Function Documentation

◆ 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]