Public Member Functions | List of all members
flowRateInletVelocityFvPatchVectorField Class Reference

This boundary condition provides a velocity boundary condition, derived from the flux (volumetric or mass-based), whose direction is assumed to be normal to the patch. More...

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

Public Member Functions

 TypeName ("flowRateInletVelocity")
 Runtime type information. More...
 
 flowRateInletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 flowRateInletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 flowRateInletVelocityFvPatchVectorField (const flowRateInletVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given. More...
 
 flowRateInletVelocityFvPatchVectorField (const flowRateInletVelocityFvPatchVectorField &)
 Construct as copy. More...
 
virtual tmp< fvPatchVectorFieldclone () const
 Construct and return a clone. More...
 
 flowRateInletVelocityFvPatchVectorField (const flowRateInletVelocityFvPatchVectorField &, 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 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, derived from the flux (volumetric or mass-based), whose direction is assumed to be normal to the patch.

For a mass-based flux:

For a volumetric-based flux:


Patch usage

Property Description Required Default value
massFlowRate mass flow rate [kg/s] no
volumetricFlowRate volumetric flow rate [m3/s] no
rhoInlet inlet density no

Example of the boundary condition specification for a volumetric flow rate:

    myPatch
    {
        type        flowRateInletVelocity;
        volumetricFlowRate  0.2;
        value       uniform (0 0 0); // placeholder
    }

Example of the boundary condition specification for a mass flow rate:

    myPatch
    {
        type                flowRateInletVelocity;
        massFlowRate        0.2;
        rho                 rho;
        rhoInlet            1.0;
    }

The flowRate entry is a DataEntry type, meaning that it can be specified as constant, a polynomial fuction of time, and ...

Note
  • rhoInlet is required for the case of a mass flow rate, where the density field is not available at start-up
  • the value is positive into the domain (as an inlet)
  • may not work correctly for transonic inlets
  • strange behaviour with potentialFoam since the U equation is not solved
See also
Foam::DataEntry Foam::fixedValueFvPatchField
Source files

Definition at line 127 of file flowRateInletVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

Construct from patch and internal field.

Definition at line 36 of file flowRateInletVelocityFvPatchVectorField.C.

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

Here is the caller graph for this function:

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

Construct by mapping given.

flowRateInletVelocityFvPatchVectorField onto a new patch

Definition at line 51 of file flowRateInletVelocityFvPatchVectorField.C.

References flowRateInletVelocityFvPatchVectorField::flowRateInletVelocityFvPatchVectorField().

Here is the call graph for this function:

Construct as copy.

Definition at line 119 of file flowRateInletVelocityFvPatchVectorField.C.

References flowRateInletVelocityFvPatchVectorField::flowRateInletVelocityFvPatchVectorField().

Here is the call graph for this function:

Construct as copy setting internal field reference.

Definition at line 133 of file flowRateInletVelocityFvPatchVectorField.C.

Member Function Documentation

TypeName ( "flowRateInletVelocity"  )

Runtime type information.

virtual tmp<fvPatchVectorField> clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 187 of file flowRateInletVelocityFvPatchVectorField.H.

References flowRateInletVelocityFvPatchVectorField::flowRateInletVelocityFvPatchVectorField().

Here is the call graph for this function:

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

Construct and return a clone setting internal field reference.

Definition at line 204 of file flowRateInletVelocityFvPatchVectorField.H.

References flowRateInletVelocityFvPatchVectorField::flowRateInletVelocityFvPatchVectorField(), flowRateInletVelocityFvPatchVectorField::updateCoeffs(), and flowRateInletVelocityFvPatchVectorField::write().

Here is the call graph for this function:

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 148 of file flowRateInletVelocityFvPatchVectorField.C.

References Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::gSum(), n, and Foam::operator==().

Referenced by flowRateInletVelocityFvPatchVectorField::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

void write ( Ostream os) const
virtual

Write.

Definition at line 197 of file flowRateInletVelocityFvPatchVectorField.C.

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

Referenced by flowRateInletVelocityFvPatchVectorField::clone().

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: