Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
liquidFilmThermo Class Reference
Inheritance diagram for liquidFilmThermo:
Inheritance graph
[legend]
Collaboration diagram for liquidFilmThermo:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("liquid")
 Runtime type information. More...
 
 liquidFilmThermo (surfaceFilmModel &owner, const dictionary &dict)
 Construct from surface film model and dictionary. More...
 
virtual ~liquidFilmThermo ()
 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,( 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 surfaceFilmModelowner () const
 Return const access to the owner surface film model. More...
 
surfaceFilmModelowner ()
 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 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 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...
 

Protected Member Functions

const thermoSingleLayerthermoFilm () const
 Return a reference to a thermo film. More...
 
void initLiquid (const dictionary &dict)
 Initialise the liquid pointer. More...
 
 liquidFilmThermo (const liquidFilmThermo &)
 Disallow default bitwise copy construct. More...
 
void operator= (const liquidFilmThermo &)
 Disallow default bitwise 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 liquidPropertiesliquidPtr_
 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
surfaceFilmModelowner_
 Reference to the owner 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from filmThermoModel
static autoPtr< filmThermoModelNew (surfaceFilmModel &owner, const dictionary &dict)
 Return a reference to the selected phase change model. More...
 

Detailed Description

Definition at line 56 of file liquidFilmThermo.H.

Constructor & Destructor Documentation

liquidFilmThermo ( const liquidFilmThermo )
protected

Disallow default bitwise copy construct.

Referenced by liquidFilmThermo::initLiquid().

Here is the caller graph for this function:

liquidFilmThermo ( surfaceFilmModel owner,
const dictionary dict 
)

Construct from surface film model and dictionary.

Definition at line 106 of file liquidFilmThermo.C.

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

Here is the call graph for this function:

~liquidFilmThermo ( )
virtual

Destructor.

Definition at line 131 of file liquidFilmThermo.C.

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

Here is the call graph for this function:

Member Function Documentation

const thermoSingleLayer & thermoFilm ( ) const
protected

Return a reference to a thermo film.

Definition at line 55 of file liquidFilmThermo.C.

References Foam::exit(), Foam::FatalError, FatalErrorIn, and filmSubModelBase::owner_.

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:

void initLiquid ( const dictionary dict)
protected
void operator= ( const liquidFilmThermo )
protected

Disallow default bitwise assignment.

TypeName ( "liquid"  )

Runtime type information.

const word & name ( ) const
virtual

Return the specie name.

Implements filmThermoModel.

Definition at line 142 of file liquidFilmThermo.C.

References liquidFilmThermo::name_, and liquidFilmThermo::rho().

Here is the call graph for this function:

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

Return density [kg/m3].

Implements filmThermoModel.

Definition at line 149 of file liquidFilmThermo.C.

References liquidFilmThermo::liquidPtr_, liquidFilmThermo::mu(), and liquidProperties::rho().

Here is the call graph for this function:

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

Return dynamic viscosity [Pa.s].

Implements filmThermoModel.

Definition at line 159 of file liquidFilmThermo.C.

References liquidFilmThermo::liquidPtr_, liquidProperties::mu(), and liquidFilmThermo::sigma().

Here is the call graph for this function:

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

Return surface tension [kg/s2].

Implements filmThermoModel.

Definition at line 169 of file liquidFilmThermo.C.

References liquidFilmThermo::Cp(), liquidFilmThermo::liquidPtr_, and liquidProperties::sigma().

Here is the call graph for this function:

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

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

Implements filmThermoModel.

Definition at line 179 of file liquidFilmThermo.C.

References liquidProperties::Cp(), liquidFilmThermo::kappa(), and liquidFilmThermo::liquidPtr_.

Here is the call graph for this function:

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

Return thermal conductivity [W/m/K].

Implements filmThermoModel.

Definition at line 189 of file liquidFilmThermo.C.

References liquidFilmThermo::D(), liquidProperties::K(), and liquidFilmThermo::liquidPtr_.

Here is the call graph for this function:

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

Return diffusivity [m2/s].

Implements filmThermoModel.

Definition at line 199 of file liquidFilmThermo.C.

References liquidProperties::D(), liquidFilmThermo::hl(), and liquidFilmThermo::liquidPtr_.

Referenced by liquidFilmThermo::kappa().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Return latent heat [J/kg].

Implements filmThermoModel.

Definition at line 209 of file liquidFilmThermo.C.

References liquidProperties::hl(), liquidFilmThermo::liquidPtr_, and liquidFilmThermo::pv().

Referenced by liquidFilmThermo::D().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Return vapour pressure [Pa].

Implements filmThermoModel.

Definition at line 219 of file liquidFilmThermo.C.

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

Referenced by liquidFilmThermo::hl().

Here is the call graph for this function:

Here is the caller graph for this function:

scalar W ( ) const
virtual

Return molecular weight [kg/kmol].

Implements filmThermoModel.

Definition at line 228 of file liquidFilmThermo.C.

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

Here is the call graph for this function:

scalar Tb ( const scalar  p) const
virtual

Return boiling temperature [K].

Implements filmThermoModel.

Definition at line 234 of file liquidFilmThermo.C.

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

Here is the call graph for this function:

tmp< volScalarField > rho ( ) const
virtual
tmp< volScalarField > mu ( ) const
virtual
tmp< volScalarField > sigma ( ) const
virtual
tmp< volScalarField > Cp ( ) const
virtual
tmp< volScalarField > kappa ( ) const
virtual

Member Data Documentation

word name_
protected

Liquid name.

Definition at line 65 of file liquidFilmThermo.H.

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

const liquidProperties* liquidPtr_
protected
bool ownLiquid_
protected

Flag to indicate that model owns the liquid object.

Definition at line 71 of file liquidFilmThermo.H.

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

bool useReferenceValues_
protected

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

Definition at line 74 of file liquidFilmThermo.H.

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

scalar pRef_
protected
scalar TRef_
protected

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