pressureDirectedInletOutletVelocityFvPatchVectorField Class Reference

This velocity inlet/outlet boundary condition is applied to pressure 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 flux with the specified inlet direction. More...

Inheritance diagram for pressureDirectedInletOutletVelocityFvPatchVectorField:
Collaboration diagram for pressureDirectedInletOutletVelocityFvPatchVectorField:

Public Member Functions

 TypeName ("pressureDirectedInletOutletVelocity")
 Runtime type information. More...
 
 pressureDirectedInletOutletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 pressureDirectedInletOutletVelocityFvPatchVectorField (const pressureDirectedInletOutletVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given. More...
 
 pressureDirectedInletOutletVelocityFvPatchVectorField (const pressureDirectedInletOutletVelocityFvPatchVectorField &)=delete
 Disallow copy without setting internal field reference. More...
 
 pressureDirectedInletOutletVelocityFvPatchVectorField (const pressureDirectedInletOutletVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual tmp< fvPatchVectorFieldclone (const DimensionedField< vector, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual bool assignable () const
 Return true: this patch field is altered by assignment. More...
 
const wordrhoName () const
 Return the name of rho. More...
 
wordrhoName ()
 Return reference to the name of rho to allow adjustment. More...
 
const wordphiName () const
 Return the name of phi. More...
 
wordphiName ()
 Return reference to the name of phi to allow adjustment. More...
 
virtual void map (const fvPatchVectorField &, const fvPatchFieldMapper &)
 Map the given fvPatchField onto this fvPatchField. More...
 
virtual void reset (const fvPatchVectorField &)
 Reset the fvPatchField to the given 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 pressure 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 flux with the specified inlet direction.

Usage
Property Description Required Default value
phi flux field name no phi
rho density field name no rho
inletDirection inlet direction per patch face yes

Example of the boundary condition specification:

    <patchName>
    {
        type            pressureDirectedInletOutletVelocity;
        phi             phi;
        rho             rho;
        inletDirection  uniform (1 0 0);
        value           uniform 0;
    }

Note: Sign conventions:

  • positive flux (out of domain): apply zero-gradient condition
  • negative flux (into of domain): derive from the flux with specified direction
See also
Foam::mixedFvPatchVectorField
Source files

Definition at line 101 of file pressureDirectedInletOutletVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ pressureDirectedInletOutletVelocityFvPatchVectorField() [1/4]

Construct from patch, internal field and dictionary.

Definition at line 34 of file pressureDirectedInletOutletVelocityFvPatchVectorField.C.

References dict, fvPatchField< Type >::operator=(), p, and Foam::Zero.

Here is the call graph for this function:

◆ pressureDirectedInletOutletVelocityFvPatchVectorField() [2/4]

◆ pressureDirectedInletOutletVelocityFvPatchVectorField() [3/4]

Disallow copy without setting internal field reference.

◆ pressureDirectedInletOutletVelocityFvPatchVectorField() [4/4]

Copy constructor setting internal field reference.

Definition at line 70 of file pressureDirectedInletOutletVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "pressureDirectedInletOutletVelocity"  )

Runtime type information.

◆ clone()

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

Construct and return a clone setting internal field reference.

Definition at line 158 of file pressureDirectedInletOutletVelocityFvPatchVectorField.H.

◆ assignable()

virtual bool assignable ( ) const
inlinevirtual

Return true: this patch field is altered by assignment.

Definition at line 179 of file pressureDirectedInletOutletVelocityFvPatchVectorField.H.

◆ rhoName() [1/2]

const word& rhoName ( ) const
inline

Return the name of rho.

Definition at line 188 of file pressureDirectedInletOutletVelocityFvPatchVectorField.H.

◆ rhoName() [2/2]

word& rhoName ( )
inline

Return reference to the name of rho to allow adjustment.

Definition at line 194 of file pressureDirectedInletOutletVelocityFvPatchVectorField.H.

◆ phiName() [1/2]

const word& phiName ( ) const
inline

Return the name of phi.

Definition at line 200 of file pressureDirectedInletOutletVelocityFvPatchVectorField.H.

◆ phiName() [2/2]

word& phiName ( )
inline

Return reference to the name of phi to allow adjustment.

Definition at line 206 of file pressureDirectedInletOutletVelocityFvPatchVectorField.H.

◆ map()

void map ( const fvPatchVectorField ptf,
const fvPatchFieldMapper mapper 
)
virtual

◆ reset()

void reset ( const fvPatchVectorField ptf)
virtual

Reset the fvPatchField to the given fvPatchField.

Used for mesh to mesh mapping

Definition at line 102 of file pressureDirectedInletOutletVelocityFvPatchVectorField.C.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 117 of file pressureDirectedInletOutletVelocityFvPatchVectorField.C.

References DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimFlux, Foam::dimMassFlux, Foam::exit(), Foam::FatalError, FatalErrorInFunction, n, and Foam::neg().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write.

Definition at line 160 of file pressureDirectedInletOutletVelocityFvPatchVectorField.C.

References fvPatchField< Type >::write(), and Foam::writeEntry().

Here is the call graph for this function:

◆ operator=()

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

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