Public Member Functions | Private Attributes
variableHeightFlowRateInletVelocityFvPatchVectorField Class Reference

This boundary condition provides a velocity boundary condition for multphase flow based on a user-specified volumetric flow rate. More...

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

Public Member Functions

 TypeName ("variableHeightFlowRateInletVelocity")
 Runtime type information. More...
 
 variableHeightFlowRateInletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 variableHeightFlowRateInletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 variableHeightFlowRateInletVelocityFvPatchVectorField (const variableHeightFlowRateInletVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given. More...
 
 variableHeightFlowRateInletVelocityFvPatchVectorField (const variableHeightFlowRateInletVelocityFvPatchVectorField &)
 Construct as copy. More...
 
virtual tmp< fvPatchVectorFieldclone () const
 Construct and return a clone. More...
 
 variableHeightFlowRateInletVelocityFvPatchVectorField (const variableHeightFlowRateInletVelocityFvPatchVectorField &, 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...
 
scalar flowRate () const
 Return the flux. More...
 
scalar & flowRate ()
 Return reference to the flux to allow adjustment. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 

Private Attributes

scalar flowRate_
 Inlet integral flow rate. More...
 
word alphaName_
 Name of the phase-fraction field. More...
 

Detailed Description

This boundary condition provides a velocity boundary condition for multphase flow based on a user-specified volumetric flow rate.

The flow rate is made proportional to the phase fraction alpha at each face of the patch and alpha is ensured to be bound between 0 and 1.


Patch usage

Property Description Required Default value
flowRate volumetric flow rate [m3/s] yes
alpha phase-fraction field yes

Example of the boundary condition specification:

    myPatch
    {
        type            variableHeightFlowRateInletVelocity;
        flowRate        0.2;
        alpha           alpha.water;
        value           uniform (0 0 0); // placeholder
    }
Note
  • the value is positive into the domain
  • may not work correctly for transonic inlets
  • strange behaviour with potentialFoam since the momentum equation is not solved
See also
Foam::fixedValueFvPatchField
Source files

Definition at line 97 of file variableHeightFlowRateInletVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ variableHeightFlowRateInletVelocityFvPatchVectorField() [1/5]

Construct from patch and internal field.

Definition at line 36 of file variableHeightFlowRateInletVelocityFvPatchVectorField.C.

Referenced by variableHeightFlowRateInletVelocityFvPatchVectorField::clone().

Here is the caller graph for this function:

◆ variableHeightFlowRateInletVelocityFvPatchVectorField() [2/5]

Construct from patch, internal field and dictionary.

Definition at line 64 of file variableHeightFlowRateInletVelocityFvPatchVectorField.C.

◆ variableHeightFlowRateInletVelocityFvPatchVectorField() [3/5]

Construct by mapping given.

variableHeightFlowRateInletVelocityFvPatchVectorField onto a new patch

Definition at line 49 of file variableHeightFlowRateInletVelocityFvPatchVectorField.C.

◆ variableHeightFlowRateInletVelocityFvPatchVectorField() [4/5]

Construct as copy.

Definition at line 78 of file variableHeightFlowRateInletVelocityFvPatchVectorField.C.

◆ variableHeightFlowRateInletVelocityFvPatchVectorField() [5/5]

Construct as copy setting internal field reference.

Definition at line 90 of file variableHeightFlowRateInletVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "variableHeightFlowRateInletVelocity"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchVectorField> clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 151 of file variableHeightFlowRateInletVelocityFvPatchVectorField.H.

References variableHeightFlowRateInletVelocityFvPatchVectorField::variableHeightFlowRateInletVelocityFvPatchVectorField().

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 168 of file variableHeightFlowRateInletVelocityFvPatchVectorField.H.

◆ flowRate() [1/2]

scalar flowRate ( ) const
inline

◆ flowRate() [2/2]

scalar& flowRate ( )
inline

Return reference to the flux to allow adjustment.

Definition at line 194 of file variableHeightFlowRateInletVelocityFvPatchVectorField.H.

References variableHeightFlowRateInletVelocityFvPatchVectorField::flowRate_.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 104 of file variableHeightFlowRateInletVelocityFvPatchVectorField.C.

References Foam::gSum(), Foam::max(), Foam::min(), n, and Foam::operator==().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write.

Definition at line 129 of file variableHeightFlowRateInletVelocityFvPatchVectorField.C.

References Foam::nl, write(), and Ostream::writeKeyword().

Here is the call graph for this function:

Field Documentation

◆ flowRate_

scalar flowRate_
private

◆ alphaName_

word alphaName_
private

Name of the phase-fraction field.

Definition at line 107 of file variableHeightFlowRateInletVelocityFvPatchVectorField.H.


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