fixedNormalInletOutletVelocityFvPatchVectorField Class Reference

This velocity inlet/outlet boundary condition combines a fixed normal component obtained from the "normalVelocity" patchField supplied with a fixed or zero-gradiented tangential component depending on the direction of the flow and the setting of "fixTangentialInflow": More...

Inheritance diagram for fixedNormalInletOutletVelocityFvPatchVectorField:
Collaboration diagram for fixedNormalInletOutletVelocityFvPatchVectorField:

Public Member Functions

 TypeName ("fixedNormalInletOutletVelocity")
 Runtime type information. More...
 
 fixedNormalInletOutletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 fixedNormalInletOutletVelocityFvPatchVectorField (const fixedNormalInletOutletVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fieldMapper &)
 Construct by mapping given. More...
 
 fixedNormalInletOutletVelocityFvPatchVectorField (const fixedNormalInletOutletVelocityFvPatchVectorField &)=delete
 Disallow copy without setting internal field reference. More...
 
 fixedNormalInletOutletVelocityFvPatchVectorField (const fixedNormalInletOutletVelocityFvPatchVectorField &, 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 wordphiName () const
 Return the name of phi. More...
 
wordphiName ()
 Return reference to the name of phi to allow adjustment. More...
 
Switch fixTangentialInflow () const
 
const fvPatchVectorFieldnormalVelocity () const
 Return the BC which provides the normal component of velocity. More...
 
virtual void map (const fvPatchVectorField &, const fieldMapper &)
 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 combines a fixed normal component obtained from the "normalVelocity" patchField supplied with a fixed or zero-gradiented tangential component depending on the direction of the flow and the setting of "fixTangentialInflow":

- Outflow: apply zero-gradient condition to tangential components

  • Inflow:
    • fixTangentialInflow is true apply value provided by the normalVelocity patchField to the tangential components
    • fixTangentialInflow is false apply zero-gradient condition to tangential components.
Usage
Property Description Required Default value
phi flux field name no phi
fixTangentialInflow If true fix the tangential component for inflow yes
normalVelocity patchField providing the normal velocity field yes

Example of the boundary condition specification:

    <patchName>
    {
        type            fixedNormalInletOutletVelocity;

        fixTangentialInflow false;
        normalVelocity
        {
            type            uniformFixedValue;
            uniformValue    sine;
            uniformValueCoeffs
            {
                frequency 1;
                amplitude table
                (
                    (0  0)
                    (2  0.088)
                    (8  0.088)
                );
                scale     (0 1 0);
                level     (0 0 0);
            }
        }

        value           uniform (0 0 0);
    }
Source files

Definition at line 118 of file fixedNormalInletOutletVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ fixedNormalInletOutletVelocityFvPatchVectorField() [1/4]

Construct from patch, internal field and dictionary.

Definition at line 34 of file fixedNormalInletOutletVelocityFvPatchVectorField.C.

References dict, DimensionedField< Type, GeoMesh >::dimensions(), fixedNormalInletOutletVelocityFvPatchVectorField::normalVelocity(), fvPatchField< Type >::operator, p, and Foam::Zero.

Referenced by fixedNormalInletOutletVelocityFvPatchVectorField::clone().

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

◆ fixedNormalInletOutletVelocityFvPatchVectorField() [2/4]

◆ fixedNormalInletOutletVelocityFvPatchVectorField() [3/4]

Disallow copy without setting internal field reference.

◆ fixedNormalInletOutletVelocityFvPatchVectorField() [4/4]

Copy constructor setting internal field reference.

Definition at line 79 of file fixedNormalInletOutletVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "fixedNormalInletOutletVelocity"  )

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 174 of file fixedNormalInletOutletVelocityFvPatchVectorField.H.

References fixedNormalInletOutletVelocityFvPatchVectorField::fixedNormalInletOutletVelocityFvPatchVectorField().

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 191 of file fixedNormalInletOutletVelocityFvPatchVectorField.H.

◆ phiName() [1/2]

const word& phiName ( ) const
inline

Return the name of phi.

Definition at line 200 of file fixedNormalInletOutletVelocityFvPatchVectorField.H.

◆ phiName() [2/2]

word& phiName ( )
inline

Return reference to the name of phi to allow adjustment.

Definition at line 206 of file fixedNormalInletOutletVelocityFvPatchVectorField.H.

◆ fixTangentialInflow()

Switch fixTangentialInflow ( ) const
inline

◆ normalVelocity()

const fvPatchVectorField& normalVelocity ( ) const
inline

◆ map()

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

Map the given fvPatchField onto this fvPatchField.

Definition at line 95 of file fixedNormalInletOutletVelocityFvPatchVectorField.C.

References fixedNormalInletOutletVelocityFvPatchVectorField::normalVelocity().

Here is the call graph for this function:

◆ reset()

void reset ( const fvPatchVectorField ptf)
virtual

Reset the fvPatchField to the given fvPatchField.

Used for mesh to mesh mapping

Definition at line 110 of file fixedNormalInletOutletVelocityFvPatchVectorField.C.

References fixedNormalInletOutletVelocityFvPatchVectorField::normalVelocity().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 124 of file fixedNormalInletOutletVelocityFvPatchVectorField.C.

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

Here is the call graph for this function:

◆ write()

◆ operator=()

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

Definition at line 168 of file fixedNormalInletOutletVelocityFvPatchVectorField.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: