pressurePermeableAlphaInletOutletVelocityFvPatchVectorField Class Reference

The pressurePermeableAlphaInletOutletVelocity is a velocity inlet-outlet boundary condition which can be applied to velocity boundaries for multiphase flows when the pressure boundary condition is specified. More...

Inheritance diagram for pressurePermeableAlphaInletOutletVelocityFvPatchVectorField:
Collaboration diagram for pressurePermeableAlphaInletOutletVelocityFvPatchVectorField:

Public Member Functions

 TypeName ("permeableAlphaPressureInletOutletVelocity")
 Runtime type information. More...
 
 pressurePermeableAlphaInletOutletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 pressurePermeableAlphaInletOutletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 pressurePermeableAlphaInletOutletVelocityFvPatchVectorField (const this_bctype &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping onto a new patch. More...
 
 pressurePermeableAlphaInletOutletVelocityFvPatchVectorField (const this_bctype &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference. More...
 
 pressurePermeableAlphaInletOutletVelocityFvPatchVectorField (const this_bctype &)=delete
 No copy without an internal field. More...
 
virtual tmp< fvPatchField< vector > > clone (const DimensionedField< vector, volMesh > &iF) const
 Clone with an internal field reference. More...
 
virtual bool assignable () const
 True: this patch field is altered by assignment. More...
 
const wordrhoName () const noexcept
 Return the name of rho. More...
 
wordrhoName ()
 Return reference to the name of rho to allow adjustment. More...
 
const wordphiName () const noexcept
 Return the name of phi. More...
 
wordphiName ()
 Return reference to the name of phi to allow adjustment. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 
virtual void operator= (const fvPatchField< vector > &pvf)
 Copy assignment. More...
 

Detailed Description

The pressurePermeableAlphaInletOutletVelocity is a velocity inlet-outlet boundary condition which can be applied to velocity boundaries for multiphase flows when the pressure boundary condition is specified.

In the pressurePermeableAlphaInletOutletVelocity, an open condition is applied when alpha is under a user-defined alphaMin value and a wall condition is applied when alpha is larger than the alphaMin.

This boundary condition can be used in conjunction with prghPermeableAlphaTotalPressure for the p_rgh variable.

Usage
Example of the boundary condition specification:
<patchName>
{
    // Mandatory entries
    type            pressurePermeableAlphaInletOutletVelocity;

    // Optional entries
    phi             phi;
    rho             rho;
    alpha           alpha.water;
    alphaMin        0.01;

    // Inherited entries
    value           uniform (0 0 0);
    ...
}

where the entries mean:

Property Description Type Reqd Deflt
phi Name of flux field word no phi
rho Name of density field word no rho
alpha Name of mixture field word no none
alphaMin Minimum alpha scalar no 1

The inherited entries are elaborated in:

See also
Source files

Definition at line 125 of file pressurePermeableAlphaInletOutletVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ pressurePermeableAlphaInletOutletVelocityFvPatchVectorField() [1/5]

Construct from patch and internal field.

◆ pressurePermeableAlphaInletOutletVelocityFvPatchVectorField() [2/5]

Construct from patch, internal field and dictionary.

◆ pressurePermeableAlphaInletOutletVelocityFvPatchVectorField() [3/5]

Construct by mapping onto a new patch.

◆ pressurePermeableAlphaInletOutletVelocityFvPatchVectorField() [4/5]

Construct as copy setting internal field reference.

◆ pressurePermeableAlphaInletOutletVelocityFvPatchVectorField() [5/5]

No copy without an internal field.

Member Function Documentation

◆ TypeName()

TypeName ( "permeableAlphaPressureInletOutletVelocity"  )

Runtime type information.

◆ clone()

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

Clone with an internal field reference.

Definition at line 216 of file pressurePermeableAlphaInletOutletVelocityFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ assignable()

virtual bool assignable ( ) const
inlinevirtual

True: this patch field is altered by assignment.

Definition at line 229 of file pressurePermeableAlphaInletOutletVelocityFvPatchVectorField.H.

◆ rhoName() [1/2]

const word& rhoName ( ) const
inlinenoexcept

Return the name of rho.

Definition at line 237 of file pressurePermeableAlphaInletOutletVelocityFvPatchVectorField.H.

◆ rhoName() [2/2]

word& rhoName ( )
inline

Return reference to the name of rho to allow adjustment.

Definition at line 245 of file pressurePermeableAlphaInletOutletVelocityFvPatchVectorField.H.

◆ phiName() [1/2]

const word& phiName ( ) const
inlinenoexcept

Return the name of phi.

Definition at line 253 of file pressurePermeableAlphaInletOutletVelocityFvPatchVectorField.H.

◆ phiName() [2/2]

word& phiName ( )
inline

Return reference to the name of phi to allow adjustment.

Definition at line 261 of file pressurePermeableAlphaInletOutletVelocityFvPatchVectorField.H.

◆ updateCoeffs()

virtual void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

◆ write()

virtual void write ( Ostream ) const
virtual

Write.

◆ operator=()

virtual void operator= ( const fvPatchField< vector > &  pvf)
virtual

Copy assignment.


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