variableHeightFlowRateFvPatchScalarField Class Reference

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

Inheritance diagram for variableHeightFlowRateFvPatchScalarField:

Collaboration diagram for variableHeightFlowRateFvPatchScalarField:

Public Member Functions
	TypeName ("variableHeightFlowRate")
	variableHeightFlowRateFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	variableHeightFlowRateFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	variableHeightFlowRateFvPatchScalarField (const variableHeightFlowRateFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	variableHeightFlowRateFvPatchScalarField (const variableHeightFlowRateFvPatchScalarField &)
virtual tmp< fvPatchField< scalar > >	clone () const
	variableHeightFlowRateFvPatchScalarField (const variableHeightFlowRateFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
virtual tmp< fvPatchField< scalar > >	clone (const DimensionedField< scalar, volMesh > &iF) const
virtual void	updateCoeffs ()
virtual void	write (Ostream &) const

Protected Attributes
word	phiName_
scalar	lowerBound_
scalar	upperBound_

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

• variableHeightFlowRateFvPatchField.H
• variableHeightFlowRateFvPatchScalarField.C

Definition at line 99 of file variableHeightFlowRateFvPatchField.H.

Constructor & Destructor Documentation

variableHeightFlowRateFvPatchScalarField() [1/5]

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

Definition at line 32 of file variableHeightFlowRateFvPatchField.C.

Referenced by variableHeightFlowRateFvPatchScalarField::clone().

Here is the caller graph for this function:

variableHeightFlowRateFvPatchScalarField() [2/5]

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

Definition at line 66 of file variableHeightFlowRateFvPatchField.C.

References dict, and p.

variableHeightFlowRateFvPatchScalarField() [3/5]

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

Definition at line 50 of file variableHeightFlowRateFvPatchField.C.

variableHeightFlowRateFvPatchScalarField() [4/5]

variableHeightFlowRateFvPatchScalarField

(

const variableHeightFlowRateFvPatchScalarField &

ptf

)

Definition at line 99 of file variableHeightFlowRateFvPatchField.C.

variableHeightFlowRateFvPatchScalarField() [5/5]

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

Definition at line 112 of file variableHeightFlowRateFvPatchField.C.

Member Function Documentation

TypeName()

TypeName

(

"variableHeightFlowRate"

)

clone() [1/2]

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

inlinevirtual

Definition at line 158 of file variableHeightFlowRateFvPatchField.H.

References variableHeightFlowRateFvPatchScalarField::variableHeightFlowRateFvPatchScalarField().

Here is the call graph for this function:

clone() [2/2]

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

inlinevirtual

Definition at line 175 of file variableHeightFlowRateFvPatchField.H.

References variableHeightFlowRateFvPatchScalarField::variableHeightFlowRateFvPatchScalarField().

Here is the call graph for this function:

updateCoeffs()

void updateCoeffs ( )

virtual

Definition at line 126 of file variableHeightFlowRateFvPatchField.C.

References forAll, variableHeightFlowRateFvPatchScalarField::lowerBound_, Foam::foamVersion::patch, variableHeightFlowRateFvPatchScalarField::phiName_, and variableHeightFlowRateFvPatchScalarField::upperBound_.

write()

void write ( Ostream &  os ) const

virtual

Definition at line 169 of file variableHeightFlowRateFvPatchField.C.

References os(), fvPatchField::write(), Ostream::writeEntry(), and Ostream::writeEntryIfDifferent().

Here is the call graph for this function:

Member Data Documentation

phiName_

word phiName_

protected

Definition at line 109 of file variableHeightFlowRateFvPatchField.H.

Referenced by variableHeightFlowRateFvPatchScalarField::updateCoeffs().

lowerBound_

scalar lowerBound_

protected

Definition at line 112 of file variableHeightFlowRateFvPatchField.H.

Referenced by variableHeightFlowRateFvPatchScalarField::updateCoeffs().

upperBound_

scalar upperBound_

protected

Definition at line 115 of file variableHeightFlowRateFvPatchField.H.

Referenced by variableHeightFlowRateFvPatchScalarField::updateCoeffs().

---

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

• src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H
• src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.C