Loading...
Searching...
No Matches
variableHeightFlowRateFvPatchScalarField Class Reference
Boundary conditions » Inlet

This boundary condition provides a phase fraction condition based on the local flow conditions, whereby the values are constrained to lay between user-specified upper and lower bounds. The behaviour is described by: More...

#include <variableHeightFlowRateFvPatchField.H>

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

Public Member Functions

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

Protected Attributes

word phiName_
 Name of flux field.
scalar lowerBound_
 Lower bound for alpha1.
scalar upperBound_
 Upper bound for alpha1.

Detailed Description

This boundary condition provides a phase fraction condition based on the local flow conditions, whereby the values are constrained to lay between user-specified upper and lower bounds. The behaviour is described by:

if alpha > upperBound:

  • apply a fixed value condition, with a uniform level of the upper bound

if lower bound <= alpha <= upper bound:

  • apply a zero-gradient condition

if alpha < lowerBound:

  • apply a fixed value condition, with a uniform level of the lower bound
Usage
Property Description Required Default value
phi flux field name no phi
lowerBound lower bound for clipping yes
upperBound upper bound for clipping yes

Example of the boundary condition specification: 

    <patchName>
    {
        type            variableHeightFlowRate;
        lowerBound      0.0;
        upperBound      0.9;
        value           uniform 0;
    }
Source files

Definition at line 99 of file variableHeightFlowRateFvPatchField.H.

Constructor & Destructor Documentation

◆ variableHeightFlowRateFvPatchScalarField() [1/5]

variableHeightFlowRateFvPatchScalarField ( const fvPatch & p,
const DimensionedField< scalar, volMesh > & iF )

Construct from patch and internal field.

Definition at line 30 of file variableHeightFlowRateFvPatchField.C.

References lowerBound_, p, phiName_, and upperBound_.

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

Here is the caller graph for this function:

◆ variableHeightFlowRateFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 64 of file variableHeightFlowRateFvPatchField.C.

References dict, lowerBound_, p, phiName_, fvPatchFieldBase::readDict(), and upperBound_.

Here is the call graph for this function:

◆ variableHeightFlowRateFvPatchScalarField() [3/5]

variableHeightFlowRateFvPatchScalarField ( const variableHeightFlowRateFvPatchScalarField & ptf,
const fvPatch & p,
const DimensionedField< scalar, volMesh > & iF,
const fvPatchFieldMapper & mapper )

Construct by mapping given.

variableHeightFlowRateFvPatchScalarField onto a new patch

Definition at line 48 of file variableHeightFlowRateFvPatchField.C.

References lowerBound_, p, phiName_, upperBound_, and variableHeightFlowRateFvPatchScalarField().

Here is the call graph for this function:

◆ variableHeightFlowRateFvPatchScalarField() [4/5]

variableHeightFlowRateFvPatchScalarField ( const variableHeightFlowRateFvPatchScalarField & ptf)

Construct as copy.

Definition at line 91 of file variableHeightFlowRateFvPatchField.C.

References lowerBound_, phiName_, upperBound_, and variableHeightFlowRateFvPatchScalarField().

Here is the call graph for this function:

◆ variableHeightFlowRateFvPatchScalarField() [5/5]

variableHeightFlowRateFvPatchScalarField ( const variableHeightFlowRateFvPatchScalarField & ptf,
const DimensionedField< scalar, volMesh > & iF )

Construct as copy setting internal field reference.

Definition at line 104 of file variableHeightFlowRateFvPatchField.C.

References lowerBound_, phiName_, upperBound_, and variableHeightFlowRateFvPatchScalarField().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "variableHeightFlowRate" )

Runtime scalar information.

References variableHeightFlowRateFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [1/2]

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

Return a clone.

Definition at line 186 of file variableHeightFlowRateFvPatchField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ clone() [2/2]

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

Clone with an internal field reference.

Definition at line 194 of file variableHeightFlowRateFvPatchField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 120 of file variableHeightFlowRateFvPatchField.C.

References forAll, lowerBound_, phiName_, and upperBound_.

◆ write()

void write ( Ostream & os) const
virtual

Write.

Definition at line 162 of file variableHeightFlowRateFvPatchField.C.

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

Here is the call graph for this function:

Member Data Documentation

◆ phiName_

word phiName_
protected

Name of flux field.

Definition at line 111 of file variableHeightFlowRateFvPatchField.H.

Referenced by updateCoeffs(), variableHeightFlowRateFvPatchScalarField(), variableHeightFlowRateFvPatchScalarField(), variableHeightFlowRateFvPatchScalarField(), variableHeightFlowRateFvPatchScalarField(), variableHeightFlowRateFvPatchScalarField(), and write().

◆ lowerBound_

scalar lowerBound_
protected

Lower bound for alpha1.

Definition at line 116 of file variableHeightFlowRateFvPatchField.H.

Referenced by updateCoeffs(), variableHeightFlowRateFvPatchScalarField(), variableHeightFlowRateFvPatchScalarField(), variableHeightFlowRateFvPatchScalarField(), variableHeightFlowRateFvPatchScalarField(), variableHeightFlowRateFvPatchScalarField(), and write().

◆ upperBound_

scalar upperBound_
protected

Upper bound for alpha1.

Definition at line 121 of file variableHeightFlowRateFvPatchField.H.

Referenced by updateCoeffs(), variableHeightFlowRateFvPatchScalarField(), variableHeightFlowRateFvPatchScalarField(), variableHeightFlowRateFvPatchScalarField(), variableHeightFlowRateFvPatchScalarField(), variableHeightFlowRateFvPatchScalarField(), and write().

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