Public Member Functions | |
filmSubModelBase (liquidFilmBase &film) | |
Construct null. More... | |
filmSubModelBase (liquidFilmBase &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, liquidFilmBase &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 liquidFilmBase & | film () const |
Return const access to the film surface film model. More... | |
liquidFilmBase & | 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) | |
Construct as copy. More... | |
virtual | ~subModelBase ()=default |
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 bool | active () const |
Return the model 'active' status - default active = true. More... | |
virtual void | cacheFields (const bool store) |
Cache dependent sub-model fields. More... | |
virtual fileName | localPath () const |
Output directory. More... | |
template<class Type > | |
Type | getBaseProperty (const word &entryName, const Type &defaultValue=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... | |
bool | getModelDict (const word &entryName, dictionary &dict) const |
Retrieve dictionary, return true if set. More... | |
template<class Type > | |
bool | 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=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 Attributes | |
liquidFilmBase & | 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 | |
Public Attributes inherited from subModelBase | |
bool | log |
Flag to write log into Info. More... | |
Protected Member Functions inherited from subModelBase | |
bool | inLine () const |
Flag to indicate whether data is/was read in-line. More... | |
Definition at line 52 of file filmSubModelBase.H.
filmSubModelBase | ( | liquidFilmBase & | film | ) |
Construct null.
Definition at line 34 of file filmSubModelBase.C.
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 42 of file filmSubModelBase.C.
filmSubModelBase | ( | const word & | modelName, |
liquidFilmBase & | film, | ||
const dictionary & | dict, | ||
const word & | baseName, | ||
const word & | modelType | ||
) |
Construct from film film with name.
Definition at line 63 of file filmSubModelBase.C.
|
virtual |
Destructor.
Definition at line 85 of file filmSubModelBase.C.
|
virtual |
Flag to indicate when to write a property.
Reimplemented from subModelBase.
Definition at line 91 of file filmSubModelBase.C.
References subModelBase::active(), filmSubModelBase::filmModel_, regionFaModel::time(), and TimeState::writeTime().
Referenced by injectionModel::correct(), contactAngleForce::correct(), and injectionModelList::info().
|
inline |
Return const access to the film surface film model.
Definition at line 32 of file filmSubModelBaseI.H.
References filmSubModelBase::filmModel_.
Referenced by contactAngleForce::correct(), injectionModelList::info(), and dynamicContactAngleForce::theta().
|
inline |
Return the reference to the film surface film model.
Definition at line 38 of file filmSubModelBaseI.H.
References filmSubModelBase::filmModel_.
|
inline |
Definition at line 31 of file filmSubModelBaseTemplates.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, filmSubModelBase::filmModel_, and subModelBase::modelType().
|
protected |
Reference to the film surface film model.
Definition at line 63 of file filmSubModelBase.H.
Referenced by filmSubModelBase::film(), filmSubModelBase::filmType(), and filmSubModelBase::writeTime().
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.