Public Member Functions | List of all members
prghPermeableAlphaTotalPressureFvPatchScalarField Class Reference

The prghPermeableAlphaTotalPressure is a mixed boundary condition for the p_rgh variable in multiphase flows. More...

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

Public Member Functions

 TypeName ("prghPermeableAlphaTotalPressure")
 
 prghPermeableAlphaTotalPressureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 
 prghPermeableAlphaTotalPressureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 
 prghPermeableAlphaTotalPressureFvPatchScalarField (const prghPermeableAlphaTotalPressureFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 
 prghPermeableAlphaTotalPressureFvPatchScalarField (const prghPermeableAlphaTotalPressureFvPatchScalarField &)
 
virtual tmp< fvPatchField< scalar > > clone () const
 
 prghPermeableAlphaTotalPressureFvPatchScalarField (const prghPermeableAlphaTotalPressureFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 
virtual tmp< fvPatchField< scalar > > clone (const DimensionedField< scalar, volMesh > &iF) const
 
virtual void autoMap (const fvPatchFieldMapper &)
 
virtual void rmap (const fvPatchScalarField &, const labelList &)
 
virtual void updateCoeffs ()
 
virtual void updateSnGrad (const scalarField &snGradp)
 
virtual void write (Ostream &) const
 
- Public Member Functions inherited from mixedFvPatchField< scalar >
 TypeName ("mixed")
 
 mixedFvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 
 mixedFvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 
 mixedFvPatchField (const mixedFvPatchField< scalar > &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 
 mixedFvPatchField (const mixedFvPatchField< scalar > &)
 
 mixedFvPatchField (const mixedFvPatchField< scalar > &, const DimensionedField< scalar, volMesh > &)
 
virtual tmp< fvPatchField< scalar > > clone () const
 
virtual bool fixesValue () const
 
virtual bool assignable () const
 
virtual Field< scalar > & refValue ()
 
virtual const Field< scalar > & refValue () const
 
virtual Field< scalar > & refGrad ()
 
virtual const Field< scalar > & refGrad () const
 
virtual scalarFieldvalueFraction ()
 
virtual const scalarFieldvalueFraction () const
 
virtual Field< scalar > & source ()
 
virtual const Field< scalar > & source () const
 
virtual tmp< Field< scalar > > snGrad () const
 
virtual void evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
 
virtual tmp< Field< scalar > > valueInternalCoeffs (const tmp< scalarField > &) const
 
virtual tmp< Field< scalar > > valueBoundaryCoeffs (const tmp< scalarField > &) const
 
virtual tmp< Field< scalar > > gradientInternalCoeffs () const
 
virtual tmp< Field< scalar > > gradientBoundaryCoeffs () const
 
virtual void operator= (const UList< scalar > &)
 
virtual void operator= (const fvPatchField< scalar > &)
 
virtual void operator= (const scalar &)
 
virtual void operator+= (const fvPatchField< scalar > &)
 
virtual void operator+= (const Field< scalar > &)
 
virtual void operator+= (const scalar &)
 
virtual void operator-= (const fvPatchField< scalar > &)
 
virtual void operator-= (const Field< scalar > &)
 
virtual void operator-= (const scalar &)
 
virtual void operator*= (const fvPatchField< scalar > &)
 
virtual void operator*= (const Field< scalar > &)
 
virtual void operator*= (const scalar)
 
virtual void operator/= (const fvPatchField< scalar > &)
 
virtual void operator/= (const Field< scalar > &)
 
virtual void operator/= (const scalar)
 
- Public Member Functions inherited from fvPatchField< scalar >
 TypeName ("fvPatchField")
 
 declareRunTimeSelectionTable (tmp, fvPatchField, patch,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF),(p, iF))
 
 declareRunTimeSelectionTable (tmp, fvPatchField, patchMapper,(const fvPatchField< Type > &ptf, const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const fvPatchFieldMapper &m),(dynamic_cast< const fvPatchFieldType & >(ptf), p, iF, m))
 
 declareRunTimeSelectionTable (tmp, fvPatchField, dictionary,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const dictionary &dict),(p, iF, dict))
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Type &value)
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)
 
 fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 
 fvPatchField (const fvPatchField< Type > &)
 
 fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 
virtual tmp< fvPatchField< Type > > clone (const DimensionedField< Type, volMesh > &iF) const
 
Foam::tmp< Foam::fvPatchField< Type > > NewCalculatedType (const fvPatch &p)
 
Foam::tmp< Foam::fvPatchField< Type > > NewCalculatedType (const fvPatchField< Type2 > &pf)
 
virtual ~fvPatchField ()=default
 
bool useImplicit () const noexcept
 
bool useImplicit (bool on) noexcept
 
virtual bool coupled () const
 
const objectRegistrydb () const
 
const fvPatchpatch () const
 
const DimensionedField< Type, volMesh > & internalField () const
 
const Field< Type > & primitiveField () const
 
const wordpatchType () const
 
wordpatchType ()
 
bool updated () const
 
bool manipulatedMatrix () const
 
virtual void rmap (const fvPatchField< Type > &, const labelList &)
 
virtual tmp< Field< Type > > snGrad (const scalarField &deltaCoeffs) const
 
virtual void updateWeightedCoeffs (const scalarField &weights)
 
virtual tmp< Field< Type > > patchInternalField () const
 
virtual void patchInternalField (Field< Type > &) const
 
virtual tmp< Field< Type > > patchNeighbourField () const
 
virtual void initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
 
virtual tmp< Field< Type > > valueInternalCoeffs (const tmp< Field< scalar >> &) const
 
virtual tmp< Field< Type > > valueBoundaryCoeffs (const tmp< Field< scalar >> &) const
 
virtual tmp< Field< Type > > gradientInternalCoeffs (const scalarField &deltaCoeffs) const
 
virtual tmp< Field< Type > > gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
 
virtual void manipulateMatrix (fvMatrix< Type > &matrix)
 
virtual void manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)
 
virtual void manipulateMatrix (fvMatrix< Type > &matrix, const label iMatrix, const direction cmp)
 
void check (const fvPatchField< Type > &) const
 
virtual void operator= (const UList< Type > &)
 
virtual void operator= (const fvPatchField< Type > &)
 
virtual void operator= (const Type &)
 
virtual void operator+= (const fvPatchField< Type > &)
 
virtual void operator+= (const Field< Type > &)
 
virtual void operator+= (const Type &)
 
virtual void operator-= (const fvPatchField< Type > &)
 
virtual void operator-= (const Field< Type > &)
 
virtual void operator-= (const Type &)
 
virtual void operator== (const fvPatchField< Type > &)
 
virtual void operator== (const Field< Type > &)
 
virtual void operator== (const Type &)
 
- Public Member Functions inherited from updateableSnGrad
 updateableSnGrad ()=default
 
virtual ~updateableSnGrad ()=default
 

Additional Inherited Members

- Public Types inherited from fvPatchField< scalar >
typedef fvPatch Patch
 
typedef calculatedFvPatchField< Type > Calculated
 
- Static Public Member Functions inherited from fvPatchField< scalar >
static tmp< fvPatchField< Type > > New (const word &, const fvPatch &, const DimensionedField< Type, volMesh > &)
 
static tmp< fvPatchField< Type > > New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)
 
static tmp< fvPatchField< Type > > New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 
static tmp< fvPatchField< Type > > New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 
static tmp< fvPatchField< Type > > NewCalculatedType (const fvPatch &)
 
static tmp< fvPatchField< Type > > NewCalculatedType (const fvPatchField< Type2 > &)
 
static const wordcalculatedType ()
 
- Static Public Attributes inherited from fvPatchField< scalar >
static int disallowGenericFvPatchField
 

Detailed Description

The prghPermeableAlphaTotalPressure is a mixed boundary condition for the p_rgh variable in multiphase flows.

It switches between an open boundary using the prghTotalPressure boundary condition and a wall condition using the fixedFluxPressure boundary condition.

In the prghPermeableAlphaTotalPressure, 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 pressurePermeableAlphaInletOutletVelocity for the U variable.

Usage
Example of the boundary condition specification:
<patchName>
{
    // Mandatory entries
    type            prghPermeableAlphaTotalPressure;
    p               uniform 0;

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

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

where the entries mean:

Property Description Type Reqd Deflt
p Total pressure PatchFunction1<scalar> yes -
phi Name of flux field word no phi
rho Name of density field word no rho
U Name of velocity field word no U
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 146 of file prghPermeableAlphaTotalPressureFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ prghPermeableAlphaTotalPressureFvPatchScalarField() [1/5]

Definition at line 30 of file prghPermeableAlphaTotalPressureFvPatchScalarField.C.

Referenced by prghPermeableAlphaTotalPressureFvPatchScalarField::clone().

Here is the caller graph for this function:

◆ prghPermeableAlphaTotalPressureFvPatchScalarField() [2/5]

prghPermeableAlphaTotalPressureFvPatchScalarField ( const fvPatch p,
const DimensionedField< scalar, volMesh > &  iF,
const dictionary dict 
)

Definition at line 52 of file prghPermeableAlphaTotalPressureFvPatchScalarField.C.

References dict, and p.

◆ prghPermeableAlphaTotalPressureFvPatchScalarField() [3/5]

◆ prghPermeableAlphaTotalPressureFvPatchScalarField() [4/5]

◆ prghPermeableAlphaTotalPressureFvPatchScalarField() [5/5]

Member Function Documentation

◆ TypeName()

TypeName ( "prghPermeableAlphaTotalPressure"  )

◆ clone() [1/2]

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

◆ clone() [2/2]

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

◆ autoMap()

void autoMap ( const fvPatchFieldMapper m)
virtual

◆ rmap()

void rmap ( const fvPatchScalarField ptf,
const labelList addr 
)
virtual

◆ updateCoeffs()

void updateCoeffs ( )
virtual

◆ updateSnGrad()

void updateSnGrad ( const scalarField snGradp)
virtual

◆ write()

void write ( Ostream os) const
virtual

Reimplemented from mixedFvPatchField< scalar >.

Definition at line 262 of file prghPermeableAlphaTotalPressureFvPatchScalarField.C.

References os(), mixedFvPatchField< Type >::write(), and Ostream::writeEntryIfDifferent().

Here is the call graph for this function:

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