Public Member Functions | Private Attributes
pressureDirectedInletOutletVelocityFvPatchVectorField Class Reference

This velocity inlet/outlet boundary condition is applied to pressure boundaries where the pressure is specified. A zero-gradient condtion 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:
Inheritance graph
[legend]
Collaboration diagram for pressureDirectedInletOutletVelocityFvPatchVectorField:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("pressureDirectedInletOutletVelocity")
 Runtime type information. More...
 
 pressureDirectedInletOutletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. 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 &)
 Construct as copy. More...
 
virtual tmp< fvPatchVectorFieldclone () const
 Construct and return a clone. More...
 
 pressureDirectedInletOutletVelocityFvPatchVectorField (const pressureDirectedInletOutletVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchVectorFieldclone (const DimensionedField< vector, volMesh > &iF) const
 Construct and return a clone setting internal field reference. 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 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)
 

Private Attributes

word phiName_
 Flux field name. More...
 
word rhoName_
 Density field name. More...
 
vectorField inletDir_
 Inlet direction. More...
 

Detailed Description

This velocity inlet/outlet boundary condition is applied to pressure boundaries where the pressure is specified. A zero-gradient condtion is applied for outflow (as defined by the flux); for inflow, the velocity is obtained from the flux with the specified inlet direction.


Patch 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:

    myPatch
    {
        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 105 of file pressureDirectedInletOutletVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ pressureDirectedInletOutletVelocityFvPatchVectorField() [1/5]

Construct from patch and internal field.

Definition at line 36 of file pressureDirectedInletOutletVelocityFvPatchVectorField.C.

◆ pressureDirectedInletOutletVelocityFvPatchVectorField() [2/5]

Construct from patch, internal field and dictionary.

Definition at line 70 of file pressureDirectedInletOutletVelocityFvPatchVectorField.C.

References dict, p, and vectorField().

Here is the call graph for this function:

◆ pressureDirectedInletOutletVelocityFvPatchVectorField() [3/5]

Construct by mapping given.

pressureDirectedInletOutletVelocityFvPatchVectorField onto a new patch

Definition at line 54 of file pressureDirectedInletOutletVelocityFvPatchVectorField.C.

◆ pressureDirectedInletOutletVelocityFvPatchVectorField() [4/5]

Construct as copy.

Definition at line 90 of file pressureDirectedInletOutletVelocityFvPatchVectorField.C.

◆ pressureDirectedInletOutletVelocityFvPatchVectorField() [5/5]

Construct as copy setting internal field reference.

Definition at line 103 of file pressureDirectedInletOutletVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "pressureDirectedInletOutletVelocity"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchVectorField> clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 162 of file pressureDirectedInletOutletVelocityFvPatchVectorField.H.

◆ clone() [2/2]

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

Construct and return a clone setting internal field reference.

Definition at line 182 of file pressureDirectedInletOutletVelocityFvPatchVectorField.H.

◆ rhoName() [1/2]

const word& rhoName ( ) const
inline

◆ rhoName() [2/2]

word& rhoName ( )
inline

Return reference to the name of rho to allow adjustment.

Definition at line 208 of file pressureDirectedInletOutletVelocityFvPatchVectorField.H.

References pressureDirectedInletOutletVelocityFvPatchVectorField::rhoName_.

◆ phiName() [1/2]

const word& phiName ( ) const
inline

◆ phiName() [2/2]

word& phiName ( )
inline

Return reference to the name of phi to allow adjustment.

Definition at line 220 of file pressureDirectedInletOutletVelocityFvPatchVectorField.H.

References pressureDirectedInletOutletVelocityFvPatchVectorField::phiName_.

◆ autoMap()

void autoMap ( const fvPatchFieldMapper m)
virtual

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

Definition at line 118 of file pressureDirectedInletOutletVelocityFvPatchVectorField.C.

◆ rmap()

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

◆ updateCoeffs()

void updateCoeffs ( )
virtual

◆ write()

void write ( Ostream os) const
virtual

Write.

Definition at line 187 of file pressureDirectedInletOutletVelocityFvPatchVectorField.C.

References fvPatchField::write().

Here is the call graph for this function:

◆ operator=()

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

Field Documentation

◆ phiName_

word phiName_
private

◆ rhoName_

word rhoName_
private

◆ inletDir_

vectorField inletDir_
private

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