Applies the force over the specified patch to maintain the specified mean velocity for incompressible flows. More...

#include <patchMeanVelocityForce.H>

Inheritance diagram for patchMeanVelocityForce:

Collaboration diagram for patchMeanVelocityForce:

[legend]

Public Member Functions
	TypeName ("patchMeanVelocityForce")
	Runtime type information.
	patchMeanVelocityForce (const word &sourceName, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from explicit source name and mesh.
	patchMeanVelocityForce (const patchMeanVelocityForce &)=delete
	No copy construct.
void	operator= (const patchMeanVelocityForce &)=delete
	No copy assignment.
	~patchMeanVelocityForce ()=default
	Destructor.
Public Member Functions inherited from meanVelocityForce
	TypeName ("meanVelocityForce")
	Runtime type information.
	meanVelocityForce (const word &sourceName, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from explicit source name and mesh.
	meanVelocityForce (const meanVelocityForce &)=delete
	No copy construct.
void	operator= (const meanVelocityForce &)=delete
	No copy assignment.
virtual	~meanVelocityForce ()=default
	Destructor.
virtual void	correct (volVectorField &U)
	Correct the pressure gradient.
virtual void	addSup (fvMatrix< vector > &eqn, const label fieldi)
	Add explicit contribution to momentum equation.
virtual void	addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)
	Add explicit contribution to compressible momentum equation.
virtual void	constrain (fvMatrix< vector > &eqn, const label fieldi)
	Set 1/A coefficient.
virtual bool	read (const dictionary &dict)
	Read source 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< 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< 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 (volTensorField &field)
virtual void	correct (surfaceScalarField &field)
virtual void	correct (surfaceVectorField &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.
virtual void	writeData (Ostream &) const
	Write the source properties.

Protected Member Functions
virtual scalar	magUbarAve (const volVectorField &U) const
	Calculate and return the magnitude of the mean velocity averaged over the specified patch.
Protected Member Functions inherited from meanVelocityForce
void	writeProps (const scalar gradP) const
	Write the pressure gradient to file (for restarts etc).
void	update (fvMatrix< vector > &eqn)
	Correct driving force for a constant mass flow rate.
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 Attributes
word	patch_
	Name of operand patch.
label	patchi_
	Patch index.
Protected Attributes inherited from meanVelocityForce
vector	Ubar_
	Desired mean velocity.
scalar	gradP0_
	Pressure gradient before correction.
scalar	dGradP_
	Change in pressure gradient.
vector	flowDir_
	Flow direction.
scalar	relaxation_
	Relaxation factor.
autoPtr< volScalarField >	rAPtr_
	Matrix 1/A coefficients field pointer.
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.

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.

Detailed Description

Applies the force over the specified patch to maintain the specified mean velocity for incompressible flows.

Sources applied to:

  U         | Velocity                                   [m/s]

Required fields:

  U         | Velocity                                   [m/s]

Usage

Minimal example by using constant/fvOptions:

patchMeanVelocityForce1
{
    // Mandatory entries (unmodifiable)
    type                 patchMeanVelocityForce;
    patch                <patchName>;

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

where the entries mean:

Property	Description	Type	Reqd	Dflt
`type`	Type name: patchMeanVelocityForce	word	yes	-
`patch`	Name of operand patch	word	yes	-

The inherited entries are elaborated in:

meanVelocityForce.H

See also

Foam::fv::meanVelocityForce

Source files

Definition at line 105 of file patchMeanVelocityForce.H.

Constructor & Destructor Documentation

◆ patchMeanVelocityForce() [1/2]

patchMeanVelocityForce	(	const word &	sourceName,
		const word &	modelType,
		const dictionary &	dict,
		const fvMesh &	mesh )

Construct from explicit source name and mesh.

Definition at line 40 of file patchMeanVelocityForce.C.

References option::coeffs_, dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, meanVelocityForce::meanVelocityForce(), option::mesh(), patch_, and patchi_.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ patchMeanVelocityForce() [2/2]

patchMeanVelocityForce ( const patchMeanVelocityForce & )

delete

No copy construct.

References patchMeanVelocityForce().

Here is the call graph for this function:

◆ ~patchMeanVelocityForce()

~patchMeanVelocityForce ( )

default

Destructor.

Member Function Documentation

◆ magUbarAve()

Foam::scalar magUbarAve ( const volVectorField & U ) const

protectedvirtual

Calculate and return the magnitude of the mean velocity averaged over the specified patch.

Reimplemented from meanVelocityForce.

Definition at line 63 of file patchMeanVelocityForce.C.

References meanVelocityForce::flowDir_, Foam::isA(), option::mesh_, UPstream::parRun(), patch_, patches, patchi_, processorCyclicPolyPatch::patchIDs(), Foam::stabilise(), Foam::sum(), U, and Foam::Zero.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "patchMeanVelocityForce" )

Runtime type information.

References dict, and option::mesh().

Here is the call graph for this function:

◆ operator=()

void operator= ( const patchMeanVelocityForce & )

delete

No copy assignment.

References patchMeanVelocityForce().

Here is the call graph for this function:

Member Data Documentation

◆ patch_

word patch_

protected

Name of operand patch.

Definition at line 116 of file patchMeanVelocityForce.H.

Referenced by magUbarAve(), and patchMeanVelocityForce().

◆ patchi_

label patchi_

protected

Patch index.

Definition at line 121 of file patchMeanVelocityForce.H.

Referenced by magUbarAve(), and patchMeanVelocityForce().

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

src/fvOptions/sources/derived/meanVelocityForce/patchMeanVelocityForce/patchMeanVelocityForce.H
src/fvOptions/sources/derived/meanVelocityForce/patchMeanVelocityForce/patchMeanVelocityForce.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ patchMeanVelocityForce() [1/2]

◆ patchMeanVelocityForce() [2/2]

◆ ~patchMeanVelocityForce()

Member Function Documentation

◆ magUbarAve()

◆ TypeName()

◆ operator=()

Member Data Documentation

◆ patch_

◆ patchi_