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

#include <velocityDampingConstraint.H>

Inheritance diagram for velocityDampingConstraint:

[legend]

Collaboration diagram for velocityDampingConstraint:

[legend]

Public Member Functions
	TypeName ("velocityDampingConstraint")
	Runtime type information.
	velocityDampingConstraint (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components.
	velocityDampingConstraint (const velocityDampingConstraint &)=delete
	No copy construct.
void	operator= (const velocityDampingConstraint &)=delete
	No copy assignment.
virtual	~velocityDampingConstraint ()=default
	Destructor.
virtual void	constrain (fvMatrix< vector > &eqn, const label fieldi)
	Constrain vector matrix.
virtual void	writeData (Ostream &os) const
	Write data.
virtual bool	read (const dictionary &dict)
	Read dictionary.
Public Member Functions inherited from cellSetOption
	TypeName ("cellSetOption")
	Runtime type information.
	cellSetOption (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components.
virtual	~cellSetOption ()=default
	Destructor.
scalar	timeStart () const noexcept
	Return const access to the time start.
scalar	duration () const noexcept
	Return const access to the duration.
bool	inTimeLimits (const scalar timeValue) const
	True if within time limits.
bool	useSubMesh () const noexcept
	True if sub-selection should be used.
selectionModeType	selectionMode () const noexcept
	Return the cell selection mode.
const wordRes &	selectionNames () const noexcept
	Return const access to the selection names (set or zone selection).
const wordRe &	zoneName () const
	Return const access to the first set/zone name.
scalar	V () const noexcept
	Return const access to the total cell volume.
const labelList &	cells () const noexcept
	Return const access to the cell selection.
bool	isSelectionUpdated () const noexcept
	Return flag for selection updates.
scalar	timeStart (scalar val) noexcept
	Adjust the time start, return the old value.
scalar	duration (scalar val) noexcept
	Adjust the duration, return the old value.
virtual bool	isActive ()
	Is the source active?
const word &	cellSetName () const
	The name of the cell set/zone [as a word] for "cellSet" / "cellZone" selection modes).
Public Member Functions inherited from option
	TypeName ("option")
	Runtime type information.
	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.
autoPtr< option >	clone () const
	Return clone.
virtual	~option ()=default
	Destructor.
const word &	name () const noexcept
	Return const access to the source name.
const fvMesh &	mesh () const noexcept
	Return const access to the mesh database.
const dictionary &	coeffs () const noexcept
	Return dictionary.
bool	active () const noexcept
	True if source is active.
void	setApplied (const label fieldi)
	Set the applied flag to true for field index fieldi.
bool	active (const bool on) noexcept
	Change source active flag, return previous value.
virtual label	applyToField (const word &fieldName) const
	Return index of field name if found in fieldNames list.
virtual void	checkApplied () const
	Check that the source has been applied.
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	correct (surfaceScalarField &field)
virtual void	correct (surfaceVectorField &field)
virtual void	correct (surfaceTensorField &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	postProcessAuxSens (const volScalarField &primalField, const volScalarField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void	postProcessAuxSens (const volVectorField &primalField, const volVectorField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void	postProcessAuxSens (const volTensorField &primalField, const volTensorField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void	writeHeader (Ostream &) const
	Write the source header information.
virtual void	writeFooter (Ostream &) const
	Write the source footer information.
Public Member Functions inherited from writeFile
	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name="undefined", const bool writeToFile=true, const string &ext=".dat")
	Construct from objectRegistry, prefix, fileName.
	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name, const dictionary &dict, const bool writeToFile=true, const string &ext=".dat")
	Construct from objectRegistry, prefix, fileName and read options from dictionary.
	writeFile (const writeFile &wf)
	Construct copy.
virtual	~writeFile ()=default
	Destructor.
virtual const string &	setExt (const string &ext)
	Set extension.
virtual OFstream &	file ()
	Return access to the file (if only 1).
virtual bool	writeToFile () const
	Flag to allow writing to file.
virtual bool	canWriteToFile () const
	Flag to allow writing to the file.
virtual bool	canResetFile () const
	Flag to allow resetting the file.
virtual bool	canWriteHeader () const
	Flag to allow writing the header.
virtual label	charWidth () const
	Return width of character stream output.
virtual void	writeCommented (Ostream &os, const string &str) const
	Write a commented string to stream.
virtual void	writeTabbed (Ostream &os, const string &str) const
	Write a tabbed string to stream.
virtual void	writeHeader (Ostream &os, const string &str) const
	Write a commented header to stream.
virtual void	writeCurrentTime (Ostream &os) const
	Write the current time to stream.
virtual void	writeBreak (Ostream &os) const
	Write a break marker to the stream.
template<class Type>
void	writeHeaderValue (Ostream &os, const string &property, const Type &value) const
	Write a (commented) header property and value pair.
template<class Type>
void	writeValue (Ostream &os, const Type &val) const
	Write a given value to stream with the space delimiter.

Protected Member Functions
void	addDamping (fvMatrix< vector > &eqn)
	Constrain the given velocity fields by a given maximum value.
void	writeFileHeader (Ostream &os)
	Write file header information.
Protected Member Functions inherited from cellSetOption
void	setSelection (const dictionary &dict)
	Set cell selection name or points selection from dictionary input.
void	setCellSelection ()
	Set the cell selection based on user input selection mode.
void	setVol ()
	Recalculate the volume.
Protected Member Functions inherited from option
void	resetApplied ()
	Resize/reset applied flag list for all fieldNames_ entries.
Protected Member Functions inherited from writeFile
void	initStream (Ostream &os) const
	Initialise the output stream for writing.
fileName	baseFileDir () const
	Return the base directory for output.
fileName	baseTimeDir () const
	Return the base directory for the current time value.
fileName	filePath (const fileName &fName) const
	Return the full path for the supplied file name.
virtual autoPtr< OFstream >	newFile (const fileName &fName) const
	Return autoPtr to a new file using file name.
virtual autoPtr< OFstream >	newFileAtTime (const word &name, scalar timeValue) const
	Return autoPtr to a new file for a given time.
virtual autoPtr< OFstream >	newFileAtStartTime (const word &name) const
	Return autoPtr to a new file using the simulation start time.
virtual void	resetFile (const word &name)
	Reset internal file pointer to new file with new name.
Omanip< int >	valueWidth (const label offset=0) const
	Return the value width when writing to stream with optional offset.
void	operator= (const writeFile &)=delete
	No copy assignment.
virtual autoPtr< OFstream >	createFile (const word &name, scalar timeValue) const
	Deprecated(2022-09) Return autoPtr to a new file for a given time.
virtual autoPtr< OFstream >	createFile (const word &name) const
	Deprecated(2022-09) Return autoPtr to a new file using the simulation start time.

Protected Attributes
scalar	UMax_
	Maximum velocity magnitude.
scalar	C_
	Model factor.
Protected Attributes inherited from cellSetOption
selectionModeType	selectionMode_
	Cell selection mode.
bool	updateSelection_
	Flag to enable dictionary-based updates of selections.
scalar	timeStart_
	Start time of fvOption.
scalar	duration_
	Duration of fvOption execution starting from timeStart.
wordRes	selectionNames_
	Face selection names (for set or zone selections).
List< point >	points_
	List of points for "points" selectionMode.
PtrList< Function1< point > >	movingPoints_
	List of points for "movingPoints" selectionMode.
dictionary	geometricSelection_
	Dictionary entries for "geometric" (topoSetCellSource) selection.
labelList	cells_
	Set of cells to apply source to.
scalar	V_
	Sum of cell volumes.
Protected Attributes inherited from option
const word	name_
	Source name.
const word	modelType_
	Model type.
const fvMesh &	mesh_
	Reference to the mesh database.
dictionary	dict_
	Top level source dictionary.
dictionary	coeffs_
	Dictionary containing source coefficients.
wordList	fieldNames_
	Field names to apply source to - populated by derived models.
List< bool >	applied_
	Applied flag list - corresponds to each fieldNames_ entry.
bool	active_
	Source active flag.
Protected Attributes inherited from writeFile
const objectRegistry &	fileObr_
	Reference to the region objectRegistry.
const fileName	prefix_
	Prefix.
word	fileName_
	Name of file.
autoPtr< OFstream >	filePtr_
	File pointer.
label	writePrecision_
	Write precision.
bool	writeToFile_
	Flag to enable/disable writing to file.
bool	updateHeader_
	Flag to update the header, e.g. on mesh changes. Default is true.
bool	writtenHeader_
	Flag to identify whether the header has been written.
bool	useUserTime_
	Flag to use the specified user time, e.g. CA deg instead of seconds. Default = true.
scalar	startTime_
	Start time value.
string	ext_
	File extension; default = .dat.

Additional Inherited Members
Public Types inherited from cellSetOption
enum	selectionModeType : char { smAll , smCellSet , smCellZone , smPoints , smMovingPoints , smGeometric , smCellType }
	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.
Public Attributes inherited from option
bool	log
	Switch write log to Info.
Static Public Attributes inherited from cellSetOption
static const Enum< selectionModeType >	selectionModeTypeNames_
	List of selection mode type names.
Static Public Attributes inherited from writeFile
static label	addChars = 8
	Additional characters for writing.

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>);
    C               <scalar>;

    // 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
`C`	Model factor	scalar	no	1

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 154 of file velocityDampingConstraint.H.

Constructor & Destructor Documentation

◆ velocityDampingConstraint() [1/2]

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

Construct from components.

Definition at line 119 of file velocityDampingConstraint.C.

References C_, cellSetOption::cellSetOption(), dict, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, option::mesh(), option::name(), read(), UMax_, and writeFile::writeFile().

Referenced by operator=(), and velocityDampingConstraint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ velocityDampingConstraint() [2/2]

velocityDampingConstraint ( const velocityDampingConstraint & )

delete

No copy construct.

References velocityDampingConstraint().

Here is the call graph for this function:

◆ ~velocityDampingConstraint()

virtual ~velocityDampingConstraint ( )

virtualdefault

Destructor.

References dict, and os().

Here is the call graph for this function:

Member Function Documentation

◆ addDamping()

void addDamping ( fvMatrix< vector > & eqn )

protected

Constrain the given velocity fields by a given maximum value.

Definition at line 47 of file velocityDampingConstraint.C.

References C_, writeFile::canWriteToFile(), Foam::cbrt(), cellSetOption::cells_, Foam::diag(), lduMatrix::diag(), e, Foam::endl(), writeFile::file(), Foam::Info, Foam::mag(), option::mesh_, option::name_, fvMatrix< Type >::psi(), Foam::reduce(), Foam::returnReduce(), Foam::sqr(), token::TAB, Foam::type(), U, and UMax_.

Referenced by constrain().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeFileHeader()

void writeFileHeader ( Ostream & os )

protected

Write file header information.

Definition at line 104 of file velocityDampingConstraint.C.

References Foam::endl(), Foam::name(), os(), UMax_, writeFile::writeCommented(), writeFile::writeHeaderValue(), writeFile::writeTabbed(), and writeFile::writtenHeader_.

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "velocityDampingConstraint" )

Runtime type information.

References dict, option::mesh(), and option::name().

Here is the call graph for this function:

◆ operator=()

void operator= ( const velocityDampingConstraint & )

delete

No copy assignment.

References velocityDampingConstraint().

Here is the call graph for this function:

◆ constrain()

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

virtual

Constrain vector matrix.

Reimplemented from option.

Definition at line 138 of file velocityDampingConstraint.C.

References addDamping().

Here is the call graph for this function:

◆ writeData()

void writeData ( Ostream & os ) const

virtual

Write data.

Reimplemented from option.

Definition at line 148 of file velocityDampingConstraint.C.

References option::dict_, option::name_, and os().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read dictionary.

Reimplemented from cellSetOption.

Definition at line 154 of file velocityDampingConstraint.C.

References C_, writeFile::canResetFile(), writeFile::canWriteHeader(), option::coeffs_, dict, option::fieldNames_, writeFile::file(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, cellSetOption::read(), option::resetApplied(), writeFile::resetFile(), UMax_, and writeFileHeader().

Referenced by velocityDampingConstraint().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ UMax_

scalar UMax_

protected

Maximum velocity magnitude.

Definition at line 166 of file velocityDampingConstraint.H.

Referenced by addDamping(), read(), velocityDampingConstraint(), and writeFileHeader().

◆ C_

scalar C_

protected

Model factor.

Definition at line 171 of file velocityDampingConstraint.H.

Referenced by addDamping(), read(), and velocityDampingConstraint().

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()

◆ writeFileHeader()

◆ TypeName()

◆ operator=()

◆ constrain()

◆ writeData()

◆ read()

Member Data Documentation

◆ UMax_

◆ C_