Public Member Functions | List of all members
variableHeightFlowRateInletVelocityFvPatchVectorField Class Reference
Boundary conditions » Inlet

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...
 
 variableHeightFlowRateInletVelocityFvPatchVectorField (const variableHeightFlowRateInletVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchField< vector > > clone () const
 Return a clone. More...
 
virtual tmp< fvPatchField< vector > > clone (const DimensionedField< vector, volMesh > &iF) const
 Clone with an internal field reference. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. 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.

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

Example of the boundary condition specification: 

    <patchName>
    {
        type            variableHeightFlowRateInletVelocity;
        flowRate        0.2;
        alpha           alpha.water;
        value           uniform (0 0 0); // placeholder
    }

The flowRate entry is a Function1 of time, see Foam::Function1Types.

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 Foam::Function1Types
Source files

Definition at line 98 of file variableHeightFlowRateInletVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ variableHeightFlowRateInletVelocityFvPatchVectorField() [1/5]

variableHeightFlowRateInletVelocityFvPatchVectorField ( const fvPatch &  p,
const DimensionedField< vector, volMesh > &  iF 
)

Construct from patch and internal field.

Definition at line 30 of file variableHeightFlowRateInletVelocityFvPatchVectorField.C.

◆ variableHeightFlowRateInletVelocityFvPatchVectorField() [2/5]

variableHeightFlowRateInletVelocityFvPatchVectorField ( const fvPatch &  p,
const DimensionedField< vector, volMesh > &  iF,
const dictionary &  dict 
)

Construct from patch, internal field and dictionary.

Definition at line 43 of file variableHeightFlowRateInletVelocityFvPatchVectorField.C.

◆ variableHeightFlowRateInletVelocityFvPatchVectorField() [3/5]

variableHeightFlowRateInletVelocityFvPatchVectorField ( const variableHeightFlowRateInletVelocityFvPatchVectorField &  ptf,
const fvPatch &  p,
const DimensionedField< vector, volMesh > &  iF,
const fvPatchFieldMapper &  mapper 
)

Construct by mapping given.

variableHeightFlowRateInletVelocityFvPatchVectorField onto a new patch

Definition at line 57 of file variableHeightFlowRateInletVelocityFvPatchVectorField.C.

◆ variableHeightFlowRateInletVelocityFvPatchVectorField() [4/5]

variableHeightFlowRateInletVelocityFvPatchVectorField ( const variableHeightFlowRateInletVelocityFvPatchVectorField &  ptf)

Construct as copy.

Definition at line 72 of file variableHeightFlowRateInletVelocityFvPatchVectorField.C.

◆ variableHeightFlowRateInletVelocityFvPatchVectorField() [5/5]

variableHeightFlowRateInletVelocityFvPatchVectorField ( const variableHeightFlowRateInletVelocityFvPatchVectorField &  ptf,
const DimensionedField< vector, volMesh > &  iF 
)

Construct as copy setting internal field reference.

Definition at line 84 of file variableHeightFlowRateInletVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "variableHeightFlowRateInletVelocity"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchField<vector> > clone ( ) const
inlinevirtual

Return a clone.

Definition at line 178 of file variableHeightFlowRateInletVelocityFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ clone() [2/2]

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

Clone with an internal field reference.

Definition at line 187 of file variableHeightFlowRateInletVelocityFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 97 of file variableHeightFlowRateInletVelocityFvPatchVectorField.C.

References Foam::constant::atomic::alpha, DebugInfo, Foam::endl(), Foam::gSum(), Foam::max(), mesh, Foam::min(), n, Foam::operator==(), Foam::foamVersion::patch, and fvPatchField< Type >::updateCoeffs().

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 139 of file variableHeightFlowRateInletVelocityFvPatchVectorField.C.

References os(), fvPatchField< Type >::write(), Ostream::writeEntry(), and fvPatchField< Type >::writeValueEntry().

Here is the call graph for this function:
The documentation for this class was generated from the following files: