Limits the film height to a specified max
value.
More...
Public Member Functions | |
TypeName ("limitHeight") | |
Runtime type information. More... | |
limitHeight (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh) | |
Construct from components. More... | |
virtual | ~limitHeight ()=default |
Destructor. More... | |
virtual bool | read (const dictionary &dict) |
Read dictionary. More... | |
virtual void | correct (areaScalarField &h) |
Correct the height field. More... | |
Public Member Functions inherited from faceSetOption | |
TypeName ("faceSetOption") | |
Runtime type information. More... | |
faceSetOption (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh) | |
Construct from components. More... | |
virtual | ~faceSetOption ()=default |
Destructor. More... | |
scalar | timeStart () const noexcept |
Return const access to the time start. More... | |
scalar | duration () const noexcept |
Return const access to the duration. More... | |
bool | inTimeLimits (const scalar timeValue) const |
Return true if within time limits. More... | |
bool | useSubMesh () const noexcept |
True if sub-selection should be used. More... | |
selectionModeType | selectionMode () const noexcept |
Return the face selection mode. More... | |
const wordRes & | selectionNames () const noexcept |
Return const access to the selection names (set, zone or patch selection) More... | |
const wordRe & | zoneName () const |
Return const access to the first set/zone/patch name. More... | |
scalar | A () const noexcept |
Return const access to the total face area. More... | |
const labelList & | faces () const noexcept |
Return const access to the local finite-area face selection. More... | |
scalar | timeStart (scalar val) noexcept |
Adjust the time start, return the old value. More... | |
scalar | duration (scalar val) noexcept |
Adjust the duration, return the old value. More... | |
virtual bool | isActive () |
Is the source active? More... | |
Public Member Functions inherited from option | |
TypeName ("option") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, option, dictionary,(const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh),(name, modelType, dict, mesh)) | |
option (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh) | |
Construct from components. More... | |
autoPtr< option > | clone () const |
Return clone. More... | |
virtual | ~option ()=default |
Destructor. More... | |
const word & | name () const noexcept |
Return const access to the source name. More... | |
const fvMesh & | mesh () const noexcept |
Return const access to the mesh database. More... | |
const dictionary & | coeffs () const noexcept |
Return dictionary. More... | |
bool | active () const noexcept |
True if source is active. More... | |
void | setApplied (const label fieldi) |
Set the applied flag to true for field index fieldi. More... | |
const word & | regionName () const noexcept |
The region name. More... | |
const faMesh & | regionMesh () const |
Return the region mesh database (demand-driven) More... | |
const volSurfaceMapping & | vsm () const |
Return volSurfaceMapping (demand-driven) More... | |
bool | active (const bool on) noexcept |
Change source active flag, return previous value. More... | |
virtual label | applyToField (const word &fieldName) const |
Return index of field name if found in fieldNames list. More... | |
virtual void | checkApplied () const |
Check that the source has been applied. More... | |
virtual void | addSup (const areaScalarField &h, faMatrix< scalar > &eqn, const label fieldi) |
virtual void | addSup (const areaScalarField &h, faMatrix< vector > &eqn, const label fieldi) |
virtual void | addSup (const areaScalarField &h, faMatrix< symmTensor > &eqn, const label fieldi) |
virtual void | addSup (const areaScalarField &h, faMatrix< sphericalTensor > &eqn, const label fieldi) |
virtual void | addSup (const areaScalarField &h, faMatrix< tensor > &eqn, const label fieldi) |
virtual void | addSup (const areaScalarField &h, const areaScalarField &rho, faMatrix< scalar > &eqn, const label fieldi) |
virtual void | addSup (const areaScalarField &h, const areaScalarField &rho, faMatrix< vector > &eqn, const label fieldi) |
virtual void | addSup (const areaScalarField &h, const areaScalarField &rho, faMatrix< symmTensor > &eqn, const label fieldi) |
virtual void | addSup (const areaScalarField &h, const areaScalarField &rho, faMatrix< sphericalTensor > &eqn, const label fieldi) |
virtual void | addSup (const areaScalarField &h, const areaScalarField &rho, faMatrix< tensor > &eqn, const label fieldi) |
virtual void | constrain (faMatrix< scalar > &eqn, const label fieldi) |
virtual void | constrain (faMatrix< vector > &eqn, const label fieldi) |
virtual void | constrain (faMatrix< sphericalTensor > &eqn, const label fieldi) |
virtual void | constrain (faMatrix< symmTensor > &eqn, const label fieldi) |
virtual void | constrain (faMatrix< tensor > &eqn, const label fieldi) |
virtual void | correct (areaVectorField &field) |
virtual void | correct (areaSphericalTensorField &field) |
virtual void | correct (areaSymmTensorField &field) |
virtual void | correct (areaTensorField &field) |
virtual void | writeHeader (Ostream &) const |
Write the source header information. More... | |
virtual void | writeFooter (Ostream &) const |
Write the source footer information. More... | |
virtual void | writeData (Ostream &) const |
Write the source properties. More... | |
Protected Member Functions | |
limitHeight (const limitHeight &)=delete | |
No copy construct. More... | |
void | operator= (const limitHeight &)=delete |
No copy assignment. More... | |
Protected Member Functions inherited from faceSetOption | |
void | setSelection (const dictionary &dict) |
Set face selection name from dictionary input. More... | |
void | setFaceSelection () |
Set face selection based on user input selection mode. More... | |
void | setArea () |
Recalculate the area. More... | |
template<class Type > | |
void | subsetFilter (List< Type > &field) const |
Zero all non-selected locations within field. More... | |
Protected Member Functions inherited from option | |
void | resetApplied () |
Resize/reset applied flag list for all fieldNames_ entries. More... | |
Protected Attributes | |
word | hName_ |
Name of operand height field. More... | |
scalar | max_ |
Maximum height [m]. More... | |
Protected Attributes inherited from faceSetOption | |
scalar | timeStart_ |
Time start. More... | |
scalar | duration_ |
Duration. More... | |
selectionModeType | selectionMode_ |
Face selection mode. More... | |
wordRes | selectionNames_ |
Face selection names (for set, zone or patch selections) More... | |
labelList | faces_ |
Set of faces to apply source to. More... | |
scalar | A_ |
Sum of face area. More... | |
Protected Attributes inherited from option | |
const word | name_ |
Source name. More... | |
const word | modelType_ |
Model type. More... | |
const fvMesh & | mesh_ |
Reference to the mesh database. More... | |
dictionary | dict_ |
Top level source dictionary. More... | |
dictionary | coeffs_ |
Dictionary containing source coefficients. More... | |
wordList | fieldNames_ |
Field names to apply source to - populated by derived models. More... | |
List< bool > | applied_ |
Applied flag list - corresponds to each fieldNames_ entry. More... | |
word | regionName_ |
Region name (finite-area) More... | |
Additional Inherited Members | |
Public Types inherited from faceSetOption | |
enum | selectionModeType { smAll, smFaceSet, smFaceZone, smPatch } |
Enumeration for selection mode types. More... | |
Static Public Member Functions inherited from option | |
static autoPtr< option > | New (const word &name, const dictionary &dict, const fvMesh &mesh) |
Return a reference to the selected faOption model. More... | |
Public Attributes inherited from option | |
bool | log |
Switch write log to Info. More... | |
Static Public Attributes inherited from faceSetOption | |
static const Enum< selectionModeType > | selectionModeTypeNames_ |
List of selection mode type names. More... | |
Limits the film height to a specified max
value.
The limitHeight
applies an explicit correction to limit the max film height to the user-specified value. This will ensure that the max value is adhered to, but may become unstable if the limiting instigates an oscillatory/destabilising effect into neighbouring faces that then spreads.
constant/faOptions
: <faOption> { // Mandatory entries type limitHeight; active yes; selectionMode all; max <scalar>; // Optional entries h <word>; // Inherited entries ... }
where the entries mean:
Property | Description | Type | Reqd | Deflt |
---|---|---|---|---|
type | Type name: limitHeight | word | yes | - |
max | Maximum height limit [m] | scalar | yes | - |
h | Name of operand height field | word | no | h |
The inherited entries are elaborated in:
Definition at line 107 of file limitHeight.H.
|
protecteddelete |
No copy construct.
limitHeight | ( | const word & | name, |
const word & | modelType, | ||
const dictionary & | dict, | ||
const fvMesh & | mesh | ||
) |
Construct from components.
Definition at line 45 of file limitHeight.C.
References dict, and Foam::blockMeshTools::read().
|
virtualdefault |
Destructor.
|
protecteddelete |
No copy assignment.
TypeName | ( | "limitHeight" | ) |
Runtime type information.
|
virtual |
Read dictionary.
Reimplemented from faceSetOption.
Definition at line 62 of file limitHeight.C.
References option::applied_, option::coeffs_, dict, option::fieldNames_, limitHeight::hName_, limitHeight::max_, faceSetOption::read(), dictionary::readEntry(), dictionary::readIfPresent(), and List< T >::resize().
|
virtual |
Correct the height field.
Reimplemented from option.
Definition at line 80 of file limitHeight.C.
References Foam::constant::electromagnetic::e, Foam::endl(), Foam::constant::universal::h, Foam::Info, Foam::max(), Foam::reduce(), Foam::returnReduce(), Foam::type(), and faceSetOption::useSubMesh().
|
protected |
Name of operand height field.
Definition at line 118 of file limitHeight.H.
Referenced by limitHeight::read().
|
protected |
Maximum height [m].
Definition at line 123 of file limitHeight.H.
Referenced by limitHeight::read().
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.