This boundary condition provides a turbulent kinetic energy condition, based on user-supplied turbulence intensity, defined as a fraction of the mean velocity: More...

Inheritance diagram for turbulentIntensityKineticEnergyInletFvPatchScalarField:

[legend]

Collaboration diagram for turbulentIntensityKineticEnergyInletFvPatchScalarField:

[legend]

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

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

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

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

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

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

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

virtual tmp< fvPatchScalarField >	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...

Detailed Description

This boundary condition provides a turbulent kinetic energy condition, based on user-supplied turbulence intensity, defined as a fraction of the mean velocity:

$k_p = 1.5 (I |U|)^2$

where

	=	kinetic energy at the patch
	=	turbulence intensity
	=	velocity field

In the event of reverse flow, a zero-gradient condition is applied.

Usage

Property	Description	Required	Default value
`intensity`	fraction of mean field [0-1]	yes
`U`	velocity field name	no	U
`phi`	flux field name	no	phi

Example of the boundary condition specification:

    <patchName>
    {
        type        turbulentIntensityKineticEnergyInlet;
        intensity   0.05;           // 5% turbulence
        value       uniform 1;      // placeholder
    }

See also: Foam::inletOutletFvPatchField

Source files

Definition at line 118 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ turbulentIntensityKineticEnergyInletFvPatchScalarField() [1/5]

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

Construct from patch and internal field.

Definition at line 32 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.C.

Referenced by turbulentIntensityKineticEnergyInletFvPatchScalarField::clone().

Here is the caller graph for this function:

◆ turbulentIntensityKineticEnergyInletFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 62 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.C.

References dict, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, p, and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ turbulentIntensityKineticEnergyInletFvPatchScalarField() [3/5]

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

Construct by mapping given.

turbulentIntensityKineticEnergyInletFvPatchScalarField onto a new patch

Definition at line 48 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.C.

◆ turbulentIntensityKineticEnergyInletFvPatchScalarField() [4/5]

turbulentIntensityKineticEnergyInletFvPatchScalarField ( const turbulentIntensityKineticEnergyInletFvPatchScalarField & ptf )

Construct as copy.

Definition at line 96 of file turbulentIntensityKineticEnergyInletFvPatchScalarField.C.

◆ turbulentIntensityKineticEnergyInletFvPatchScalarField() [5/5]

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