limitVelocity Class Reference

Limits the maximum velocity magnitude to the specified max value. More...

Inheritance diagram for limitVelocity:
[legend]
Collaboration diagram for limitVelocity:
[legend]

Public Member Functions

 TypeName ("limitVelocity")
 Runtime type information. More...
 
 limitVelocity (const word &name, const word &modelType, const dictionary &dict, const fvPatch &patch)
 Construct from components. More...
 
virtual ~limitVelocity ()=default
 Destructor. More...
 
virtual bool read (const dictionary &dict)
 Read dictionary. More...
 
virtual void correct (areaVectorField &U)
 Correct the velocity 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 fvPatch &patch)
 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...
 
selectionModeType selectionMode () const noexcept
 Return const access to the face selection mode. More...
 
bool useSubMesh () const noexcept
 True if sub-selection should be used. More...
 
const wordRezoneName () const noexcept
 
scalar A () const noexcept
 Return const access to the total face area. More...
 
const labelListfaces () const noexcept
 Return const access to the 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...
 
virtual bool read (const dictionary &dict)
 Read source dictionary. 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 fvPatch &patch),(name, modelType, dict, patch))
 
 option (const word &name, const word &modelType, const dictionary &dict, const fvPatch &patch)
 Construct from components. More...
 
autoPtr< optionclone () const
 Return clone. More...
 
virtual ~option ()=default
 Destructor. More...
 
const wordname () const noexcept
 Return const access to the source name. More...
 
const fvMeshmesh () const noexcept
 Return const access to the mesh database. More...
 
const fvPatchpatch () const noexcept
 Return const access to fvPatch. More...
 
const dictionarycoeffs () 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 wordregionName () const noexcept
 The region name. More...
 
const faMeshregionMesh () const
 Return the region mesh database (demand-driven) More...
 
const volSurfaceMappingvsm () const
 Return volSurfaceMapping (demand-driven) More...
 
bool active (const bool on) noexcept
 Change source active flag, return previous value. More...
 
virtual bool isActive ()
 Is the source active? 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 (areaScalarField &field)
 
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...
 
virtual bool read (const dictionary &dict)
 Read source dictionary. More...
 

Protected Attributes

word UName_
 Name of operand velocity field. More...
 
scalar max_
 Maximum velocity magnitude. More...
 
- Protected Attributes inherited from faceSetOption
scalar timeStart_
 Time start. More...
 
scalar duration_
 Duration. More...
 
selectionModeType selectionMode_
 Face selection mode. More...
 
wordRe zoneName_
 Name of zone for (volume) "faceZone" selection. 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 fvMeshmesh_
 Reference to the mesh database. More...
 
const fvPatchpatch_
 Reference to the patch. 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< boolapplied_
 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 , smVolFaceZone }
 Enumeration for selection mode types. More...
 
- Static Public Member Functions inherited from option
static autoPtr< optionNew (const word &name, const dictionary &dict, const fvPatch &patch)
 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< selectionModeTypeselectionModeTypeNames_
 List of selection mode type names. 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...
 
- Protected Member Functions inherited from option
void resetApplied ()
 Resize/reset applied flag list for all fieldNames_ entries. More...
 

Detailed Description

Limits the maximum velocity magnitude to the specified max value.

Usage
Minimal example by using constant/faOptions:
<faOption>
{
    // Mandatory entries
    type            limitVelocity;
    active          yes;
    selectionMode   all;
    max             <maxValue>;

    // Optional entries
    U               <UName>;

    // Inherited entries
    ...
}

where the entries mean:

Property Description Type Reqd Deflt
type Type name: limitVelocity word yes -
max Maximum velocity limit [m/s] scalar yes -
U Name of operand velocity field word no U

The inherited entries are elaborated in:

Source files

Definition at line 107 of file limitVelocity.H.

Constructor & Destructor Documentation

◆ limitVelocity()

limitVelocity ( const word name,
const word modelType,
const dictionary dict,
const fvPatch patch 
)

Construct from components.

Definition at line 50 of file limitVelocity.C.

References option::applied_, option::fieldNames_, Foam::name(), List< T >::setSize(), and limitVelocity::UName_.

Here is the call graph for this function:

◆ ~limitVelocity()

virtual ~limitVelocity ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "limitVelocity"  )

Runtime type information.

◆ read()

bool read ( const dictionary dict)
virtual

Read dictionary.

Reimplemented from faceSetOption.

Definition at line 69 of file limitVelocity.C.

References dict, and kEpsilonLopesdaCosta< BasicTurbulenceModel >::read().

Here is the call graph for this function:

◆ correct()

void correct ( areaVectorField U)
virtual

Correct the velocity field.

Reimplemented from option.

Definition at line 82 of file limitVelocity.C.

References e, Foam::endl(), Foam::Info, Foam::magSqr(), Foam::max(), Foam::reduce(), Foam::returnReduce(), Foam::sqr(), Foam::sqrt(), Foam::type(), U, and faceSetOption::useSubMesh().

Here is the call graph for this function:

Member Data Documentation

◆ UName_

word UName_
protected

Name of operand velocity field.

Definition at line 116 of file limitVelocity.H.

Referenced by limitVelocity::limitVelocity().

◆ max_

scalar max_
protected

Maximum velocity magnitude.

Definition at line 119 of file limitVelocity.H.


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