Public Member Functions | Protected Attributes | List of all members
filmSubModelBase Class Reference

Base class for surface film sub-models. More...

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

Public Member Functions

 filmSubModelBase (surfaceFilmRegionModel &film)
 
 filmSubModelBase (surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 
 filmSubModelBase (const word &modelName, surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType)
 
virtual ~filmSubModelBase ()
 
virtual bool writeTime () const
 
const surfaceFilmRegionModel & film () const
 
surfaceFilmRegionModel & film ()
 
template<class FilmType >
const FilmType & filmType () const
 
- Public Member Functions inherited from subModelBase
 subModelBase (dictionary &properties)
 
 subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 
 subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
 
 subModelBase (const subModelBase &smb)
 
virtual ~subModelBase ()
 
const word & modelName () const
 
const dictionary & dict () const
 
const word & baseName () const
 
const word & modelType () const
 
const dictionary & coeffDict () const
 
const dictionary & properties () const
 
virtual bool defaultCoeffs (const bool printMsg) const
 
virtual bool active () const
 
virtual void cacheFields (const bool store)
 
virtual fileName localPath () const
 
template<class Type >
Type getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
void getBaseProperty (const word &entryName, Type &value) const
 
template<class Type >
void setBaseProperty (const word &entryName, const Type &value)
 
bool getModelDict (const word &entryName, dictionary &dict) const
 
template<class Type >
void getModelProperty (const word &entryName, Type &value) const
 
template<class Type >
Type getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
void setModelProperty (const word &entryName, const Type &value)
 
virtual void write (Ostream &os) const
 

Protected Attributes

surfaceFilmRegionModel & filmModel_
 
- Protected Attributes inherited from subModelBase
const word modelName_
 
dictionary & properties_
 
const dictionary dict_
 
const word baseName_
 
const word modelType_
 
const dictionary coeffDict_
 

Additional Inherited Members

- Protected Member Functions inherited from subModelBase
bool inLine () const
 

Detailed Description

Base class for surface film sub-models.

Source files

Source files

Definition at line 52 of file filmSubModelBase.H.

Constructor & Destructor Documentation

◆ filmSubModelBase() [1/3]

filmSubModelBase ( surfaceFilmRegionModel &  film)

Definition at line 34 of file filmSubModelBase.C.

◆ filmSubModelBase() [2/3]

filmSubModelBase ( surfaceFilmRegionModel &  film,
const dictionary &  dict,
const word &  baseName,
const word &  modelType,
const word &  dictExt = "Coeffs" 
)

Definition at line 42 of file filmSubModelBase.C.

◆ filmSubModelBase() [3/3]

filmSubModelBase ( const word &  modelName,
surfaceFilmRegionModel &  film,
const dictionary &  dict,
const word &  baseName,
const word &  modelType 
)

Definition at line 63 of file filmSubModelBase.C.

◆ ~filmSubModelBase()

~filmSubModelBase ( )
virtual

Definition at line 85 of file filmSubModelBase.C.

Member Function Documentation

◆ writeTime()

bool writeTime ( ) const
virtual

Reimplemented from subModelBase.

Definition at line 91 of file filmSubModelBase.C.

References subModelBase::active(), filmSubModelBase::filmModel_, regionModel::time(), and TimeState::writeTime().

Referenced by injectionModel::correct(), transferModel::correct(), transferModelList::info(), and injectionModelList::info().

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

◆ film() [1/2]

surfaceFilmRegionModel & film ( ) const
inline

Definition at line 32 of file filmSubModelBaseI.H.

References filmSubModelBase::filmModel_.

Referenced by liquidFilmThermo::Cp(), constantFilmThermo::Cp(), injectionModelList::info(), transferModelList::info(), liquidFilmThermo::kappa(), constantFilmThermo::kappa(), liquidFilmThermo::mu(), constantFilmThermo::mu(), liquidFilmThermo::rho(), constantFilmThermo::rho(), noRadiation::Shs(), primaryRadiation::Shs(), standardRadiation::Shs(), constantRadiation::Shs(), liquidFilmThermo::sigma(), constantFilmThermo::sigma(), and laminar::Su().

Here is the caller graph for this function:

◆ film() [2/2]

surfaceFilmRegionModel& film ( )
inline

◆ filmType()

const FilmType & filmType
inline

Definition at line 31 of file filmSubModelBaseTemplates.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, filmSubModelBase::filmModel_, and subModelBase::modelType().

Here is the call graph for this function:

Member Data Documentation

◆ filmModel_

surfaceFilmRegionModel& filmModel_
protected

Definition at line 61 of file filmSubModelBase.H.

Referenced by thermocapillaryForce::correct(), contactAngleForce::correct(), filmSubModelBase::film(), filmSubModelBase::filmType(), constantHeatTransfer::h(), phaseChangeModel::info(), liquidFilmThermo::initLiquid(), laminar::mut(), primaryRadiation::Shs(), standardRadiation::Shs(), constantRadiation::Shs(), laminar::Su(), liquidFilmThermo::thermoFilm(), temperatureDependentContactAngleForce::theta(), distributionContactAngleForce::theta(), perturbedTemperatureDependentContactAngleForce::theta(), laminar::Us(), and filmSubModelBase::writeTime().

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17