This velocity inlet/outlet boundary condition is applied to velocity boundaries where the pressure is specified. A zero-gradient condition is applied for outflow (as defined by the flux); for inflow, the velocity is obtained from the patch-face normal component of the internal-cell value. More...

#include <pressureInletOutletVelocityFvPatchVectorField.H>

Inheritance diagram for pressureInletOutletVelocityFvPatchVectorField:

[legend]

Collaboration diagram for pressureInletOutletVelocityFvPatchVectorField:

[legend]

Public Member Functions
	TypeName ("pressureInletOutletVelocity")
	Runtime type information.
	pressureInletOutletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
	Construct from patch and internal field.
	pressureInletOutletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	pressureInletOutletVelocityFvPatchVectorField (const pressureInletOutletVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given.
	pressureInletOutletVelocityFvPatchVectorField (const pressureInletOutletVelocityFvPatchVectorField &)
	Construct as copy.
	pressureInletOutletVelocityFvPatchVectorField (const pressureInletOutletVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
	Construct as copy setting internal field reference.
virtual tmp< fvPatchField< vector > >	clone () const
	Return a clone.
virtual tmp< fvPatchField< vector > >	clone (const DimensionedField< vector, volMesh > &iF) const
	Clone with an internal field reference.
virtual bool	assignable () const
	True: this patch field is altered by assignment.
const word &	phiName () const
	Return the name of phi.
word &	phiName ()
	Return reference to the name of phi to allow adjustment.
const vectorField &	tangentialVelocity () const
	Return the tangential velocity.
void	setTangentialVelocity (const vectorField &tangentialVelocity)
	Reset the tangential velocity.
virtual void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object.
virtual void	rmap (const fvPatchVectorField &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField.
virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field.
virtual void	write (Ostream &) const
	Write.
virtual void	operator= (const fvPatchField< vector > &pvf)

Detailed Description

This velocity inlet/outlet boundary condition is applied to velocity boundaries where the pressure is specified. A zero-gradient condition is applied for outflow (as defined by the flux); for inflow, the velocity is obtained from the patch-face normal component of the internal-cell value.

The tangential patch velocity can be optionally specified.

Usage

Property	Description	Required	Default value
`phi`	flux field name	no	phi
`tangentialVelocity`	tangential velocity field	no

Example of the boundary condition specification:

    <patchName>
    {
        type            pressureInletOutletVelocity;
        phi             phi;
        tangentialVelocity uniform (0 0 0);
        value           uniform (0 0 0);
    }

Note

Sign conventions:

positive flux (out of domain): apply zero-gradient condition
negative flux (into of domain): derive from the flux in the patch-normal direction

Source files

Definition at line 94 of file pressureInletOutletVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ pressureInletOutletVelocityFvPatchVectorField() [1/5]

pressureInletOutletVelocityFvPatchVectorField	(	const fvPatch &	p,
		const DimensionedField< vector, volMesh > &	iF )

Construct from patch and internal field.

Definition at line 30 of file pressureInletOutletVelocityFvPatchVectorField.C.

References p, and Foam::Zero.

Here is the caller graph for this function:

◆ pressureInletOutletVelocityFvPatchVectorField() [2/5]

pressureInletOutletVelocityFvPatchVectorField	(	const fvPatch &	p,
		const DimensionedField< vector, volMesh > &	iF,
		const dictionary &	dict )

Construct from patch, internal field and dictionary.

Definition at line 65 of file pressureInletOutletVelocityFvPatchVectorField.C.

References dict, IOobjectOption::MUST_READ, p, fvPatchFieldBase::readDict(), setTangentialVelocity(), and Foam::Zero.

Here is the call graph for this function:

◆ pressureInletOutletVelocityFvPatchVectorField() [3/5]

pressureInletOutletVelocityFvPatchVectorField	(	const pressureInletOutletVelocityFvPatchVectorField &	ptf,
		const fvPatch &	p,
		const DimensionedField< vector, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper )

Construct by mapping given.

pressureInletOutletVelocityFvPatchVectorField onto a new patch

Definition at line 46 of file pressureInletOutletVelocityFvPatchVectorField.C.

References p, pressureInletOutletVelocityFvPatchVectorField(), and UList< T >::size().

Here is the call graph for this function:

◆ pressureInletOutletVelocityFvPatchVectorField() [4/5]

pressureInletOutletVelocityFvPatchVectorField ( const pressureInletOutletVelocityFvPatchVectorField & pivpvf )

Construct as copy.

Definition at line 96 of file pressureInletOutletVelocityFvPatchVectorField.C.

References pressureInletOutletVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ pressureInletOutletVelocityFvPatchVectorField() [5/5]

pressureInletOutletVelocityFvPatchVectorField	(	const pressureInletOutletVelocityFvPatchVectorField &	pivpvf,
		const DimensionedField< vector, volMesh > &	iF )

Construct as copy setting internal field reference.

Definition at line 108 of file pressureInletOutletVelocityFvPatchVectorField.C.

References pressureInletOutletVelocityFvPatchVectorField().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "pressureInletOutletVelocity" )

Runtime type information.

References pressureInletOutletVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ clone() [1/2]

virtual tmp< fvPatchField< vector > > clone ( ) const

inlinevirtual

Return a clone.

Reimplemented in rotatingPressureInletOutletVelocityFvPatchVectorField.

Definition at line 173 of file pressureInletOutletVelocityFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ clone() [2/2]

virtual tmp< fvPatchField< vector > > clone ( const DimensionedField< vector, volMesh > & iF ) const

inlinevirtual

Clone with an internal field reference.

Reimplemented in rotatingPressureInletOutletVelocityFvPatchVectorField.

Definition at line 181 of file pressureInletOutletVelocityFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ assignable()

virtual bool assignable ( ) const

inlinevirtual

True: this patch field is altered by assignment.

Definition at line 195 of file pressureInletOutletVelocityFvPatchVectorField.H.

◆ phiName() [1/2]

const word & phiName ( ) const

inline

Return the name of phi.

Definition at line 203 of file pressureInletOutletVelocityFvPatchVectorField.H.

Referenced by rotatingPressureInletOutletVelocityFvPatchVectorField::write().

Here is the caller graph for this function:

◆ phiName() [2/2]

word & phiName ( )

inline

Return reference to the name of phi to allow adjustment.

Definition at line 211 of file pressureInletOutletVelocityFvPatchVectorField.H.

◆ tangentialVelocity()

const vectorField & tangentialVelocity ( ) const

inline

Return the tangential velocity.

Definition at line 219 of file pressureInletOutletVelocityFvPatchVectorField.H.

Referenced by setTangentialVelocity().

Here is the caller graph for this function:

◆ setTangentialVelocity()

void setTangentialVelocity ( const vectorField & tangentialVelocity )

Reset the tangential velocity.

Definition at line 123 of file pressureInletOutletVelocityFvPatchVectorField.C.

References n, and tangentialVelocity().

Referenced by pressureInletOutletVelocityFvPatchVectorField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m )

virtual

Map (and resize as needed) from self given a mapping object.

Definition at line 132 of file pressureInletOutletVelocityFvPatchVectorField.C.

◆ rmap()

void rmap	(	const fvPatchVectorField &	ptf,
		const labelList &	addr )

virtual

Reverse map the given fvPatchField onto this fvPatchField.

Definition at line 145 of file pressureInletOutletVelocityFvPatchVectorField.C.

References pressureInletOutletVelocityFvPatchVectorField(), and Foam::refCast().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 163 of file pressureInletOutletVelocityFvPatchVectorField.C.

References Foam::I, Foam::neg(), and Foam::sqr().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented in rotatingPressureInletOutletVelocityFvPatchVectorField.

Definition at line 180 of file pressureInletOutletVelocityFvPatchVectorField.C.

References os(), fvPatchField< Type >::write(), and fvPatchField< Type >::writeValueEntry().

Here is the call graph for this function:

◆ operator=()

void operator= ( const fvPatchField< vector > & pvf )

virtual

Definition at line 198 of file pressureInletOutletVelocityFvPatchVectorField.C.

References Foam::I, fvPatchField< Type >::operator=(), and Foam::transform().

Here is the call graph for this function:

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

src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H
src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.C

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ pressureInletOutletVelocityFvPatchVectorField() [1/5]

◆ pressureInletOutletVelocityFvPatchVectorField() [2/5]

◆ pressureInletOutletVelocityFvPatchVectorField() [3/5]

◆ pressureInletOutletVelocityFvPatchVectorField() [4/5]

◆ pressureInletOutletVelocityFvPatchVectorField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ assignable()

◆ phiName() [1/2]

◆ phiName() [2/2]

◆ tangentialVelocity()

◆ setTangentialVelocity()

◆ autoMap()

◆ rmap()

◆ updateCoeffs()

◆ write()

◆ operator=()