This boundary condition adjusts the velocity for the given phase to achieve the specified mean thus causing the phase-fraction to adjust according to the mass flow rate. More...

Inheritance diagram for outletPhaseMeanVelocityFvPatchVectorField:

[legend]

Collaboration diagram for outletPhaseMeanVelocityFvPatchVectorField:

[legend]

Public Member Functions
	TypeName ("outletPhaseMeanVelocity")
	Runtime type information. More...

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

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

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

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

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

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

virtual tmp< fvPatchVectorField >	clone (const DimensionedField< vector, volMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

scalar	Umean () const
	Return the flux. More...

scalar &	Umean ()
	Return reference to the flux to allow adjustment. More...

virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. More...

virtual void	write (Ostream &) const
	Write. More...

Private Attributes
scalar	Umean_
	Inlet integral flow rate. More...

word	alphaName_
	Name of the phase-fraction field. More...

Detailed Description

This boundary condition adjusts the velocity for the given phase to achieve the specified mean thus causing the phase-fraction to adjust according to the mass flow rate.

Typical usage is as the outlet condition for a towing-tank ship simulation to maintain the outlet water level at the level as the inlet.

Patch usage

Property	Description	Required	Default value
`Umean`	mean velocity normal to the boundary [m/s]	yes
`alpha`	phase-fraction field	yes

Example of the boundary condition specification:

    myPatch
    {
        type            outletPhaseMeanVelocity;
        Umean           1.2;
        alpha           alpha.water;
        value           uniform (1.2 0 0);
    }

See also: Foam::mixedFvPatchField Foam::variableHeightFlowRateInletVelocityFvPatchVectorField

Source files

Definition at line 92 of file outletPhaseMeanVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ outletPhaseMeanVelocityFvPatchVectorField() [1/5]

outletPhaseMeanVelocityFvPatchVectorField	(	const fvPatch &	p,
		const DimensionedField< vector, volMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 36 of file outletPhaseMeanVelocityFvPatchVectorField.C.

Referenced by outletPhaseMeanVelocityFvPatchVectorField::clone().

Here is the caller graph for this function:

◆ outletPhaseMeanVelocityFvPatchVectorField() [2/5]

outletPhaseMeanVelocityFvPatchVectorField	(	const fvPatch &	p,
		const DimensionedField< vector, volMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 68 of file outletPhaseMeanVelocityFvPatchVectorField.C.

References dict, p, and vectorField().

Here is the call graph for this function:

◆ outletPhaseMeanVelocityFvPatchVectorField() [3/5]

outletPhaseMeanVelocityFvPatchVectorField	(	const outletPhaseMeanVelocityFvPatchVectorField &	ptf,
		const fvPatch &	p,
		const DimensionedField< vector, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Construct by mapping given.

outletPhaseMeanVelocityFvPatchVectorField onto a new patch

Definition at line 53 of file outletPhaseMeanVelocityFvPatchVectorField.C.

◆ outletPhaseMeanVelocityFvPatchVectorField() [4/5]

outletPhaseMeanVelocityFvPatchVectorField ( const outletPhaseMeanVelocityFvPatchVectorField & ptf )

Construct as copy.

Definition at line 98 of file outletPhaseMeanVelocityFvPatchVectorField.C.

◆ outletPhaseMeanVelocityFvPatchVectorField() [5/5]

outletPhaseMeanVelocityFvPatchVectorField	(	const outletPhaseMeanVelocityFvPatchVectorField &	ptf,
		const DimensionedField< vector, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 110 of file outletPhaseMeanVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "outletPhaseMeanVelocity" )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchVectorField> clone ( ) const

inlinevirtual

Construct and return a clone.

Definition at line 146 of file outletPhaseMeanVelocityFvPatchVectorField.H.

References outletPhaseMeanVelocityFvPatchVectorField::outletPhaseMeanVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ clone() [2/2]

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

inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 163 of file outletPhaseMeanVelocityFvPatchVectorField.H.

◆ Umean() [1/2]

scalar Umean ( ) const

inline

Return the flux.

Definition at line 183 of file outletPhaseMeanVelocityFvPatchVectorField.H.

References outletPhaseMeanVelocityFvPatchVectorField::Umean_.

◆ Umean() [2/2]

scalar& Umean ( )

inline

Return reference to the flux to allow adjustment.

Definition at line 189 of file outletPhaseMeanVelocityFvPatchVectorField.H.

References outletPhaseMeanVelocityFvPatchVectorField::Umean_.

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 123 of file outletPhaseMeanVelocityFvPatchVectorField.C.

References outletPhaseMeanVelocityFvPatchVectorField::alphaName_, Foam::gSum(), Foam::max(), Foam::min(), outletPhaseMeanVelocityFvPatchVectorField::Umean_, fvPatchField< Type >::updateCoeffs(), and Vector< scalar >::zero.

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 162 of file outletPhaseMeanVelocityFvPatchVectorField.C.

References token::END_STATEMENT, Foam::nl, fvPatchField::write(), and Ostream::writeKeyword().

Here is the call graph for this function:

Field Documentation

◆ Umean_

scalar Umean_

private

Inlet integral flow rate.

Definition at line 99 of file outletPhaseMeanVelocityFvPatchVectorField.H.

Referenced by outletPhaseMeanVelocityFvPatchVectorField::Umean(), and outletPhaseMeanVelocityFvPatchVectorField::updateCoeffs().

◆ alphaName_

word alphaName_

private

Name of the phase-fraction field.

Definition at line 102 of file outletPhaseMeanVelocityFvPatchVectorField.H.

Referenced by outletPhaseMeanVelocityFvPatchVectorField::updateCoeffs().

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

src/finiteVolume/fields/fvPatchFields/derived/outletPhaseMeanVelocity/outletPhaseMeanVelocityFvPatchVectorField.H
src/finiteVolume/fields/fvPatchFields/derived/outletPhaseMeanVelocity/outletPhaseMeanVelocityFvPatchVectorField.C

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ outletPhaseMeanVelocityFvPatchVectorField() [1/5]

◆ outletPhaseMeanVelocityFvPatchVectorField() [2/5]

◆ outletPhaseMeanVelocityFvPatchVectorField() [3/5]

◆ outletPhaseMeanVelocityFvPatchVectorField() [4/5]

◆ outletPhaseMeanVelocityFvPatchVectorField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ Umean() [1/2]

◆ Umean() [2/2]

◆ updateCoeffs()

◆ write()

Field Documentation

◆ Umean_

◆ alphaName_