Inheritance diagram for constantFilmThermo:

Collaboration diagram for constantFilmThermo:

[legend]

Data Structures
struct	thermoData

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

	constantFilmThermo (surfaceFilmModel &owner, 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,(surfaceFilmModel &owner, const dictionary &dict),(owner, dict))

	filmThermoModel (surfaceFilmModel &owner)
	Construct null. More...

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

virtual	~filmThermoModel ()
	Destructor. More...

Public Member Functions inherited from filmSubModelBase
	filmSubModelBase (surfaceFilmModel &owner)
	Construct null. More...

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

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

virtual	~filmSubModelBase ()
	Destructor. More...

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

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

surfaceFilmModel &	owner ()
	Return the reference to the owner 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 dependant sub-model fields. More...

template<class Type >
Type	getBaseProperty (const word &entryName, const Type &defaultValue=pTraits< 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...

template<class Type >
void	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=pTraits< 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...

Private Member Functions
void	init (thermoData &td)
	Initialise thermoData object. More...

	constantFilmThermo (const constantFilmThermo &)
	Disallow default bitwise copy construct. More...

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

Private Attributes
word	name_
	Specie name. More...

thermoData	rho0_
	Density [kg/m3]. More...

thermoData	mu0_
	Dynamic viscosity [Pa.s]. More...

thermoData	sigma0_
	Surface tension [kg/s2]. More...

thermoData	Cp0_
	Specific heat capacity [J/kg/K]. More...

thermoData	kappa0_
	Thermal conductivity [W/m/K]. More...

thermoData	D0_
	Diffusivity [m2/s]. More...

thermoData	hl0_
	Latent heat [J/kg]. More...

thermoData	pv0_
	Vapour pressure [Pa]. More...

thermoData	W0_
	Molecular weight [kg/kmol]. More...

thermoData	Tb0_
	Boiling temperature [K]. More...

Additional Inherited Members
Static Public Member Functions inherited from filmThermoModel
static autoPtr< filmThermoModel >	New (surfaceFilmModel &owner, 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
surfaceFilmModel &	owner_
	Reference to the owner 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

Definition at line 53 of file constantFilmThermo.H.

Constructor & Destructor Documentation

◆ constantFilmThermo() [1/2]

constantFilmThermo ( const constantFilmThermo & )

private

Disallow default bitwise copy construct.

◆ constantFilmThermo() [2/2]

constantFilmThermo	(	surfaceFilmModel &	owner,
		const dictionary &	dict
	)

Construct from surface film model and dictionary.

Definition at line 62 of file constantFilmThermo.C.

◆ ~constantFilmThermo()

~constantFilmThermo ( )

virtual

Destructor.

Definition at line 93 of file constantFilmThermo.C.

Member Function Documentation

◆ init()

void init ( thermoData & td )

private

Initialise thermoData object.

Definition at line 50 of file constantFilmThermo.C.

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

Here is the call graph for this function:

◆ operator=()

void operator= ( const constantFilmThermo & )

private

Disallow default bitwise assignment.

◆ TypeName()

TypeName ( "constant" )

Runtime type information.

◆ name()

const word & name ( ) const

virtual

Return the specie name.

Implements filmThermoModel.

Definition at line 99 of file constantFilmThermo.C.

References constantFilmThermo::name_.

◆ rho() [1/2]

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

virtual

Return density [kg/m3].

Implements filmThermoModel.

Definition at line 106 of file constantFilmThermo.C.

◆ mu() [1/2]

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

virtual

Return dynamic viscosity [Pa.s].

Implements filmThermoModel.

Definition at line 122 of file constantFilmThermo.C.

◆ sigma() [1/2]

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

virtual

Return surface tension [kg/s2].

Implements filmThermoModel.

Definition at line 138 of file constantFilmThermo.C.

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

◆ kappa() [1/2]

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

virtual

Return thermal conductivity [W/m/K].

Implements filmThermoModel.

Definition at line 170 of file constantFilmThermo.C.

◆ D()

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

virtual

Return diffusivity [m2/s].

Implements filmThermoModel.

Definition at line 186 of file constantFilmThermo.C.

◆ hl()

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

virtual

Return latent heat [J/kg].

Implements filmThermoModel.

Definition at line 202 of file constantFilmThermo.C.

◆ pv()

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

virtual

Return vapour pressure [Pa].

Implements filmThermoModel.

Definition at line 218 of file constantFilmThermo.C.

◆ W()

scalar W ( ) const

virtual

Return molecular weight [kg/kmol].

Implements filmThermoModel.

Definition at line 233 of file constantFilmThermo.C.

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

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

References subModelBase::coeffDict_, dictionary::lookup(), constantFilmThermo::thermoData::name_, constantFilmThermo::thermoData::set_, constantFilmThermo::Tb0_, 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 257 of file constantFilmThermo.C.

References Foam::dimDensity, constantFilmThermo::thermoData::name_, IOobject::NO_READ, IOobject::NO_WRITE, filmSubModelBase::owner(), constantFilmThermo::rho0_, timeName, trho, and Foam::type().

Here is the call graph for this function:

◆ mu() [2/2]

tmp< volScalarField > mu ( ) const

virtual

Return dynamic viscosity [Pa.s].

Implements filmThermoModel.

Definition at line 284 of file constantFilmThermo.C.

References Foam::dimPressure, Foam::dimTime, constantFilmThermo::mu0_, constantFilmThermo::thermoData::name_, IOobject::NO_READ, IOobject::NO_WRITE, filmSubModelBase::owner(), timeName, and Foam::type().

Here is the call graph for this function:

◆ sigma() [2/2]

tmp< volScalarField > sigma ( ) const

virtual

Return surface tension [kg/s2].

Implements filmThermoModel.

Definition at line 311 of file constantFilmThermo.C.

References Foam::dimMass, Foam::dimTime, constantFilmThermo::thermoData::name_, IOobject::NO_READ, IOobject::NO_WRITE, filmSubModelBase::owner(), constantFilmThermo::sigma0_, Foam::sqr(), timeName, and Foam::type().

Here is the call graph for this function:

◆ Cp() [2/2]

tmp< volScalarField > Cp ( ) const

virtual

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

Implements filmThermoModel.

Definition at line 338 of file constantFilmThermo.C.

References constantFilmThermo::Cp0_, Foam::dimEnergy, Foam::dimMass, Foam::dimTemperature, constantFilmThermo::thermoData::name_, IOobject::NO_READ, IOobject::NO_WRITE, filmSubModelBase::owner(), timeName, and Foam::type().

Here is the call graph for this function:

◆ kappa() [2/2]

tmp< volScalarField > kappa ( ) const

virtual

Return thermal conductivity [W/m/K].

Implements filmThermoModel.

Definition at line 365 of file constantFilmThermo.C.

References Foam::dimLength, Foam::dimPower, Foam::dimTemperature, constantFilmThermo::kappa0_, constantFilmThermo::thermoData::name_, IOobject::NO_READ, IOobject::NO_WRITE, filmSubModelBase::owner(), timeName, and Foam::type().

Here is the call graph for this function:

Field Documentation

◆ name_

word name_

private

Specie name.

Definition at line 90 of file constantFilmThermo.H.

Referenced by constantFilmThermo::name().

◆ rho0_

thermoData rho0_

mutableprivate

Density [kg/m3].

Definition at line 93 of file constantFilmThermo.H.

Referenced by constantFilmThermo::rho().

◆ mu0_

thermoData mu0_

mutableprivate

Dynamic viscosity [Pa.s].

Definition at line 96 of file constantFilmThermo.H.

Referenced by constantFilmThermo::mu().

◆ sigma0_

thermoData sigma0_

mutableprivate

Surface tension [kg/s2].

Definition at line 99 of file constantFilmThermo.H.

Referenced by constantFilmThermo::sigma().

◆ Cp0_

thermoData Cp0_

mutableprivate

Specific heat capacity [J/kg/K].

Definition at line 102 of file constantFilmThermo.H.

Referenced by constantFilmThermo::Cp().

◆ kappa0_

thermoData kappa0_

mutableprivate

Thermal conductivity [W/m/K].

Definition at line 105 of file constantFilmThermo.H.

Referenced by constantFilmThermo::kappa().

◆ D0_

thermoData D0_

mutableprivate

Diffusivity [m2/s].

Definition at line 108 of file constantFilmThermo.H.

◆ hl0_

thermoData hl0_

mutableprivate

Latent heat [J/kg].

Definition at line 111 of file constantFilmThermo.H.

◆ pv0_

thermoData pv0_

mutableprivate

Vapour pressure [Pa].

Definition at line 114 of file constantFilmThermo.H.

◆ W0_

thermoData W0_

mutableprivate

Molecular weight [kg/kmol].

Definition at line 117 of file constantFilmThermo.H.

Referenced by constantFilmThermo::W().

◆ Tb0_

thermoData Tb0_

mutableprivate

Boiling temperature [K].

Definition at line 120 of file constantFilmThermo.H.

Referenced by constantFilmThermo::Tb().

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

Data Structures

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ constantFilmThermo() [1/2]

◆ constantFilmThermo() [2/2]

◆ ~constantFilmThermo()

Member Function Documentation

◆ init()

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

Field Documentation

◆ name_

◆ rho0_

◆ mu0_

◆ sigma0_

◆ Cp0_

◆ kappa0_

◆ D0_

◆ hl0_

◆ pv0_

◆ W0_

◆ Tb0_