Constrain given velocity fields to dampen velocity fluctuations exceeding a given value within a specified region. More...

Inheritance diagram for velocityDampingConstraint:

[legend]

Collaboration diagram for velocityDampingConstraint:

[legend]

Public Member Functions
	TypeName ("velocityDampingConstraint")

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

	velocityDampingConstraint (const velocityDampingConstraint &)=delete

void	operator= (const velocityDampingConstraint &)=delete

virtual	~velocityDampingConstraint ()=default

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

virtual void	writeData (Ostream &os) const

virtual bool	read (const dictionary &dict)

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< 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 (volVectorField &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

Protected Member Functions
void	addDamping (fvMatrix< vector > &eqn)

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

void	setCellSelection ()

void	setVol ()

Protected Member Functions inherited from option
void	resetApplied ()

Protected Attributes
scalar	UMax_

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_

Detailed Description

Constrain given velocity fields to dampen velocity fluctuations exceeding a given value within a specified region.

This constraint is primarily used to dampen velocity fluctuations in the start-up phase of simulations. When the local velocity magnitude exceeds the user-supplied maximum value a sink term is activated in the affected region to lower the velocity to the limiting value.

Constraints applied to:

  U    | Velocity                   [m/s]

Required fields:

  U    | Velocity                   [m/s]

Usage

Minimal example by using constant/fvOptions:

velocityDampingConstraint1
{
    // Mandatory entries (unmodifiable)
    type            velocityDampingConstraint;

    // Mandatory entries (runtime modifiable)
    UMax            200;

    // Optional entries (runtime modifiable)
    UNames          (<Uname1> <Uname2> ... <UnameN>);

    // Conditional optional entries (runtime modifiable)

        // when UNames entry is not present
        U               U;

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

where the entries mean:

Property	Description	Type	Reqd	Dflt
`type`	Type name: velocityDampingConstraint	word	yes	-
`UMax`	Maximum velocity magnitude	scalar	yes	-
`UNames`	Names of operand velocity fields	wordList	no	-
`U`	Name of operand velocity field	word	cndtnl	U

The inherited entries are elaborated in:

Note

When active, this constraint manipulates the system of equations. Users should ensure that it is not active when the case is converged (steady-state) or during the period of interest (transient) to ensure that its presence does not pollute the results.

See also

Foam::fv::limitVelocity

Source files

Definition at line 144 of file velocityDampingConstraint.H.

Constructor & Destructor Documentation

◆ velocityDampingConstraint() [1/2]

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

Definition at line 85 of file velocityDampingConstraint.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ velocityDampingConstraint() [2/2]

velocityDampingConstraint ( const velocityDampingConstraint & )

delete

◆ ~velocityDampingConstraint()

virtual ~velocityDampingConstraint ( )

virtualdefault

Member Function Documentation

◆ addDamping()

void addDamping ( fvMatrix< vector > & eqn )

protected

Definition at line 46 of file velocityDampingConstraint.C.

References Foam::cbrt(), Foam::diag(), Foam::endl(), forAll, polyMesh::globalData(), Foam::Info, Foam::mag(), option::mesh_, option::name_, globalMeshData::nTotalCells(), fvMatrix::psi(), Foam::reduce(), Foam::sqr(), Foam::type(), U, velocityDampingConstraint::UMax_, and fvMesh::V().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "velocityDampingConstraint" )

◆ operator=()

void operator= ( const velocityDampingConstraint & )

delete

◆ constrain()

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

virtual

Reimplemented from option.

Definition at line 101 of file velocityDampingConstraint.C.

◆ writeData()

void writeData ( Ostream & os ) const

virtual

Reimplemented from option.

Definition at line 110 of file velocityDampingConstraint.C.

References os().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Reimplemented from cellSetOption.

Definition at line 116 of file velocityDampingConstraint.C.

References dict, cellSetOption::read(), and option::resetApplied().

Here is the call graph for this function:

Member Data Documentation

◆ UMax_

scalar UMax_

protected

Definition at line 153 of file velocityDampingConstraint.H.

Referenced by velocityDampingConstraint::addDamping().

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

src/fvOptions/constraints/derived/velocityDampingConstraint/velocityDampingConstraint.H
src/fvOptions/constraints/derived/velocityDampingConstraint/velocityDampingConstraint.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ velocityDampingConstraint() [1/2]

◆ velocityDampingConstraint() [2/2]

◆ ~velocityDampingConstraint()

Member Function Documentation

◆ addDamping()

◆ TypeName()

◆ operator=()

◆ constrain()

◆ writeData()

◆ read()

Member Data Documentation

◆ UMax_