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)
 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 surfaceFilmRegionModel & film () const
 Return const access to the film surface film model. More...
 
surfaceFilmRegionModel & film ()
 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)
 Copy constructor. 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 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...
 
void operator= (const subModelBase &)=delete
 Disallow default bitwise assignment. More...
 

Protected Attributes

surfaceFilmRegionModel & filmModel_
 Reference to the film 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...
 

Additional Inherited Members

- Protected Member Functions inherited from subModelBase
bool inLine () const
 Flag to indicate whether data is/was read in-line. More...
 

Detailed Description

Base class for surface film sub-models.

Source files

Definition at line 54 of file filmSubModelBase.H.

Constructor & Destructor Documentation

◆ filmSubModelBase() [1/3]

filmSubModelBase ( surfaceFilmRegionModel &  film)

Construct null.

Definition at line 39 of file filmSubModelBase.C.

Referenced by filmSubModelBase::filmSubModelBase().

Here is the caller graph for this function:

◆ filmSubModelBase() [2/3]

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

Construct from film film without name.

Definition at line 47 of file filmSubModelBase.C.

References filmSubModelBase::filmSubModelBase().

Here is the call graph for this function:

◆ filmSubModelBase() [3/3]

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

Construct from film film with name.

Definition at line 68 of file filmSubModelBase.C.

◆ ~filmSubModelBase()

~filmSubModelBase ( )
virtual

Destructor.

Definition at line 90 of file filmSubModelBase.C.

Member Function Documentation

◆ writeTime()

bool writeTime ( ) const
virtual

Flag to indicate when to write a property.

Implements subModelBase.

Definition at line 96 of file filmSubModelBase.C.

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

Referenced by ejectionModel::correct(), transferModel::correct(), patchEjection::correct(), phaseChangeModel::correct(), ejectionModelList::info(), and transferModelList::info().

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

◆ film() [1/2]

const surfaceFilmRegionModel & film ( ) const
inline

Return const access to the film surface film model.

Definition at line 37 of file filmSubModelBaseI.H.

References filmSubModelBase::filmModel_.

Referenced by transferModelList::correct(), ejectionModelList::correct(), primaryRadiation::correct(), patchEjection::correct(), mappedConvectiveHeatTransfer::correct(), standardRadiation::correct(), drippingEjection::correct(), BrunDrippingEjection::correct(), curvatureSeparation::correct(), ejectionModelList::info(), transferModelList::info(), noRadiation::Shs(), and constantRadiation::Shs().

Here is the caller graph for this function:

◆ film() [2/2]

surfaceFilmRegionModel & film ( )
inline

Return the reference to the film surface film model.

Definition at line 43 of file filmSubModelBaseI.H.

References filmSubModelBase::filmModel_.

◆ filmType()

const FilmType & filmType ( ) const
inline

Definition at line 36 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

Reference to the film surface film model.

Definition at line 63 of file filmSubModelBase.H.

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

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