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:

[legend]

Collaboration diagram for variableHeightFlowRateFvPatchScalarField:

[legend]

Public Member Functions
	TypeName ("variableHeightFlowRate")
	Runtime scalar information. More...

	variableHeightFlowRateFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field. More...

	variableHeightFlowRateFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	variableHeightFlowRateFvPatchScalarField (const variableHeightFlowRateFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given. More...

	variableHeightFlowRateFvPatchScalarField (const variableHeightFlowRateFvPatchScalarField &)
	Construct as copy. More...

virtual tmp< fvPatchField< scalar > >	clone () const
	Construct and return a clone. More...

	variableHeightFlowRateFvPatchScalarField (const variableHeightFlowRateFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< fvPatchField< scalar > >	clone (const DimensionedField< scalar, 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...

Protected Attributes
word	phiName_
	Name of flux field. More...

scalar	lowerBound_
	Lower bound for alpha1. More...

scalar	upperBound_
	Upper bound for alpha1. More...

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 101 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 36 of file variableHeightFlowRateFvPatchField.C.

Referenced by variableHeightFlowRateFvPatchScalarField::clone(), and variableHeightFlowRateFvPatchScalarField::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 70 of file variableHeightFlowRateFvPatchField.C.

References dictionary::found(), scalarField(), fvPatch::size(), and variableHeightFlowRateFvPatchScalarField::variableHeightFlowRateFvPatchScalarField().

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 54 of file variableHeightFlowRateFvPatchField.C.

References variableHeightFlowRateFvPatchScalarField::variableHeightFlowRateFvPatchScalarField().

Here is the call graph for this function:

◆ variableHeightFlowRateFvPatchScalarField() [4/5]

variableHeightFlowRateFvPatchScalarField ( const variableHeightFlowRateFvPatchScalarField & ptf )

Construct as copy.

Definition at line 102 of file variableHeightFlowRateFvPatchField.C.

References variableHeightFlowRateFvPatchScalarField::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 115 of file variableHeightFlowRateFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "variableHeightFlowRate" )

Runtime scalar information.

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Definition at line 160 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

Construct and return a clone setting internal field reference.

Definition at line 177 of file variableHeightFlowRateFvPatchField.H.

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

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 129 of file variableHeightFlowRateFvPatchField.C.

References forAll, variableHeightFlowRateFvPatchScalarField::lowerBound_, variableHeightFlowRateFvPatchScalarField::phiName_, and variableHeightFlowRateFvPatchScalarField::upperBound_.

Referenced by variableHeightFlowRateFvPatchScalarField::clone().

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 172 of file variableHeightFlowRateFvPatchField.C.

References token::END_STATEMENT, variableHeightFlowRateFvPatchScalarField::lowerBound_, Foam::makePatchTypeField(), Foam::nl, variableHeightFlowRateFvPatchScalarField::phiName_, variableHeightFlowRateFvPatchScalarField::upperBound_, fvPatchField< Type >::write(), and Ostream::writeKeyword().

Referenced by variableHeightFlowRateFvPatchScalarField::clone().

Here is the call graph for this function:

Here is the caller 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 variableHeightFlowRateFvPatchScalarField::updateCoeffs(), and variableHeightFlowRateFvPatchScalarField::write().

◆ lowerBound_

scalar lowerBound_

protected

Lower bound for alpha1.

Definition at line 114 of file variableHeightFlowRateFvPatchField.H.

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

◆ upperBound_

scalar upperBound_

protected

Upper bound for alpha1.

Definition at line 117 of file variableHeightFlowRateFvPatchField.H.

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

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ variableHeightFlowRateFvPatchScalarField() [1/5]

◆ variableHeightFlowRateFvPatchScalarField() [2/5]

◆ variableHeightFlowRateFvPatchScalarField() [3/5]

◆ variableHeightFlowRateFvPatchScalarField() [4/5]

◆ variableHeightFlowRateFvPatchScalarField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ updateCoeffs()

◆ write()

Member Data Documentation

◆ phiName_

◆ lowerBound_

◆ upperBound_