pressureInletOutletVelocityFvPatchVectorField Class Reference

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

Inheritance diagram for pressureInletOutletVelocityFvPatchVectorField:
Collaboration diagram for pressureInletOutletVelocityFvPatchVectorField:

Public Member Functions

 TypeName ("pressureInletOutletVelocity")
 Runtime type information. More...
 
 pressureInletOutletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 pressureInletOutletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 pressureInletOutletVelocityFvPatchVectorField (const this_bctype &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping onto a new patch. More...
 
 pressureInletOutletVelocityFvPatchVectorField (const this_bctype &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference. More...
 
 pressureInletOutletVelocityFvPatchVectorField (const this_bctype &)=delete
 No copy without an internal field. More...
 
virtual tmp< fvPatchField< vector > > clone (const DimensionedField< vector, volMesh > &iF) const
 Clone with an internal field reference. More...
 
virtual bool assignable () const
 True: this patch field is altered by assignment. More...
 
const wordphiName () const
 Return the name of phi. More...
 
wordphiName ()
 Return reference to the name of phi to allow adjustment. More...
 
const vectorFieldtangentialVelocity () const
 Return the tangential velocity. More...
 
void setTangentialVelocity (const vectorField &tangentialVelocity)
 Reset the tangential velocity. More...
 
virtual void autoMap (const fvPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object. More...
 
virtual void rmap (const fvPatchVectorField &, const labelList &)
 Reverse map the given fvPatchField onto this fvPatchField. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 
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]

Construct from patch and internal field.

◆ pressureInletOutletVelocityFvPatchVectorField() [2/5]

Construct from patch, internal field and dictionary.

◆ pressureInletOutletVelocityFvPatchVectorField() [3/5]

Construct by mapping onto a new patch.

◆ pressureInletOutletVelocityFvPatchVectorField() [4/5]

Construct as copy setting internal field reference.

◆ pressureInletOutletVelocityFvPatchVectorField() [5/5]

No copy without an internal field.

Member Function Documentation

◆ TypeName()

TypeName ( "pressureInletOutletVelocity"  )

Runtime type information.

◆ clone()

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

Clone with an internal field reference.

Reimplemented in rotatingPressureInletOutletVelocityFvPatchVectorField.

Definition at line 175 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 188 of file pressureInletOutletVelocityFvPatchVectorField.H.

◆ phiName() [1/2]

const word& phiName ( ) const
inline

Return the name of phi.

Definition at line 196 of file pressureInletOutletVelocityFvPatchVectorField.H.

◆ phiName() [2/2]

word& phiName ( )
inline

Return reference to the name of phi to allow adjustment.

Definition at line 204 of file pressureInletOutletVelocityFvPatchVectorField.H.

◆ tangentialVelocity()

const vectorField& tangentialVelocity ( ) const
inline

Return the tangential velocity.

Definition at line 212 of file pressureInletOutletVelocityFvPatchVectorField.H.

◆ setTangentialVelocity()

void setTangentialVelocity ( const vectorField tangentialVelocity)

Reset the tangential velocity.

◆ autoMap()

virtual void autoMap ( const fvPatchFieldMapper )
virtual

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

◆ rmap()

virtual void rmap ( const fvPatchVectorField ,
const labelList  
)
virtual

Reverse map the given fvPatchField onto this fvPatchField.

◆ updateCoeffs()

virtual void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

◆ write()

virtual void write ( Ostream ) const
virtual

◆ operator=()

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

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