Constraint for velocity to dampen velocity fluctuations in steady simulations. More...

Inheritance diagram for velocityDampingConstraint:

Collaboration diagram for velocityDampingConstraint:

Public Member Functions
	TypeName ("velocityDampingConstraint")
	Runtime type information. More...

	velocityDampingConstraint (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components. More...

virtual	~velocityDampingConstraint ()
	Destructor. More...

virtual void	constrain (fvMatrix< vector > &eqn, const label fieldI)
	Constrain vector matrix. More...

virtual void	writeData (Ostream &) const
	Write data. More...

virtual bool	read (const dictionary &dict)
	Read dictionary. More...

Public Member Functions inherited from cellSetOption
	TypeName ("cellSetOption")
	Runtime type information. More...

	cellSetOption (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components. More...

virtual	~cellSetOption ()
	Destructor. More...

scalar	timeStart () const
	Return const access to the time start. More...

scalar	duration () const
	Return const access to the duration. More...

bool	inTimeLimits (const scalar time) const
	Return true if within time limits. More...

const selectionModeType &	selectionMode () const
	Return const access to the cell selection mode. More...

const word &	cellSetName () const
	Return const access to the name of cell set for "cellSet". More...

scalar	V () const
	Return const access to the total cell volume. More...

const labelList &	cells () const
	Return const access to the cell set. More...

scalar &	timeStart ()
	Return access to the time start. More...

scalar &	duration ()
	Return access to the duration. 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 ()
	Destructor. More...

const word &	name () const
	Return const access to the source name. More...

const fvMesh &	mesh () const
	Return const access to the mesh database. More...

const dictionary &	coeffs () const
	Return dictionary. More...

bool	active () const
	Return const access to the source active flag. More...

void	setApplied (const label fieldI)
	Set the applied flag to true for field index fieldI. More...

Switch &	active ()
	Return access to the source active flag. 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 (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	writeHeader (Ostream &) const
	Write the source header information. More...

virtual void	writeFooter (Ostream &) const
	Write the source footer information. More...

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

Protected Member Functions inherited from cellSetOption
void	setSelection (const dictionary &dict)
	Set the cellSet or points selection. More...

void	setCellSet ()
	Set the cell set based on the user input selection mode. More...

Protected Attributes
scalar	UMax_
	Maximum velocity. More...

Protected Attributes inherited from cellSetOption
scalar	timeStart_
	Time start. More...

scalar	duration_
	Duration. More...

selectionModeType	selectionMode_
	Cell selection mode. More...

word	cellSetName_
	Name of cell set for "cellSet" and "cellZone" selectionMode. More...

List< point >	points_
	List of points for "points" selectionMode. More...

labelList	cells_
	Set of cells to apply source to. More...

scalar	V_
	Sum of cell volumes. 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...

Switch	active_
	Source active flag. 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...

Private Member Functions
	velocityDampingConstraint (const velocityDampingConstraint &)
	Disallow default bitwise copy construct. More...

void	operator= (const velocityDampingConstraint &)
	Disallow default bitwise assignment. More...

Additional Inherited Members
Public Types inherited from cellSetOption
enum	selectionModeType { smPoints, smCellSet, smCellZone, smAll }
	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 fvOption model. More...

Static Public Attributes inherited from cellSetOption
static const NamedEnum< selectionModeType, 4 >	selectionModeTypeNames_
	Word list of selection mode type names. More...

Detailed Description

Constraint for velocity to dampen velocity fluctuations in steady simulations.

In case of velocity exceeding limit applies a source sink to remove the excess velocity by adding a term that drives the velocity to 0 (note that we cannot use the old term velocity since it most likely is already excessive). This additional constraint is scaled with (U-UMax)/dt where dt is a local time scale (= velocity/cellsize) so it switches off if the velocity is below UMax.

Constraint described by:

velocityDampingConstraintCoeffs { UMax 100;

Optional: name of velocity field (default: U) UName U; }

Source files

Definition at line 70 of file velocityDampingConstraint.H.

Constructor & Destructor Documentation

◆ velocityDampingConstraint() [1/2]

velocityDampingConstraint ( const velocityDampingConstraint & )

private

Disallow default bitwise copy construct.

◆ velocityDampingConstraint() [2/2]

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

Construct from components.

Definition at line 89 of file velocityDampingConstraint.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ ~velocityDampingConstraint()

virtual ~velocityDampingConstraint ( )

inlinevirtual

Destructor.

Definition at line 118 of file velocityDampingConstraint.H.

Member Function Documentation

◆ addDamping()

void addDamping ( fvMatrix< vector > & eqn )

protected

Definition at line 50 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:

◆ operator=()

void operator= ( const velocityDampingConstraint & )

private

Disallow default bitwise assignment.

◆ TypeName()

TypeName ( "velocityDampingConstraint" )

Runtime type information.

◆ constrain()

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

virtual

Constrain vector matrix.

Reimplemented from option.

Definition at line 105 of file velocityDampingConstraint.C.

◆ writeData()

void writeData ( Ostream & os ) const

virtual

Write data.

Reimplemented from option.

Definition at line 114 of file velocityDampingConstraint.C.

References Foam::endl(), Foam::indent(), and Ostream::write().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read dictionary.

Reimplemented from cellSetOption.

Definition at line 121 of file velocityDampingConstraint.C.

References dict, cellSetOption::read(), and Foam::readScalar().

Here is the call graph for this function:

Field Documentation

◆ UMax_

scalar UMax_

protected

Maximum velocity.

Definition at line 80 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

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ velocityDampingConstraint() [1/2]

◆ velocityDampingConstraint() [2/2]

◆ ~velocityDampingConstraint()

Member Function Documentation

◆ addDamping()

◆ operator=()

◆ TypeName()

◆ constrain()

◆ writeData()

◆ read()

Field Documentation

◆ UMax_