The filmSeparation is a collection of curvature thin-film separation models designed to predict the onset of film separation and mass separation in geometries featuring sharp and/or rounded corners.
More...
#include <filmSeparation.H>
Public Member Functions | |
| TypeName ("filmSeparation") | |
| Runtime type information. | |
| filmSeparation (liquidFilmBase &film, const dictionary &dict) | |
| Construct from base film model and dictionary. | |
| virtual | ~filmSeparation () |
| Destructor. | |
| virtual void | correct (scalarField &availableMass, scalarField &massToInject, scalarField &diameterToInject) |
| Correct film properties due to the film separation. | |
| Public Member Functions inherited from injectionModel | |
| TypeName ("injectionModel") | |
| Runtime type information. | |
| declareRunTimeSelectionTable (autoPtr, injectionModel, dictionary,(liquidFilmBase &film, const dictionary &dict),(film, dict)) | |
| injectionModel (liquidFilmBase &film) | |
| Construct null. | |
| injectionModel (const word &modelType, liquidFilmBase &film, const dictionary &dict) | |
| Construct from type name, dictionary and surface film model. | |
| virtual | ~injectionModel () |
| Destructor. | |
| virtual scalar | injectedMassTotal () const |
| Return the total mass injected. | |
| virtual void | patchInjectedMassTotals (scalar &patchMasses) const |
| Accumulate the total mass injected for the patches into the scalarField provided. | |
| Public Member Functions inherited from filmSubModelBase | |
| 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. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from injectionModel | |
| static autoPtr< injectionModel > | New (liquidFilmBase &film, const dictionary &dict, const word &mdoelType) |
| Return a reference to the selected injection model. | |
| Public Attributes inherited from subModelBase | |
| bool | log |
| Flag to write log into Info. | |
| Protected Member Functions inherited from injectionModel | |
| void | addToInjectedMass (const scalar dMass) |
| Add to injected mass. | |
| void | correct () |
| Correct. | |
| Protected Member Functions inherited from subModelBase | |
| bool | inLine () const |
| Flag to indicate whether data is/was read in-line. | |
| Protected Attributes inherited from filmSubModelBase | |
| 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. | |
The filmSeparation is a collection of curvature thin-film separation models designed to predict the onset of film separation and mass separation in geometries featuring sharp and/or rounded corners.
injectionModels
{
// Mandatory entries
filmSeparation
}
filmSeparationCoeffs
{
model <word>;
// Conditional entries
// Option-1: when model == OwenRyley
// Option-2: when model == Friedrich
// Inherited entries
...
}
where the entries mean:
| Property | Description | Type | Reqd | Deflt |
|---|---|---|---|---|
model | Name of the filmSeparation model | word | yes | - |
Options for the model entry:
OwenRyley | Model proposed by Owen-Ryley (1985)
Friedrich | Model proposed by Friedrich et al. (2008)
The inherited entries are elaborated in:
Definition at line 108 of file filmSeparation.H.
| filmSeparation | ( | liquidFilmBase & | film, |
| const dictionary & | dict ) |
Construct from base film model and dictionary.
Definition at line 51 of file filmSeparation.C.
References subModelBase::coeffDict_, subModelBase::dict(), filmSubModelBase::film(), and injectionModel::New().
|
virtual |
Destructor.
Definition at line 64 of file filmSeparation.C.
| TypeName | ( | "filmSeparation" | ) |
Runtime type information.
References subModelBase::dict(), and filmSubModelBase::film().
|
virtual |
Correct film properties due to the film separation.
Implements injectionModel.
Definition at line 70 of file filmSeparation.C.
References injectionModel::addToInjectedMass(), injectionModel::correct(), tmp< T >::cref(), Foam::dimMass, filmSubModelBase::film(), mesh, GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), Foam::sum(), regIOobject::write(), and Foam::Zero.
1.16.1