Classes | Public Member Functions | List of all members
constantFilmThermo Class Reference

Constant thermo model. More...

Inheritance diagram for constantFilmThermo:
Inheritance graph
[legend]
Collaboration diagram for constantFilmThermo:
Collaboration graph
[legend]

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 wordname () 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< volScalarFieldrho () const
 Return density [kg/m3]. More...
 
virtual tmp< volScalarFieldmu () const
 Return dynamic viscosity [Pa.s]. More...
 
virtual tmp< volScalarFieldsigma () const
 Return surface tension [kg/s2]. More...
 
virtual tmp< volScalarFieldCp () const
 Return specific heat capacity [J/kg/K]. More...
 
virtual tmp< volScalarFieldkappa () 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...
 
- 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 surfaceFilmRegionModelfilm () const
 Return const access to the film surface film model. More...
 
surfaceFilmRegionModelfilm ()
 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 wordmodelName () const
 Return const access to the name of the sub-model. More...
 
const dictionarydict () const
 Return const access to the cloud dictionary. More...
 
const wordbaseName () const
 Return const access to the base name of the sub-model. More...
 
const wordmodelType () const
 Return const access to the sub-model type. More...
 
const dictionarycoeffDict () const
 Return const access to the coefficients dictionary. More...
 
const dictionaryproperties () 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...
 
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...
 

Additional Inherited Members

- Static Public Member Functions inherited from filmThermoModel
static autoPtr< filmThermoModelNew (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
surfaceFilmRegionModelfilmModel_
 Reference to the film surface film model. More...
 
- Protected Attributes inherited from subModelBase
const word modelName_
 Name of the sub-model. More...
 
dictionaryproperties_
 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 53 of file constantFilmThermo.H.

Constructor & Destructor Documentation

◆ constantFilmThermo()

constantFilmThermo ( surfaceFilmRegionModel film,
const dictionary dict 
)

Construct from surface film model and dictionary.

Definition at line 63 of file constantFilmThermo.C.

◆ ~constantFilmThermo()

~constantFilmThermo ( )
virtual

Destructor.

Definition at line 96 of file constantFilmThermo.C.

Referenced by constantFilmThermo::thermoData::thermoData().

Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "constant"  )

Runtime type information.

Referenced by constantFilmThermo::thermoData::thermoData().

Here is the caller graph for this function:

◆ name()

const word & name ( ) const
virtual

Return the specie name.

Implements filmThermoModel.

Definition at line 102 of file constantFilmThermo.C.

References constantFilmThermo::rho().

Referenced by constantFilmThermo::thermoData::thermoData().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ rho() [1/2]

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

◆ mu() [1/2]

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

◆ sigma() [1/2]

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

Return surface tension [kg/s2].

Implements filmThermoModel.

Definition at line 141 of file constantFilmThermo.C.

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

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

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

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

Referenced by constantFilmThermo::kappa(), and constantFilmThermo::thermoData::thermoData().

Here is the call graph for this function:
Here is the caller 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 205 of file constantFilmThermo.C.

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

Referenced by constantFilmThermo::D(), and constantFilmThermo::thermoData::thermoData().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ pv()

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

Return vapour pressure [Pa].

Implements filmThermoModel.

Definition at line 221 of file constantFilmThermo.C.

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

Referenced by constantFilmThermo::hl(), and constantFilmThermo::thermoData::thermoData().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ W()

scalar W ( ) const
virtual

Return molecular weight [kg/kmol].

Implements filmThermoModel.

Definition at line 236 of file constantFilmThermo.C.

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

Referenced by constantFilmThermo::thermoData::thermoData().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Tb()

scalar Tb ( const scalar  p) const
virtual

Return boiling temperature [K].

Implements filmThermoModel.

Definition at line 248 of file constantFilmThermo.C.

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

Referenced by constantFilmThermo::thermoData::thermoData().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ rho() [2/2]

tmp< volScalarField > rho ( ) const
virtual

Return density [kg/m3].

Implements filmThermoModel.

Definition at line 260 of file constantFilmThermo.C.

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

Referenced by constantFilmThermo::name(), and constantFilmThermo::thermoData::thermoData().

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

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

Referenced by constantFilmThermo::rho(), and constantFilmThermo::thermoData::thermoData().

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

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

Referenced by constantFilmThermo::mu(), and constantFilmThermo::thermoData::thermoData().

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

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

Referenced by constantFilmThermo::sigma(), and constantFilmThermo::thermoData::thermoData().

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

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

Referenced by constantFilmThermo::Cp(), and constantFilmThermo::thermoData::thermoData().

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: