Loading...
Searching...
No Matches
outletPhaseMeanVelocityFvPatchVectorField Class Reference
Boundary conditions » Outlet

This boundary condition adjusts the velocity for the given phase to achieve the specified mean thus causing the phase-fraction to adjust according to the mass flow rate. More...

#include <outletPhaseMeanVelocityFvPatchVectorField.H>

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

Public Member Functions

 TypeName ("outletPhaseMeanVelocity")
 Runtime type information.
 outletPhaseMeanVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field.
 outletPhaseMeanVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary.
 outletPhaseMeanVelocityFvPatchVectorField (const outletPhaseMeanVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given.
 outletPhaseMeanVelocityFvPatchVectorField (const outletPhaseMeanVelocityFvPatchVectorField &)
 Construct as copy.
 outletPhaseMeanVelocityFvPatchVectorField (const outletPhaseMeanVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference.
virtual tmp< fvPatchField< vector > > clone () const
 Return a clone.
virtual tmp< fvPatchField< vector > > clone (const DimensionedField< vector, volMesh > &iF) const
 Clone with an internal field reference.
scalar Umean () const
 Return the flux.
scalar & Umean ()
 Return reference to the flux to allow adjustment.
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field.
virtual void write (Ostream &) const
 Write.

Detailed Description

This boundary condition adjusts the velocity for the given phase to achieve the specified mean thus causing the phase-fraction to adjust according to the mass flow rate.

Typical usage is as the outlet condition for a towing-tank ship simulation to maintain the outlet water level at the level as the inlet.

Usage
Property Description Required Default value
Umean mean velocity normal to the boundary [m/s] yes
alpha phase-fraction field yes

Example of the boundary condition specification: 

    <patchName>
    {
        type            outletPhaseMeanVelocity;
        Umean           1.2;
        alpha           alpha.water;
        value           uniform (1.2 0 0);
    }
See also
Foam::mixedFvPatchField Foam::variableHeightFlowRateInletVelocityFvPatchVectorField
Source files

Definition at line 90 of file outletPhaseMeanVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ outletPhaseMeanVelocityFvPatchVectorField() [1/5]

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

Construct from patch and internal field.

Definition at line 30 of file outletPhaseMeanVelocityFvPatchVectorField.C.

References p, and Foam::Zero.

Referenced by outletPhaseMeanVelocityFvPatchVectorField(), outletPhaseMeanVelocityFvPatchVectorField(), outletPhaseMeanVelocityFvPatchVectorField(), and TypeName().

Here is the caller graph for this function:

◆ outletPhaseMeanVelocityFvPatchVectorField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 62 of file outletPhaseMeanVelocityFvPatchVectorField.C.

References dict, p, fvPatchFieldBase::readDict(), and Foam::Zero.

Here is the call graph for this function:

◆ outletPhaseMeanVelocityFvPatchVectorField() [3/5]

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

Construct by mapping given.

outletPhaseMeanVelocityFvPatchVectorField onto a new patch

Definition at line 47 of file outletPhaseMeanVelocityFvPatchVectorField.C.

References outletPhaseMeanVelocityFvPatchVectorField(), and p.

Here is the call graph for this function:

◆ outletPhaseMeanVelocityFvPatchVectorField() [4/5]

outletPhaseMeanVelocityFvPatchVectorField ( const outletPhaseMeanVelocityFvPatchVectorField & ptf)

Construct as copy.

Definition at line 87 of file outletPhaseMeanVelocityFvPatchVectorField.C.

References outletPhaseMeanVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ outletPhaseMeanVelocityFvPatchVectorField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 99 of file outletPhaseMeanVelocityFvPatchVectorField.C.

References outletPhaseMeanVelocityFvPatchVectorField().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "outletPhaseMeanVelocity" )

Runtime type information.

References outletPhaseMeanVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ clone() [1/2]

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

Return a clone.

Definition at line 170 of file outletPhaseMeanVelocityFvPatchVectorField.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 178 of file outletPhaseMeanVelocityFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ Umean() [1/2]

scalar Umean ( ) const
inline

Return the flux.

Definition at line 194 of file outletPhaseMeanVelocityFvPatchVectorField.H.

◆ Umean() [2/2]

scalar & Umean ( )
inline

Return reference to the flux to allow adjustment.

Definition at line 202 of file outletPhaseMeanVelocityFvPatchVectorField.H.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 114 of file outletPhaseMeanVelocityFvPatchVectorField.C.

References Field< Type >::clamp_range(), Foam::gSum(), fvPatchField< Type >::updateCoeffs(), and Foam::Zero.

Here is the call graph for this function:

◆ write()

void write ( Ostream & os) const
virtual

Write.

Definition at line 154 of file outletPhaseMeanVelocityFvPatchVectorField.C.

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

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