Public Member Functions | List of all members
pressureDirectedInletVelocityFvPatchVectorField Class Reference

This velocity inlet boundary condition is applied to patches where the pressure is specified. The inflow velocity is obtained from the flux with the specified inlet direction" direction. More...

Inheritance diagram for pressureDirectedInletVelocityFvPatchVectorField:
Inheritance graph
[legend]
Collaboration diagram for pressureDirectedInletVelocityFvPatchVectorField:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("pressureDirectedInletVelocity")
 Runtime type information. More...
 
 pressureDirectedInletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 pressureDirectedInletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 pressureDirectedInletVelocityFvPatchVectorField (const pressureDirectedInletVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given. More...
 
 pressureDirectedInletVelocityFvPatchVectorField (const pressureDirectedInletVelocityFvPatchVectorField &)
 Construct as copy. More...
 
virtual tmp< fvPatchVectorFieldclone () const
 Construct and return a clone. More...
 
 pressureDirectedInletVelocityFvPatchVectorField (const pressureDirectedInletVelocityFvPatchVectorField &, 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...
 
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 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 boundary condition is applied to patches where the pressure is specified. The inflow velocity is obtained from the flux with the specified inlet direction" 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            pressureDirectedInletVelocity;
        phi             phi;
        rho             rho;
        inletDirection  uniform (1 0 0);
        value           uniform 0;
    }
Note
If reverse flow is possible or expected use the pressureDirectedInletOutletVelocityFvPatchVectorField condition instead.
See also
Foam::fixedValueFvPatchField Foam::pressureDirectedInletOutletVelocityFvPatchVectorField
Source files

Definition at line 103 of file pressureDirectedInletVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ pressureDirectedInletVelocityFvPatchVectorField() [1/5]

Construct from patch and internal field.

Definition at line 37 of file pressureDirectedInletVelocityFvPatchVectorField.C.

Referenced by pressureDirectedInletVelocityFvPatchVectorField::clone(), and pressureDirectedInletVelocityFvPatchVectorField::pressureDirectedInletVelocityFvPatchVectorField().

Here is the caller graph for this function:

◆ pressureDirectedInletVelocityFvPatchVectorField() [2/5]

Construct from patch, internal field and dictionary.

Definition at line 67 of file pressureDirectedInletVelocityFvPatchVectorField.C.

References pressureDirectedInletVelocityFvPatchVectorField::pressureDirectedInletVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ pressureDirectedInletVelocityFvPatchVectorField() [3/5]

Construct by mapping given.

pressureDirectedInletVelocityFvPatchVectorField onto a new patch

Definition at line 51 of file pressureDirectedInletVelocityFvPatchVectorField.C.

References pressureDirectedInletVelocityFvPatchVectorField::pressureDirectedInletVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ pressureDirectedInletVelocityFvPatchVectorField() [4/5]

Construct as copy.

Definition at line 82 of file pressureDirectedInletVelocityFvPatchVectorField.C.

References pressureDirectedInletVelocityFvPatchVectorField::pressureDirectedInletVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ pressureDirectedInletVelocityFvPatchVectorField() [5/5]

Construct as copy setting internal field reference.

Definition at line 95 of file pressureDirectedInletVelocityFvPatchVectorField.C.

References pressureDirectedInletVelocityFvPatchVectorField::autoMap().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "pressureDirectedInletVelocity"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchVectorField> clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 160 of file pressureDirectedInletVelocityFvPatchVectorField.H.

References pressureDirectedInletVelocityFvPatchVectorField::pressureDirectedInletVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ 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 177 of file pressureDirectedInletVelocityFvPatchVectorField.H.

References pressureDirectedInletVelocityFvPatchVectorField::pressureDirectedInletVelocityFvPatchVectorField().

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 197 of file pressureDirectedInletVelocityFvPatchVectorField.H.

◆ rhoName() [1/2]

const word& rhoName ( ) const
inline

Return the name of rho.

Definition at line 205 of file pressureDirectedInletVelocityFvPatchVectorField.H.

◆ rhoName() [2/2]

word& rhoName ( )
inline

Return reference to the name of rho to allow adjustment.

Definition at line 211 of file pressureDirectedInletVelocityFvPatchVectorField.H.

◆ phiName() [1/2]

const word& phiName ( ) const
inline

Return the name of phi.

Definition at line 217 of file pressureDirectedInletVelocityFvPatchVectorField.H.

◆ phiName() [2/2]

word& phiName ( )
inline

◆ autoMap()

void autoMap ( const fvPatchFieldMapper m)
virtual

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

Definition at line 110 of file pressureDirectedInletVelocityFvPatchVectorField.C.

References pressureDirectedInletVelocityFvPatchVectorField::rmap().

Referenced by pressureDirectedInletVelocityFvPatchVectorField::phiName(), and pressureDirectedInletVelocityFvPatchVectorField::pressureDirectedInletVelocityFvPatchVectorField().

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

◆ rmap()

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

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 134 of file pressureDirectedInletVelocityFvPatchVectorField.C.

References Foam::dimArea, Foam::dimDensity, DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimVelocity, Foam::exit(), Foam::FatalError, FatalErrorInFunction, n, Foam::operator==(), phi, and pressureDirectedInletVelocityFvPatchVectorField::write().

Referenced by pressureDirectedInletVelocityFvPatchVectorField::phiName().

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

◆ write()

void write ( Ostream os) const
virtual

Write.

Definition at line 176 of file pressureDirectedInletVelocityFvPatchVectorField.C.

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

Referenced by pressureDirectedInletVelocityFvPatchVectorField::phiName(), and pressureDirectedInletVelocityFvPatchVectorField::updateCoeffs().

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

◆ operator=()

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

Definition at line 191 of file pressureDirectedInletVelocityFvPatchVectorField.C.

References Foam::makePatchTypeField(), and fvPatchField< Type >::operator=().

Referenced by pressureDirectedInletVelocityFvPatchVectorField::phiName().

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

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