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

Inheritance diagram for limitVelocity:

Collaboration diagram for limitVelocity:

Public Member Functions
	TypeName ("limitVelocity")

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

virtual	~limitVelocity ()=default

virtual bool	read (const dictionary &dict)

virtual void	correct (areaVectorField &U)

Public Member Functions inherited from faceSetOption
	TypeName ("faceSetOption")

	faceSetOption (const word &name, const word &modelType, const dictionary &dict, const fvPatch &patch)

virtual	~faceSetOption ()=default

scalar	timeStart () const noexcept

scalar	duration () const noexcept

bool	inTimeLimits (const scalar timeValue) const

selectionModeType	selectionMode () const noexcept

bool	useSubMesh () const noexcept

const word &	faceSetName () const noexcept

scalar	A () const noexcept

const labelList &	faces () const noexcept

scalar	timeStart (scalar val) noexcept

scalar	duration (scalar val) noexcept

virtual bool	isActive ()

Public Member Functions inherited from option
	TypeName ("option")

	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)

autoPtr< option >	clone () const

virtual	~option ()=default

const word &	name () const noexcept

const fvMesh &	mesh () const noexcept

const fvPatch &	patch () const noexcept

const dictionary &	coeffs () const noexcept

bool	active () const noexcept

void	setApplied (const label fieldi)

const word &	regionName () const noexcept

const faMesh &	regionMesh () const

const volSurfaceMapping &	vsm () const

bool	active (const bool on) noexcept

virtual label	applyToField (const word &fieldName) const

virtual void	checkApplied () const

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	writeHeader (Ostream &) const

virtual void	writeFooter (Ostream &) const

virtual void	writeData (Ostream &) const

Protected Attributes
word	UName_

scalar	max_

Protected Attributes inherited from faceSetOption
scalar	timeStart_

scalar	duration_

selectionModeType	selectionMode_

word	faceSetName_

labelList	faces_

scalar	A_

Protected Attributes inherited from option
const word	name_

const word	modelType_

const fvMesh &	mesh_

const fvPatch &	patch_

dictionary	dict_

dictionary	coeffs_

wordList	fieldNames_

List< bool >	applied_

word	regionName_

Additional Inherited Members
Public Types inherited from faceSetOption
enum	selectionModeType { smAll, smVolFaceZone }

Static Public Member Functions inherited from option
static autoPtr< option >	New (const word &name, const dictionary &dict, const fvPatch &patch)

Public Attributes inherited from option
bool	log

Static Public Attributes inherited from faceSetOption
static const Enum< selectionModeType >	selectionModeTypeNames_

Protected Member Functions inherited from faceSetOption
void	setSelection (const dictionary &dict)

void	setFaceSelection ()

void	setArea ()

Protected Member Functions inherited from option
void	resetApplied ()

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 103 of file limitVelocity.H.

Constructor & Destructor Documentation

◆ limitVelocity()

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

Definition at line 44 of file limitVelocity.C.

◆ ~limitVelocity()

virtual ~limitVelocity ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "limitVelocity" )

◆ read()

bool read ( const dictionary & dict )

virtual

Reimplemented from faceSetOption.

Definition at line 62 of file limitVelocity.C.

References option::coeffs_, dict, limitVelocity::max_, faceSetOption::read(), and dictionary::readEntry().

Here is the call graph for this function:

◆ correct()

void correct ( areaVectorField & U )

virtual

Reimplemented from option.

Definition at line 75 of file limitVelocity.C.

References forAll, Foam::magSqr(), Foam::max(), Foam::sqr(), Foam::sqrt(), U, and faceSetOption::useSubMesh().

Here is the call graph for this function:

Member Data Documentation

◆ UName_

word UName_

protected

Definition at line 112 of file limitVelocity.H.

◆ max_

scalar max_

protected

Definition at line 115 of file limitVelocity.H.

Referenced by limitVelocity::read().

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

src/faOptions/corrections/limitVelocity/limitVelocity.H
src/faOptions/corrections/limitVelocity/limitVelocity.C

Public Member Functions

Protected Attributes

Additional Inherited Members