pressureInletOutletVelocityFvPatchVectorField Class Reference

Velocity inlet/outlet boundary condition for patches where the pressure is specified in some manner, e.g. fixedValue, totalPressure, entrainmentPressure etc. More...

Inheritance diagram for pressureInletOutletVelocityFvPatchVectorField:
Collaboration diagram for pressureInletOutletVelocityFvPatchVectorField:

Public Member Functions

 TypeName ("pressureInletOutletVelocity")
 Runtime type information. More...
 
 pressureInletOutletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, fvMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 pressureInletOutletVelocityFvPatchVectorField (const pressureInletOutletVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, fvMesh > &, const fieldMapper &)
 Construct by mapping given. More...
 
 pressureInletOutletVelocityFvPatchVectorField (const pressureInletOutletVelocityFvPatchVectorField &)=delete
 Disallow copy without setting internal field reference. More...
 
 pressureInletOutletVelocityFvPatchVectorField (const pressureInletOutletVelocityFvPatchVectorField &, const DimensionedField< vector, fvMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual tmp< fvPatchVectorFieldclone (const DimensionedField< vector, fvMesh > &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 wordphiName () const
 Return the name of phi. More...
 
wordphiName ()
 Return reference to the name of phi to allow adjustment. More...
 
const DimensionedField< vector, fvPatch > & tangentialVelocity () const
 Return the tangential velocity Function1. More...
 
virtual void map (const fvPatchField< vector > &, const fieldMapper &)
 Map the given fvPatchField onto this fvPatchField. More...
 
virtual void reset (const fvPatchField< vector > &)
 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

Velocity inlet/outlet boundary condition for patches where the pressure is specified in some manner, e.g. fixedValue, totalPressure, entrainmentPressure etc.

This boundary condition is directionMixed: Flux outflow: zeroGradient condition Flux inflow: zeroGradient condition for normal component fixedValue for tangential component

The external tangential velocity can be optionally specified otherwise it is assumed zero.

Usage
Property Description Required Default value
phi flux field name no phi
tangentialVelocity tangential velocity no
value initial velocity no evaluated

Example of the boundary condition specification:

    <patchName>
    {
        type            pressureInletOutletVelocity;
        tangentialVelocity $internalField;
    }

The tangentialVelocity entry is a UFunctionalDimensionedField providing total flexibility in the specification of the tangential velocity, the normal component is removed automatically from the field returned by the function.

See also
Foam::DimensionedFieldFunction Foam::UFunctionalDimensionedField Foam::directionMixedFvPatchVectorField Foam::totalPressureFvPatchScalarField Foam::entrainmentPressureFvPatchScalarField
Source files

Definition at line 108 of file pressureInletOutletVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ pressureInletOutletVelocityFvPatchVectorField() [1/4]

Construct from patch, internal field and dictionary.

Definition at line 34 of file pressureInletOutletVelocityFvPatchVectorField.C.

References dict, DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions(), Foam::evaluate(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::I, n, Foam::neg(), fvPatchField< Type >::operator, p, Foam::sqr(), and Foam::Zero.

Referenced by pressureInletOutletVelocityFvPatchVectorField::clone().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ pressureInletOutletVelocityFvPatchVectorField() [2/4]

◆ pressureInletOutletVelocityFvPatchVectorField() [3/4]

Disallow copy without setting internal field reference.

◆ pressureInletOutletVelocityFvPatchVectorField() [4/4]

Copy constructor setting internal field reference.

Definition at line 106 of file pressureInletOutletVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "pressureInletOutletVelocity"  )

Runtime type information.

◆ clone()

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

Construct and return a clone setting internal field reference.

Reimplemented in rotatingPressureInletOutletVelocityFvPatchVectorField.

Definition at line 161 of file pressureInletOutletVelocityFvPatchVectorField.H.

References pressureInletOutletVelocityFvPatchVectorField::pressureInletOutletVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ assignable()

virtual bool assignable ( ) const
inlinevirtual

Return true: this patch field is altered by assignment.

Definition at line 178 of file pressureInletOutletVelocityFvPatchVectorField.H.

◆ phiName() [1/2]

const word& phiName ( ) const
inline

Return the name of phi.

Definition at line 187 of file pressureInletOutletVelocityFvPatchVectorField.H.

◆ phiName() [2/2]

word& phiName ( )
inline

Return reference to the name of phi to allow adjustment.

Definition at line 193 of file pressureInletOutletVelocityFvPatchVectorField.H.

◆ tangentialVelocity()

const DimensionedField<vector, fvPatch>& tangentialVelocity ( ) const
inline

Return the tangential velocity Function1.

Definition at line 199 of file pressureInletOutletVelocityFvPatchVectorField.H.

Referenced by totalPressureFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

◆ map()

void map ( const fvPatchField< vector > &  ptf,
const fieldMapper mapper 
)
virtual

Map the given fvPatchField onto this fvPatchField.

Definition at line 125 of file pressureInletOutletVelocityFvPatchVectorField.C.

References fieldMapper::direct().

Here is the call graph for this function:

◆ reset()

void reset ( const fvPatchField< vector > &  ptf)
virtual

Reset the fvPatchField to the given fvPatchField.

Used for mesh to mesh mapping

Definition at line 136 of file pressureInletOutletVelocityFvPatchVectorField.C.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 146 of file pressureInletOutletVelocityFvPatchVectorField.C.

References Foam::evaluate(), Foam::I, n, 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 170 of file pressureInletOutletVelocityFvPatchVectorField.C.

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

Here is the call graph for this function:

◆ operator=()

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

Definition at line 185 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: