Corrects velocity field (i.e. T) within a specified region by applying a given maximum velocity magnitude limit. More...

Inheritance diagram for limitVelocity:

[legend]

Collaboration diagram for limitVelocity:

[legend]

Public Member Functions
	TypeName ("limitVelocity")

	limitVelocity (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)

	limitVelocity (const limitVelocity &)=delete

void	operator= (const limitVelocity &)=delete

virtual	~limitVelocity ()=default

virtual bool	read (const dictionary &dict)

virtual void	correct (volVectorField &U)

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

	cellSetOption (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)

virtual	~cellSetOption ()=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 &	cellSetName () const noexcept

scalar	V () const noexcept

const labelList &	cells () 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 fvMesh &mesh),(name, modelType, dict, mesh))

	option (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)

autoPtr< option >	clone () const

virtual	~option ()=default

const word &	name () const noexcept

const fvMesh &	mesh () const noexcept

const dictionary &	coeffs () const noexcept

bool	active () const noexcept

void	setApplied (const label fieldi)

bool	active (const bool on) noexcept

virtual label	applyToField (const word &fieldName) const

virtual void	checkApplied () const

virtual void	addSup (fvMatrix< scalar > &eqn, const label fieldi)

virtual void	addSup (fvMatrix< vector > &eqn, const label fieldi)

virtual void	addSup (fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	addSup (fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	addSup (fvMatrix< tensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< scalar > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< vector > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< tensor > &eqn, const label fieldi)

virtual void	correct (volScalarField &field)

virtual void	correct (volSphericalTensorField &field)

virtual void	correct (volSymmTensorField &field)

virtual void	correct (volTensorField &field)

virtual void	postProcessSens (scalarField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)

virtual void	postProcessSens (vectorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)

virtual void	postProcessSens (tensorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)

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 cellSetOption
scalar	timeStart_

scalar	duration_

selectionModeType	selectionMode_

word	cellSetName_

List< point >	points_

labelList	cells_

scalar	V_

Protected Attributes inherited from option
const word	name_

const word	modelType_

const fvMesh &	mesh_

dictionary	dict_

dictionary	coeffs_

wordList	fieldNames_

List< bool >	applied_

bool	active_

Additional Inherited Members
Public Types inherited from cellSetOption
enum	selectionModeType { smAll, smCellSet, smCellZone, smPoints }

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

Public Attributes inherited from option
bool	log

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

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

void	setCellSelection ()

void	setVol ()

Protected Member Functions inherited from option
void	resetApplied ()

Detailed Description

Corrects velocity field (i.e. T) within a specified region by applying a given maximum velocity magnitude limit.

Corrections applied to:

  U    | Velocity                   [m/s]

Required fields:

  U    | Velocity                   [m/s]

Usage

Minimal example by using constant/fvOptions:

limitVelocity1
{
    // Mandatory entries (unmodifiable)
    type            limitVelocity;

    // Mandatory entries (runtime modifiable)
    max             <maxValue>;

    // Optional entries (runtime modifiable)
    U               <Uname>;

    // Mandatory/Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Dflt
`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:

See also

Foam::fv::velocityDampingConstraint

Source files

Definition at line 118 of file limitVelocity.H.

Constructor & Destructor Documentation

◆ limitVelocity() [1/2]

limitVelocity	(	const word &	name,
		const word &	modelType,
		const dictionary &	dict,
		const fvMesh &	mesh
	)

Definition at line 41 of file limitVelocity.C.

◆ limitVelocity() [2/2]

limitVelocity ( const limitVelocity & )

delete

◆ ~limitVelocity()

virtual ~limitVelocity ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "limitVelocity" )

◆ operator=()

void operator= ( const limitVelocity & )

delete

◆ read()

bool read ( const dictionary & dict )

virtual

Reimplemented from cellSetOption.

Definition at line 59 of file limitVelocity.C.

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

Here is the call graph for this function:

◆ correct()

void correct ( volVectorField & U )

virtual

Reimplemented from option.

Definition at line 72 of file limitVelocity.C.

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

Here is the call graph for this function:

Member Data Documentation

◆ UName_

word UName_

protected

Definition at line 127 of file limitVelocity.H.

◆ max_

scalar max_