Public Member Functions | List of all members
outletPhaseMeanVelocityFvPatchVectorField Class Reference

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...

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

Public Member Functions

 TypeName ("outletPhaseMeanVelocity")
 Runtime type information. More...
 
 outletPhaseMeanVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 outletPhaseMeanVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 outletPhaseMeanVelocityFvPatchVectorField (const outletPhaseMeanVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given. More...
 
 outletPhaseMeanVelocityFvPatchVectorField (const outletPhaseMeanVelocityFvPatchVectorField &)=delete
 Disallow copy without setting internal field reference. More...
 
 outletPhaseMeanVelocityFvPatchVectorField (const outletPhaseMeanVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual tmp< fvPatchVectorField > clone (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 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
UnMean mean velocity normal to the boundary [m/s] yes
alpha phase-fraction field yes

Example of the boundary condition specification: 

    <patchName>
    {
        type            outletPhaseMeanVelocity;
        UnMean          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 36 of file outletPhaseMeanVelocityFvPatchVectorField.C.

References Foam::Zero.

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

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 53 of file outletPhaseMeanVelocityFvPatchVectorField.C.

References dictionary::found(), outletPhaseMeanVelocityFvPatchVectorField::outletPhaseMeanVelocityFvPatchVectorField(), List< Type >::size(), vectorField(), 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 83 of file outletPhaseMeanVelocityFvPatchVectorField.C.

References outletPhaseMeanVelocityFvPatchVectorField::outletPhaseMeanVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ outletPhaseMeanVelocityFvPatchVectorField() [4/5]

outletPhaseMeanVelocityFvPatchVectorField ( const outletPhaseMeanVelocityFvPatchVectorField &  )
delete

Disallow copy without setting internal field reference.

◆ outletPhaseMeanVelocityFvPatchVectorField() [5/5]

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

Copy constructor setting internal field reference.

Definition at line 98 of file outletPhaseMeanVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "outletPhaseMeanVelocity"  )

Runtime type information.

◆ clone()

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

Construct and return a clone setting internal field reference.

Definition at line 152 of file outletPhaseMeanVelocityFvPatchVectorField.H.

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

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 111 of file outletPhaseMeanVelocityFvPatchVectorField.C.

References Foam::gSum(), Foam::max(), Foam::min(), fvPatchField< Type >::updateCoeffs(), outletPhaseMeanVelocityFvPatchVectorField::write(), and Foam::Zero.

Referenced by outletPhaseMeanVelocityFvPatchVectorField::clone().

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 153 of file outletPhaseMeanVelocityFvPatchVectorField.C.

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

Referenced by outletPhaseMeanVelocityFvPatchVectorField::clone(), and outletPhaseMeanVelocityFvPatchVectorField::updateCoeffs().

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: