Public Member Functions | Static Public Member Functions | List of all members
filmThermoModel Class Referenceabstract
Inheritance diagram for filmThermoModel:
Inheritance graph
[legend]
Collaboration diagram for filmThermoModel:
Collaboration graph
[legend]

Public Member Functions

 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...
 
virtual const wordname () 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< volScalarFieldrho () const =0
 Return density [kg/m3]. More...
 
virtual tmp< volScalarFieldmu () const =0
 Return dynamic viscosity [Pa.s]. More...
 
virtual tmp< volScalarFieldsigma () const =0
 Return surface tension [kg/s2]. More...
 
virtual tmp< volScalarFieldCp () const =0
 Return specific heat capacity [J/kg/K]. More...
 
virtual tmp< volScalarFieldkappa () const =0
 Return thermal conductivity [W/m/K]. 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...
 

Static Public Member Functions

static autoPtr< filmThermoModelNew (surfaceFilmModel &owner, const dictionary &dict)
 Return a reference to the selected phase change model. More...
 

Additional Inherited Members

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

Detailed Description

Definition at line 54 of file filmThermoModel.H.

Constructor & Destructor Documentation

Construct null.

Definition at line 45 of file filmThermoModel.C.

filmThermoModel ( const word modelType,
surfaceFilmModel owner,
const dictionary dict 
)

Construct from type name, dictionary and surface film model.

Definition at line 54 of file filmThermoModel.C.

~filmThermoModel ( )
virtual

Destructor.

Definition at line 66 of file filmThermoModel.C.

Member Function Documentation

TypeName ( "filmThermoModel"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
filmThermoModel  ,
dictionary  ,
( surfaceFilmModel &owner, const dictionary &dict ,
(owner, dict  
)
autoPtr< filmThermoModel > New ( surfaceFilmModel owner,
const dictionary dict 
)
static

Return a reference to the selected phase change model.

Definition at line 40 of file filmThermoModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, dictionary::lookup(), and Foam::nl.

Here is the call graph for this function:

virtual const word& name ( ) const
pure virtual

Return the specie name.

Implemented in constantFilmThermo, and liquidFilmThermo.

Referenced by standardPhaseChange::correctModel().

Here is the caller graph for this function:

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

Return density [kg/m3].

Implemented in constantFilmThermo, and liquidFilmThermo.

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

Return dynamic viscosity [Pa.s].

Implemented in constantFilmThermo, and liquidFilmThermo.

Referenced by liquidViscosity::correct().

Here is the caller graph for this function:

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

Return surface tension [kg/s2].

Implemented in constantFilmThermo, and liquidFilmThermo.

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

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

Implemented in constantFilmThermo, and liquidFilmThermo.

Referenced by standardPhaseChange::correctModel().

Here is the caller graph for this function:

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

Return thermal conductivity [W/m/K].

Implemented in constantFilmThermo, and liquidFilmThermo.

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

Return diffusivity [m2/s].

Implemented in constantFilmThermo, and liquidFilmThermo.

Referenced by standardPhaseChange::correctModel().

Here is the caller graph for this function:

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

Return latent heat [J/kg].

Implemented in constantFilmThermo, and liquidFilmThermo.

Referenced by standardPhaseChange::correctModel().

Here is the caller graph for this function:

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

Return vapour pressure [Pa].

Implemented in constantFilmThermo, and liquidFilmThermo.

Referenced by standardPhaseChange::correctModel().

Here is the caller graph for this function:

virtual scalar W ( ) const
pure virtual

Return molecular weight [kg/kmol].

Implemented in constantFilmThermo, and liquidFilmThermo.

Referenced by standardPhaseChange::correctModel().

Here is the caller graph for this function:

virtual scalar Tb ( const scalar  p) const
pure virtual

Return boiling temperature [K].

Implemented in constantFilmThermo, and liquidFilmThermo.

Referenced by standardPhaseChange::correctModel().

Here is the caller graph for this function:

virtual tmp<volScalarField> rho ( ) const
pure virtual

Return density [kg/m3].

Implemented in constantFilmThermo, and liquidFilmThermo.

virtual tmp<volScalarField> mu ( ) const
pure virtual

Return dynamic viscosity [Pa.s].

Implemented in constantFilmThermo, and liquidFilmThermo.

virtual tmp<volScalarField> sigma ( ) const
pure virtual

Return surface tension [kg/s2].

Implemented in constantFilmThermo, and liquidFilmThermo.

virtual tmp<volScalarField> Cp ( ) const
pure virtual

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

Implemented in constantFilmThermo, and liquidFilmThermo.

virtual tmp<volScalarField> kappa ( ) const
pure virtual

Return thermal conductivity [W/m/K].

Implemented in constantFilmThermo, and liquidFilmThermo.


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