limitVelocity Class Reference

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

Inheritance diagram for limitVelocity:

Collaboration diagram for limitVelocity:

Public Member Functions
	TypeName ("limitVelocity")
	Runtime type information. More...
	limitVelocity (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components. More...
	limitVelocity (const limitVelocity &)=delete
	Disallow default bitwise copy construction. More...
virtual	~limitVelocity ()
	Destructor. More...
virtual wordList	constrainedFields () const
	Return the list of fields constrained by the fvConstraint. More...
virtual bool	constrain (volVectorField &U) const
	Constrain the velocity field. More...
virtual void	updateMesh (const mapPolyMesh &)
	Update for mesh changes. More...
virtual bool	read (const dictionary &dict)
	Read dictionary. More...
void	operator= (const limitVelocity &)=delete
	Disallow default bitwise assignment. More...
Public Member Functions inherited from fvConstraint
	TypeName ("fvConstraint")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, fvConstraint, dictionary,(const word &name, const word &constraintType, const dictionary &dict, const fvMesh &mesh),(name, constraintType, dict, mesh))
	fvConstraint (const word &name, const word &constraintType, const dictionary &dict, const fvMesh &mesh)
	Construct from components. More...
autoPtr< fvConstraint >	clone () const
	Return clone. More...
virtual	~fvConstraint ()
	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...
virtual bool	constrainsField (const word &fieldName) const
	Return true if the given field is constrained. More...
	FOR_ALL_FIELD_TYPES (DEFINE_FV_CONSTRAINT_CONSTRAIN)
	Apply a constraint to an equation. More...
	FOR_ALL_FIELD_TYPES (DEFINE_FV_CONSTRAINT_CONSTRAIN_FIELD)
	Apply contraint to a field. More...
virtual bool	movePoints ()
	Update for mesh motion. More...

Additional Inherited Members
Static Public Member Functions inherited from fvConstraint
static autoPtr< fvConstraint >	New (const word &name, const dictionary &dict, const fvMesh &mesh)
	Return a reference to the selected fvConstraint. More...

Detailed Description

Limits the velocity magnitude to the specified max value.

Usage

Example usage:

limitU
{
    type            limitVelocity;

    selectionMode   all;

    max             100;
}

Source files

• limitVelocity.H
• limitVelocity.C

Definition at line 64 of file limitVelocity.H.

Constructor & Destructor Documentation

limitVelocity() [1/2]

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

Construct from components.

Definition at line 59 of file limitVelocity.C.

limitVelocity() [2/2]

limitVelocity ( const limitVelocity &  )

delete

Disallow default bitwise copy construction.

~limitVelocity()

virtual ~limitVelocity ( )

inlinevirtual

Destructor.

Definition at line 108 of file limitVelocity.H.

References limitVelocity::constrain(), limitVelocity::constrainedFields(), limitVelocity::operator=(), limitVelocity::read(), U, and limitVelocity::updateMesh().

Here is the call graph for this function:

Member Function Documentation

TypeName()

TypeName

(

"limitVelocity"

)

Runtime type information.

constrainedFields()

Foam::wordList constrainedFields ( ) const

virtual

Return the list of fields constrained by the fvConstraint.

Reimplemented from fvConstraint.

Definition at line 77 of file limitVelocity.C.

Referenced by limitVelocity::~limitVelocity().

Here is the caller graph for this function:

constrain()

bool constrain ( volVectorField &  U ) const

virtual

Constrain the velocity field.

Definition at line 83 of file limitVelocity.C.

References fvCellSet::all, GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), cells, fvPatchField< Type >::fixesValue(), forAll, Foam::magSqr(), patchi, GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), List< T >::size(), Foam::sqr(), and Foam::sqrt().

Referenced by limitVelocity::~limitVelocity().

Here is the call graph for this function:

Here is the caller graph for this function:

updateMesh()

void updateMesh ( const mapPolyMesh &  mpm )

virtual

Update for mesh changes.

Reimplemented from fvConstraint.

Definition at line 131 of file limitVelocity.C.

Referenced by limitVelocity::~limitVelocity().

Here is the caller graph for this function:

read()

bool read ( const dictionary &  dict )

virtual

Read dictionary.

Reimplemented from fvConstraint.

Definition at line 137 of file limitVelocity.C.

References fvConstraint::read().

Referenced by limitVelocity::~limitVelocity().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

void operator= ( const limitVelocity &  )

delete

Disallow default bitwise assignment.

Referenced by limitVelocity::~limitVelocity().

Here is the caller graph for this function:

---

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

• src/fvConstraints/limitVelocity/limitVelocity.H
• src/fvConstraints/limitVelocity/limitVelocity.C