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")
	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
	No copy construct. More...

void	operator= (const limitVelocity &)=delete
	No copy assignment. More...

virtual	~limitVelocity ()=default
	Destructor. More...

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

virtual void	correct (volVectorField &U)
	Correct the velocity field. 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 ()=default
	Destructor. More...

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

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

bool	inTimeLimits (const scalar timeValue) const
	True if within time limits. More...

bool	useSubMesh () const noexcept
	True if sub-selection should be used. More...

selectionModeType	selectionMode () const noexcept
	Return the cell selection mode. More...

const wordRes &	selectionNames () const noexcept
	Return const access to the selection names (set or zone selection) More...

const wordRe &	zoneName () const
	Return const access to the first set/zone name. More...

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

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

bool	isSelectionUpdated () const noexcept
	Return flag for selection updates. More...

scalar	timeStart (scalar val) noexcept
	Adjust the time start, return the old value. More...

scalar	duration (scalar val) noexcept
	Adjust the duration, return the old value. More...

virtual bool	isActive ()
	Is the source active? More...

const word &	cellSetName () const
	The name of the cell set/zone [as a word] for "cellSet" / "cellZone" selection modes) 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 ()=default
	Destructor. More...

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

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

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

bool	active () const noexcept
	True if source is active. More...

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

bool	active (const bool on) noexcept
	Change source active flag, return previous value. 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< 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	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. More...

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

virtual void	writeData (Ostream &) const
	Write the source properties. More...

Public Member Functions inherited from writeFile
	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name="undefined", const bool writeToFile=true)
	Construct from objectRegistry, prefix, fileName. More...

	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name, const dictionary &dict, const bool writeToFile=true)
	Construct from objectRegistry, prefix, fileName and read options from dictionary. More...

	writeFile (const writeFile &wf)
	Construct copy. More...

virtual	~writeFile ()=default
	Destructor. More...

virtual OFstream &	file ()
	Return access to the file (if only 1) More...

virtual bool	writeToFile () const
	Flag to allow writing to file. More...

virtual bool	canWriteToFile () const
	Flag to allow writing to the file. More...

virtual bool	canResetFile () const
	Flag to allow resetting the file. More...

virtual bool	canWriteHeader () const
	Flag to allow writing the header. More...

virtual label	charWidth () const
	Return width of character stream output. More...

virtual void	writeCommented (Ostream &os, const string &str) const
	Write a commented string to stream. More...

virtual void	writeTabbed (Ostream &os, const string &str) const
	Write a tabbed string to stream. More...

virtual void	writeHeader (Ostream &os, const string &str) const
	Write a commented header to stream. More...

virtual void	writeCurrentTime (Ostream &os) const
	Write the current time to stream. More...

virtual void	writeBreak (Ostream &os) const
	Write a break marker to the stream. More...

template<class Type >
void	writeHeaderValue (Ostream &os, const string &property, const Type &value) const
	Write a (commented) header property and value pair. More...

template<class Type >
void	writeValue (Ostream &os, const Type &val) const
	Write a given value to stream with the space delimiter. More...

Protected Member Functions
void	writeFileHeader (Ostream &os)
	Write file header information. More...

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

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

void	setVol ()
	Recalculate the volume. More...

Protected Member Functions inherited from option
void	resetApplied ()
	Resize/reset applied flag list for all fieldNames_ entries. More...

Protected Member Functions inherited from writeFile
void	initStream (Ostream &os) const
	Initialise the output stream for writing. More...

fileName	baseFileDir () const
	Return the base directory for output. More...

fileName	baseTimeDir () const
	Return the base directory for the current time value. More...

fileName	filePath (const fileName &fName) const
	Return the full path for the supplied file name. More...

virtual autoPtr< OFstream >	newFile (const fileName &fName) const
	Return autoPtr to a new file using file name. More...

virtual autoPtr< OFstream >	newFileAtTime (const word &name, scalar timeValue) const
	Return autoPtr to a new file for a given time. More...

virtual autoPtr< OFstream >	newFileAtStartTime (const word &name) const
	Return autoPtr to a new file using the simulation start time. More...

virtual void	resetFile (const word &name)
	Reset internal file pointer to new file with new name. More...

Omanip< int >	valueWidth (const label offset=0) const
	Return the value width when writing to stream with optional offset. More...

void	operator= (const writeFile &)=delete
	No copy assignment. More...

virtual autoPtr< OFstream >	createFile (const word &name, scalar timeValue) const
	Deprecated(2022-09) Return autoPtr to a new file for a given time. More...

virtual autoPtr< OFstream >	createFile (const word &name) const
	Deprecated(2022-09) Return autoPtr to a new file using the simulation start time. More...

Protected Attributes
word	UName_
	Name of operand velocity field. More...

scalar	max_
	Maximum velocity magnitude. More...

Protected Attributes inherited from cellSetOption
selectionModeType	selectionMode_
	Cell selection mode. More...

bool	updateSelection_
	Flag to enable dictionary-based updates of selections. More...

scalar	timeStart_
	Start time of fvOption. More...

scalar	duration_
	Duration of fvOption execution starting from timeStart. More...

wordRes	selectionNames_
	Face selection names (for set or zone selections) More...

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

PtrList< Function1< point > >	movingPoints_
	List of points for "movingPoints" selectionMode. More...

dictionary	geometricSelection_
	Dictionary entries for "geometric" (topoSetCellSource) selection. 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...

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...

bool	active_
	Source active flag. More...

Protected Attributes inherited from writeFile
const objectRegistry &	fileObr_
	Reference to the region objectRegistry. More...

const fileName	prefix_
	Prefix. More...

word	fileName_
	Name of file. More...

autoPtr< OFstream >	filePtr_
	File pointer. More...

label	writePrecision_
	Write precision. More...

bool	writeToFile_
	Flag to enable/disable writing to file. More...

bool	updateHeader_
	Flag to update the header, e.g. on mesh changes. Default is true. More...

bool	writtenHeader_
	Flag to identify whether the header has been written. More...

bool	useUserTime_
	Flag to use the specified user time, e.g. CA deg instead of seconds. Default = true. More...

scalar	startTime_
	Start time value. More...

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. More...

Public Attributes inherited from option
bool	log
	Switch write log to Info. More...

Static Public Attributes inherited from cellSetOption
static const Enum< selectionModeType >	selectionModeTypeNames_
	List of selection mode type names. More...

Static Public Attributes inherited from writeFile
static label	addChars = 8
	Additional characters for writing. More...

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 120 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 58 of file limitVelocity.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ limitVelocity() [2/2]

limitVelocity ( const limitVelocity & )

delete

No copy construct.

◆ ~limitVelocity()

virtual ~limitVelocity ( )

virtualdefault

Destructor.

Member Function Documentation

◆ writeFileHeader()

void writeFileHeader ( Ostream & os )

protected

Write file header information.

Definition at line 40 of file limitVelocity.C.

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

Here is the call graph for this function:

◆ TypeName()

TypeName ( "limitVelocity" )

Runtime type information.

◆ operator=()

void operator= ( const limitVelocity & )

delete

No copy assignment.

◆ read()

bool read ( const dictionary & dict )

virtual

Read dictionary.

Reimplemented from cellSetOption.

Definition at line 76 of file limitVelocity.C.

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

Here is the call graph for this function:

◆ correct()

void correct ( volVectorField & U )

virtual

Correct the velocity field.

Reimplemented from option.

Definition at line 107 of file limitVelocity.C.

References Foam::constant::electromagnetic::e, Foam::endl(), Foam::Info, Foam::magSqr(), Foam::reduce(), Foam::returnReduce(), Foam::sqr(), Foam::sqrt(), token::TAB, Foam::type(), U, and cellSetOption::useSubMesh().

Here is the call graph for this function:

Member Data Documentation

◆ UName_

word UName_

protected

Name of operand velocity field.

Definition at line 132 of file limitVelocity.H.

◆ max_

scalar max_

protected

Maximum velocity magnitude.

Definition at line 137 of file limitVelocity.H.

Referenced by limitVelocity::writeFileHeader().

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

src/fvOptions/corrections/limitVelocity/limitVelocity.H
src/fvOptions/corrections/limitVelocity/limitVelocity.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ limitVelocity() [1/2]

◆ limitVelocity() [2/2]

◆ ~limitVelocity()

Member Function Documentation

◆ writeFileHeader()

◆ TypeName()

◆ operator=()

◆ read()

◆ correct()

Member Data Documentation

◆ UName_

◆ max_