Loading...
Searching...
No Matches
filmSubModelBase Class Reference

#include <filmSubModelBase.H>

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

Public Member Functions

 filmSubModelBase (liquidFilmBase &film)
 Construct null.
 filmSubModelBase (liquidFilmBase &film, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 Construct from film film without name.
 filmSubModelBase (const word &modelName, liquidFilmBase &film, const dictionary &dict, const word &baseName, const word &modelType)
 Construct from film film with name.
virtual ~filmSubModelBase ()
 Destructor.
virtual bool writeTime () const
 Flag to indicate when to write a property.
const liquidFilmBase & film () const
 Return const access to the film surface film model.
liquidFilmBase & film ()
 Return the reference to the film surface film model.
template<class FilmType>
const FilmType & filmType () const
Public Member Functions inherited from subModelBase
 subModelBase (dictionary &properties)
 Construct null.
 subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 Construct from components without name.
 subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
 Construct from components with name.
 subModelBase (const subModelBase &smb)
 Construct as copy.
virtual ~subModelBase ()=default
 Destructor.
const word & modelName () const
 Return const access to the name of the sub-model.
const dictionary & dict () const
 Return const access to the cloud dictionary.
const word & baseName () const
 Return const access to the base name of the sub-model.
const word & modelType () const
 Return const access to the sub-model type.
const dictionary & coeffDict () const
 Return const access to the coefficients dictionary.
const dictionary & properties () const
 Return const access to the properties dictionary.
virtual bool defaultCoeffs (const bool printMsg) const
 Returns true if defaultCoeffs is true and outputs on printMsg.
virtual bool active () const
 Return the model 'active' status - default active = true.
virtual void cacheFields (const bool store)
 Cache dependent sub-model fields.
virtual fileName localPath () const
 Output directory.
template<class Type>
Type getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
 Retrieve generic property from the base model.
template<class Type>
void getBaseProperty (const word &entryName, Type &value) const
 Retrieve generic property from the base model.
template<class Type>
void setBaseProperty (const word &entryName, const Type &value)
 Add generic property to the base model.
bool getModelDict (const word &entryName, dictionary &dict) const
 Retrieve dictionary, return true if set.
template<class Type>
bool getModelProperty (const word &entryName, Type &value) const
 Retrieve generic property from the sub-model.
template<class Type>
Type getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
 Retrieve generic property from the sub-model.
template<class Type>
void setModelProperty (const word &entryName, const Type &value)
 Add generic property to the sub-model.
virtual void write (Ostream &os) const
 Write.

Protected Attributes

liquidFilmBase & filmModel_
 Reference to the film surface film model.
Protected Attributes inherited from subModelBase
const word modelName_
 Name of the sub-model.
dictionary & properties_
 Reference to properties dictionary e.g. for restart.
const dictionary dict_
 Copy of dictionary used during construction.
const word baseName_
 Name of the sub-model base class.
const word modelType_
 Type of the sub-model.
const dictionary coeffDict_
 Coefficients dictionary.

Additional Inherited Members

Public Attributes inherited from subModelBase
bool log
 Flag to write log into Info.
Protected Member Functions inherited from subModelBase
bool inLine () const
 Flag to indicate whether data is/was read in-line.

Detailed Description

Definition at line 52 of file filmSubModelBase.H.

Constructor & Destructor Documentation

◆ filmSubModelBase() [1/3]

filmSubModelBase ( liquidFilmBase & film)

Construct null.

Definition at line 34 of file filmSubModelBase.C.

References film(), filmModel_, and subModelBase::subModelBase().

Referenced by force::force(), force::force(), injectionModel::injectionModel(), injectionModel::injectionModel(), injectionModelList::injectionModelList(), and injectionModelList::injectionModelList().

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

◆ filmSubModelBase() [2/3]

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

Construct from film film without name.

Definition at line 41 of file filmSubModelBase.C.

References subModelBase::baseName(), subModelBase::dict(), film(), filmModel_, subModelBase::modelType(), and subModelBase::subModelBase().

Here is the call graph for this function:

◆ filmSubModelBase() [3/3]

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

Construct from film film with name.

Definition at line 62 of file filmSubModelBase.C.

References subModelBase::baseName(), subModelBase::dict(), film(), filmModel_, subModelBase::modelName(), subModelBase::modelType(), and subModelBase::subModelBase().

Here is the call graph for this function:

◆ ~filmSubModelBase()

~filmSubModelBase ( )
virtual

Destructor.

Definition at line 85 of file filmSubModelBase.C.

Member Function Documentation

◆ writeTime()

bool writeTime ( ) const
virtual

Flag to indicate when to write a property.

Reimplemented from subModelBase.

Definition at line 91 of file filmSubModelBase.C.

References subModelBase::active(), and filmModel_.

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

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

◆ film() [1/2]

const liquidFilmBase & film ( ) const
inline

Return const access to the film surface film model.

Definition at line 32 of file filmSubModelBaseI.H.

References filmModel_.

Referenced by BrunDrippingInjection::BrunDrippingInjection(), contactAngleForce::contactAngleForce(), BrunDrippingInjection::correct(), contactAngleForce::correct(), filmSeparation::correct(), injectionModelList::correct(), force::declareRunTimeSelectionTable(), injectionModel::declareRunTimeSelectionTable(), dynamicContactAngleForce::dynamicContactAngleForce(), filmSeparation::filmSeparation(), filmSubModelBase(), filmSubModelBase(), filmSubModelBase(), force::force(), force::force(), injectionModelList::info(), injectionModel::injectionModel(), injectionModel::injectionModel(), injectionModelList::injectionModelList(), injectionModelList::injectionModelList(), dynamicContactAngleForce::theta(), BrunDrippingInjection::TypeName(), contactAngleForce::TypeName(), dynamicContactAngleForce::TypeName(), and filmSeparation::TypeName().

Here is the caller graph for this function:

◆ film() [2/2]

liquidFilmBase & film ( )
inline

Return the reference to the film surface film model.

Definition at line 38 of file filmSubModelBaseI.H.

References filmModel_.

◆ filmType()

template<class FilmType>
const FilmType & filmType ( ) const
inline

Definition at line 31 of file filmSubModelBaseTemplates.C.

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

Here is the call graph for this function:

Member Data Documentation

◆ filmModel_

liquidFilmBase& filmModel_
protected

Reference to the film surface film model.

Definition at line 63 of file filmSubModelBase.H.

Referenced by film(), film(), filmSubModelBase(), filmSubModelBase(), filmSubModelBase(), filmType(), and writeTime().

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