This boundary condition provides a turbulence dissipation wall function condition for low- and high-Reynolds number turbulent flow cases. More...

Inheritance diagram for epsilonLowReWallFunctionFvPatchScalarField:

[legend]

Collaboration diagram for epsilonLowReWallFunctionFvPatchScalarField:

[legend]

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

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

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

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

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

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

	epsilonLowReWallFunctionFvPatchScalarField (const epsilonLowReWallFunctionFvPatchScalarField &, 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	~epsilonLowReWallFunctionFvPatchScalarField ()
	Destructor. More...

Public Member Functions inherited from epsilonWallFunctionFvPatchScalarField
	TypeName ("epsilonWallFunction")
	Runtime type information. More...

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

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

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

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

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

virtual	~epsilonWallFunctionFvPatchScalarField ()
	Destructor. More...

scalarField &	G (bool init=false)
	Return non-const access to the master's G field. More...

scalarField &	epsilon (bool init=false)
	Return non-const access to the master's epsilon field. More...

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

virtual void	updateCoeffs (const scalarField &weights)
	Update the coefficients associated with the patch field. More...

virtual void	manipulateMatrix (fvMatrix< scalar > &matrix)
	Manipulate matrix. More...

virtual void	manipulateMatrix (fvMatrix< scalar > &matrix, const scalarField &weights)
	Manipulate matrix with given weights. More...

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

Public Member Functions inherited from fixedValueFvPatchField< scalar >
	TypeName ("fixedValue")
	Runtime type information. More...

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

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

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

	fixedValueFvPatchField (const fixedValueFvPatchField< scalar > &)
	Construct as copy. More...

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

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

virtual bool	fixesValue () const
	Return true if this patch field fixes a value. More...

virtual tmp< Field< scalar > >	valueInternalCoeffs (const tmp< scalarField > &) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< scalar > >	valueBoundaryCoeffs (const tmp< scalarField > &) const
	Return the matrix source coefficients corresponding to the. More...

virtual tmp< Field< scalar > >	gradientInternalCoeffs () const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< scalar > >	gradientBoundaryCoeffs () const
	Return the matrix source coefficients corresponding to the. More...

virtual void	operator= (const UList< scalar > &)

virtual void	operator= (const fvPatchField< scalar > &)

virtual void	operator= (const scalar &)

virtual void	operator+= (const fvPatchField< scalar > &)

virtual void	operator+= (const Field< scalar > &)

virtual void	operator+= (const scalar &)

virtual void	operator-= (const fvPatchField< scalar > &)

virtual void	operator-= (const Field< scalar > &)

virtual void	operator-= (const scalar &)

virtual void	operator*= (const fvPatchField< scalar > &)

virtual void	operator*= (const Field< scalar > &)

virtual void	operator*= (const scalar)

virtual void	operator/= (const fvPatchField< scalar > &)

virtual void	operator/= (const Field< scalar > &)

virtual void	operator/= (const scalar)

Public Member Functions inherited from fvPatchField< scalar >
	TypeName ("fvPatchField")
	Runtime type information. More...

	declareRunTimeSelectionTable (tmp, fvPatchField, patch,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF),(p, iF))

	declareRunTimeSelectionTable (tmp, fvPatchField, patchMapper,(const fvPatchField< Type > &ptf, const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const fvPatchFieldMapper &m),(dynamic_cast< const fvPatchFieldType & >(ptf), p, iF, m))

	declareRunTimeSelectionTable (tmp, fvPatchField, dictionary,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const dictionary &dict),(p, iF, dict))

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

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)
	Construct from patch and internal field and patch type. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
	Construct from patch and internal field and patch field. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=false)
	Construct from patch, internal field and dictionary. More...

	fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given fvPatchField onto a new patch. More...

	fvPatchField (const fvPatchField< Type > &)
	Construct as copy. More...

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

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

Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatch &p)

Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &pf)

virtual	~fvPatchField ()
	Destructor. More...

const objectRegistry &	db () const
	Return local objectRegistry. More...

const fvPatch &	patch () const
	Return patch. More...

const DimensionedField< Type, volMesh > &	dimensionedInternalField () const
	Return dimensioned internal field reference. More...

const Field< Type > &	internalField () const
	Return internal field reference. More...

const word &	patchType () const
	Optional patch type. More...

word &	patchType ()
	Optional patch type. More...

virtual bool	coupled () const
	Return true if this patch field is coupled. More...

bool	updated () const
	Return true if the boundary condition has already been updated. More...

bool	manipulatedMatrix () const
	Return true if the matrix has already been manipulated. More...

virtual void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...

virtual void	rmap (const fvPatchField< Type > &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField. More...

virtual tmp< Field< Type > >	snGrad () const
	Return patch-normal gradient. More...

virtual tmp< Field< Type > >	snGrad (const scalarField &deltaCoeffs) const
	Return patch-normal gradient for coupled-patches. More...

virtual tmp< Field< Type > >	patchInternalField () const
	Return internal field next to patch as patch field. More...

virtual void	patchInternalField (Field< Type > &) const
	Return internal field next to patch as patch field. More...

virtual tmp< Field< Type > >	patchNeighbourField () const
	Return patchField on the opposite patch of a coupled patch. More...

virtual void	initEvaluate (const Pstream::commsTypes commsType=Pstream::blocking)
	Initialise the evaluation of the patch field. More...

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::blocking)
	Evaluate the patch field, sets Updated to false. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs (const scalarField &deltaCoeffs) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
	Return the matrix source coefficients corresponding to the. More...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix)
	Manipulate matrix. More...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)
	Manipulate matrix with given weights. More...

void	writeEntryIfDifferent (Ostream &os, const word &entryName, const EntryType &value1, const EntryType &value2) const
	Helper function to write the keyword and entry only if the. More...

void	check (const fvPatchField< Type > &) const
	Check fvPatchField<Type> against given fvPatchField<Type> More...

virtual void	operator= (const UList< Type > &)

virtual void	operator= (const fvPatchField< Type > &)

virtual void	operator= (const Type &)

virtual void	operator+= (const fvPatchField< Type > &)

virtual void	operator+= (const Field< Type > &)

virtual void	operator+= (const Type &)

virtual void	operator-= (const fvPatchField< Type > &)

virtual void	operator-= (const Field< Type > &)

virtual void	operator-= (const Type &)

virtual void	operator== (const fvPatchField< Type > &)

virtual void	operator== (const Field< Type > &)

virtual void	operator== (const Type &)

Protected Member Functions
scalar	yPlusLam (const scalar kappa, const scalar E)
	Calculate the Y+ at the edge of the laminar sublayer. More...

virtual void	calculate (const turbulenceModel &turbulence, const List< scalar > &cornerWeights, const fvPatch &patch, scalarField &G, scalarField &epsilon)
	Calculate the epsilon and G. More...

Protected Member Functions inherited from epsilonWallFunctionFvPatchScalarField
virtual void	checkType ()
	Check the type of the patch. More...

virtual void	writeLocalEntries (Ostream &) const
	Write local wall function variables. More...

virtual void	setMaster ()
	Set the master patch - master is responsible for updating all. More...

virtual void	createAveragingWeights ()
	Create the averaging weights for cells which are bounded by. More...

virtual epsilonWallFunctionFvPatchScalarField &	epsilonPatch (const label patchi)
	Helper function to return non-const access to an epsilon patch. More...

virtual void	calculateTurbulenceFields (const turbulenceModel &turbulence, scalarField &G0, scalarField &epsilon0)
	Main driver to calculate the turbulence fields. More...

virtual label &	master ()
	Return non-const access to the master patch ID. More...

Protected Attributes
scalar	yPlusLam_
	Y+ at the edge of the laminar sublayer. More...

Protected Attributes inherited from epsilonWallFunctionFvPatchScalarField
scalar	Cmu_
	Cmu coefficient. More...

scalar	kappa_
	Von Karman constant. More...

scalar	E_
	E coefficient. More...

scalarField	G_
	Local copy of turbulence G field. More...

scalarField	epsilon_
	Local copy of turbulence epsilon field. More...

bool	initialised_
	Initialised flag. More...

label	master_
	Master patch ID. More...

List< List< scalar > >	cornerWeights_
	List of averaging corner weights. More...

Additional Inherited Members
Public Types inherited from fvPatchField< scalar >
typedef fvPatch	Patch

Static Public Member Functions inherited from fvPatchField< scalar >
static tmp< fvPatchField< Type > >	New (const word &, const fvPatch &, const DimensionedField< Type, volMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< fvPatchField< Type > >	New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< fvPatchField< Type > >	New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Return a pointer to a new patchField created on freestore from. More...

static tmp< fvPatchField< Type > >	New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Return a pointer to a new patchField created on freestore. More...

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatch &)
	Return a pointer to a new calculatedFvPatchField created on. More...

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &)
	Return a pointer to a new calculatedFvPatchField created on. More...

static const word &	calculatedType ()
	Return the type of the calculated for of fvPatchField. More...

Static Public Attributes inherited from fvPatchField< scalar >
static int	disallowGenericFvPatchField
	Debug switch to disallow the use of genericFvPatchField. More...

Static Protected Attributes inherited from epsilonWallFunctionFvPatchScalarField
static scalar	tolerance_ = 1e-5
	Tolerance used in weighted calculations. More...

Detailed Description

This boundary condition provides a turbulence dissipation wall function condition for low- and high-Reynolds number turbulent flow cases.

The condition can be applied to wall boundaries, whereby it inserts near wall epsilon values directly into the epsilon equation to act as a constraint.

The model operates in two modes, based on the computed laminar-to-turbulent switch-over y+ value derived from kappa and E.

Patch usage

Property	Description	Required	Default value
`Cmu`	model coefficient	no	0.09
`kappa`	Von Karman constant	no	0.41
`E`	model coefficient	no	9.8

Example of the boundary condition specification:

    myPatch
    {
        type            epsilonLowReWallFunction;
    }

See also: Foam::epsilonWallFunctionFvPatchScalarField

Source files

Definition at line 99 of file epsilonLowReWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ epsilonLowReWallFunctionFvPatchScalarField() [1/5]

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

Construct from patch and internal field.

Definition at line 119 of file epsilonLowReWallFunctionFvPatchScalarField.C.

Referenced by epsilonLowReWallFunctionFvPatchScalarField::clone().

Here is the caller graph for this function:

◆ epsilonLowReWallFunctionFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 145 of file epsilonLowReWallFunctionFvPatchScalarField.C.

◆ epsilonLowReWallFunctionFvPatchScalarField() [3/5]

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

Construct by mapping given.

epsilonLowReWallFunctionFvPatchScalarField onto a new patch

Definition at line 131 of file epsilonLowReWallFunctionFvPatchScalarField.C.

◆ epsilonLowReWallFunctionFvPatchScalarField() [4/5]

epsilonLowReWallFunctionFvPatchScalarField ( const epsilonLowReWallFunctionFvPatchScalarField & ewfpsf )

Construct as copy.

Definition at line 158 of file epsilonLowReWallFunctionFvPatchScalarField.C.

◆ epsilonLowReWallFunctionFvPatchScalarField() [5/5]

epsilonLowReWallFunctionFvPatchScalarField	(	const epsilonLowReWallFunctionFvPatchScalarField &	ewfpsf,
		const DimensionedField< scalar, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 169 of file epsilonLowReWallFunctionFvPatchScalarField.C.

◆ ~epsilonLowReWallFunctionFvPatchScalarField()

virtual ~epsilonLowReWallFunctionFvPatchScalarField ( )

inlinevirtual

Destructor.

Definition at line 197 of file epsilonLowReWallFunctionFvPatchScalarField.H.

Member Function Documentation

◆ yPlusLam()

Foam::scalar yPlusLam	(	const scalar	kappa,
		const scalar	E
	)

protected

Calculate the Y+ at the edge of the laminar sublayer.

Definition at line 35 of file epsilonLowReWallFunctionFvPatchScalarField.C.

References Foam::constant::electromagnetic::kappa, Foam::log(), and Foam::max().

Here is the call graph for this function:

◆ calculate()

void calculate	(	const turbulenceModel &	turbulence,
		const List< scalar > &	cornerWeights,
		const fvPatch &	patch,
		scalarField &	G,
		scalarField &	epsilon
	)

protectedvirtual

Calculate the epsilon and G.

Reimplemented from epsilonWallFunctionFvPatchScalarField.

Definition at line 52 of file epsilonLowReWallFunctionFvPatchScalarField.C.

References GeometricField::boundaryField(), Foam::constant::electromagnetic::epsilon0, fvPatch::faceCells(), forAll, Foam::constant::universal::G, Foam::constant::electromagnetic::G0, turbulenceModel::GName(), fvPatch::index(), k, turbulenceModel::k(), Foam::mag(), turbulenceModel::nu(), turbulenceModel::nut(), patchi, Foam::pow(), Foam::pow025(), fvPatchField::snGrad(), Foam::sqr(), Foam::sqrt(), turbulenceModel::U(), w(), y, and turbulenceModel::y().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "epsilonLowReWallFunction" )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const

inlinevirtual

Construct and return a clone.

Reimplemented from epsilonWallFunctionFvPatchScalarField.

Definition at line 169 of file epsilonLowReWallFunctionFvPatchScalarField.H.

References epsilonLowReWallFunctionFvPatchScalarField::epsilonLowReWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [2/2]

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

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from epsilonWallFunctionFvPatchScalarField.

Definition at line 186 of file epsilonLowReWallFunctionFvPatchScalarField.H.

References epsilonLowReWallFunctionFvPatchScalarField::epsilonLowReWallFunctionFvPatchScalarField().

Here is the call graph for this function:

Field Documentation

◆ yPlusLam_

scalar yPlusLam_

protected

Y+ at the edge of the laminar sublayer.

Definition at line 109 of file epsilonLowReWallFunctionFvPatchScalarField.H.

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

src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonLowReWallFunction/epsilonLowReWallFunctionFvPatchScalarField.H
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonLowReWallFunction/epsilonLowReWallFunctionFvPatchScalarField.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ epsilonLowReWallFunctionFvPatchScalarField() [1/5]

◆ epsilonLowReWallFunctionFvPatchScalarField() [2/5]

◆ epsilonLowReWallFunctionFvPatchScalarField() [3/5]

◆ epsilonLowReWallFunctionFvPatchScalarField() [4/5]

◆ epsilonLowReWallFunctionFvPatchScalarField() [5/5]

◆ ~epsilonLowReWallFunctionFvPatchScalarField()

Member Function Documentation

◆ yPlusLam()

◆ calculate()

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

Field Documentation

◆ yPlusLam_