This boundary condition provides a turbulent kinematic viscosity condition when using wall functions, based on turbulence kinetic energy. More...

Inheritance diagram for nutWallFunctionFvPatchScalarField:

[legend]

Collaboration diagram for nutWallFunctionFvPatchScalarField:

[legend]

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

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

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

	nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &)=delete
	Disallow copy without setting internal field reference. More...

	nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Copy constructor setting internal field reference. More...

scalar	Cmu () const
	Return Cmu. More...

scalar	kappa () const
	Return kappa. More...

scalar	E () const
	Return E. More...

scalar	yPlusLam () const
	Return the Y+ at the edge of the laminar sublayer. More...

virtual tmp< scalarField >	yPlus () const =0
	Calculate and return the yPlus at the boundary. More...

virtual void	map (const fvPatchScalarField &, const fieldMapper &)
	Map the given fvPatchField onto this fvPatchField. More...

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

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

Static Public Member Functions
static const nutWallFunctionFvPatchScalarField &	nutw (const momentumTransportModel &turbModel, const label patchi)
	Return the nut patchField for the given wall patch. More...

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

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

virtual tmp< scalarField >	nut () const =0
	Calculate the turbulence viscosity. More...

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

Protected Attributes
scalar	Cmu_
	Cmu coefficient. More...

scalar	kappa_
	Von Karman constant. More...

scalar	E_
	E coefficient. More...

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

Detailed Description

This boundary condition provides a turbulent kinematic viscosity condition when using wall functions, based on turbulence kinetic energy.

- replicates OpenFOAM v1.5 (and earlier) behaviour

Usage

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

Examples of the boundary condition specification:

    <patchName>
    {
        type            nutWallFunction;
        value           uniform 0;
    }

Reference for the default model coefficients:

        H. Versteeg, W. Malalasekera
        An Introduction to Computational Fluid Dynamics: The Finite Volume
        Method, subsection "3.5.2 k-epsilon model"

See also: Foam::fixedValueFvPatchField

Source files

Definition at line 99 of file nutWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ nutWallFunctionFvPatchScalarField() [1/4]

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

Construct from patch, internal field and dictionary.

Definition at line 68 of file nutWallFunctionFvPatchScalarField.C.

References nutWallFunctionFvPatchScalarField::checkType().

Here is the call graph for this function:

◆ nutWallFunctionFvPatchScalarField() [2/4]

nutWallFunctionFvPatchScalarField	(	const nutWallFunctionFvPatchScalarField &	ptf,
		const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF,
		const fieldMapper &	mapper
	)

Construct by mapping given.

nutWallFunctionFvPatchScalarField onto a new patch

Definition at line 85 of file nutWallFunctionFvPatchScalarField.C.

References nutWallFunctionFvPatchScalarField::checkType().

Here is the call graph for this function:

◆ nutWallFunctionFvPatchScalarField() [3/4]

nutWallFunctionFvPatchScalarField ( const nutWallFunctionFvPatchScalarField & )

delete

Disallow copy without setting internal field reference.

◆ nutWallFunctionFvPatchScalarField() [4/4]

nutWallFunctionFvPatchScalarField	(	const nutWallFunctionFvPatchScalarField &	wfpsf,
		const DimensionedField< scalar, volMesh > &	iF
	)

Copy constructor setting internal field reference.

Definition at line 104 of file nutWallFunctionFvPatchScalarField.C.

References nutWallFunctionFvPatchScalarField::checkType().

Here is the call graph for this function:

Member Function Documentation

◆ checkType()

void checkType ( )

protectedvirtual

Check the type of the patch.

Definition at line 41 of file nutWallFunctionFvPatchScalarField.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.

Referenced by nutWallFunctionFvPatchScalarField::nutWallFunctionFvPatchScalarField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nut()

virtual tmp<scalarField> nut ( ) const

protectedpure virtual

Calculate the turbulence viscosity.

Implemented in nutUWallFunctionFvPatchScalarField, nutUSpaldingWallFunctionFvPatchScalarField, nutURoughWallFunctionFvPatchScalarField, nutLowReWallFunctionFvPatchScalarField, nutkWallFunctionFvPatchScalarField, nutkRoughWallFunctionFvPatchScalarField, and nutkAtmRoughWallFunctionFvPatchScalarField.

◆ writeLocalEntries()

void writeLocalEntries ( Ostream & os ) const

protectedvirtual

Write local wall function variables.

Definition at line 55 of file nutWallFunctionFvPatchScalarField.C.

References Foam::writeEntry().

Referenced by nutkAtmRoughWallFunctionFvPatchScalarField::write(), nutkRoughWallFunctionFvPatchScalarField::write(), nutURoughWallFunctionFvPatchScalarField::write(), nutUSpaldingWallFunctionFvPatchScalarField::write(), and nutUWallFunctionFvPatchScalarField::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "nutWallFunction" )

Runtime type information.

◆ Cmu()

scalar Cmu ( ) const

inline

Return Cmu.

Definition at line 176 of file nutWallFunctionFvPatchScalarField.H.

References nutWallFunctionFvPatchScalarField::Cmu_.

Referenced by fWallFunctionFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

◆ kappa()

scalar kappa ( ) const

inline

Return kappa.

Definition at line 182 of file nutWallFunctionFvPatchScalarField.H.

References nutWallFunctionFvPatchScalarField::kappa_.

Referenced by alphatJayatillekeWallFunctionFvPatchScalarField::alphat(), and alphatJayatillekeWallFunctionFvPatchScalarField::yPlusTherm().

Here is the caller graph for this function:

◆ E()

scalar E ( ) const

inline

Return E.

Definition at line 188 of file nutWallFunctionFvPatchScalarField.H.

References nutWallFunctionFvPatchScalarField::E_.

Referenced by alphatJayatillekeWallFunctionFvPatchScalarField::alphat(), nutkRoughWallFunctionFvPatchScalarField::nut(), nutURoughWallFunctionFvPatchScalarField::yPlus(), and alphatJayatillekeWallFunctionFvPatchScalarField::yPlusTherm().

Here is the caller graph for this function:

◆ nutw()

const Foam::nutWallFunctionFvPatchScalarField & nutw	(	const momentumTransportModel &	turbModel,
		const label	patchi
	)

static

Return the nut patchField for the given wall patch.

Definition at line 123 of file nutWallFunctionFvPatchScalarField.C.

References momentumTransportModel::nut(), and patchi.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yPlusLam() [1/2]

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

static

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

Definition at line 137 of file nutWallFunctionFvPatchScalarField.C.

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

Referenced by fWallFunctionFvPatchScalarField::updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yPlusLam() [2/2]

Foam::scalar yPlusLam ( ) const

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

Definition at line 169 of file nutWallFunctionFvPatchScalarField.C.

Referenced by nutkRoughWallFunctionFvPatchScalarField::nut().

Here is the caller graph for this function:

◆ yPlus()

virtual tmp<scalarField> yPlus ( ) const

pure virtual

Calculate and return the yPlus at the boundary.

Implemented in nutUWallFunctionFvPatchScalarField, nutUSpaldingWallFunctionFvPatchScalarField, nutLowReWallFunctionFvPatchScalarField, and nutkWallFunctionFvPatchScalarField.

Referenced by alphatJayatillekeWallFunctionFvPatchScalarField::alphat().

Here is the caller graph for this function:

◆ map()

void map	(	const fvPatchScalarField &	ptf,
		const fieldMapper &	mapper
	)

virtual

Map the given fvPatchField onto this fvPatchField.

Reimplemented in nutURoughWallFunctionFvPatchScalarField, nutkRoughWallFunctionFvPatchScalarField, and nutkAtmRoughWallFunctionFvPatchScalarField.

Definition at line 175 of file nutWallFunctionFvPatchScalarField.C.

Referenced by nutkAtmRoughWallFunctionFvPatchScalarField::map(), nutkRoughWallFunctionFvPatchScalarField::map(), and nutURoughWallFunctionFvPatchScalarField::map().

Here is the caller graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 185 of file nutWallFunctionFvPatchScalarField.C.

References nut, and Foam::operator==().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented in nutUWallFunctionFvPatchScalarField, nutUSpaldingWallFunctionFvPatchScalarField, nutURoughWallFunctionFvPatchScalarField, nutkRoughWallFunctionFvPatchScalarField, and nutkAtmRoughWallFunctionFvPatchScalarField.

Definition at line 198 of file nutWallFunctionFvPatchScalarField.C.

References fvPatchField< Type >::write(), and Foam::writeEntry().

Here is the call graph for this function:

Member Data Documentation

◆ Cmu_

scalar Cmu_

protected

Cmu coefficient.

Definition at line 108 of file nutWallFunctionFvPatchScalarField.H.

Referenced by nutWallFunctionFvPatchScalarField::Cmu(), nutkAtmRoughWallFunctionFvPatchScalarField::nut(), nutkRoughWallFunctionFvPatchScalarField::nut(), nutkWallFunctionFvPatchScalarField::nut(), and nutkWallFunctionFvPatchScalarField::yPlus().

◆ kappa_

scalar kappa_

protected

Von Karman constant.

Definition at line 111 of file nutWallFunctionFvPatchScalarField.H.

Referenced by nutUSpaldingWallFunctionFvPatchScalarField::calcUTau(), nutWallFunctionFvPatchScalarField::kappa(), nutkAtmRoughWallFunctionFvPatchScalarField::nut(), nutkRoughWallFunctionFvPatchScalarField::nut(), nutkWallFunctionFvPatchScalarField::nut(), nutUWallFunctionFvPatchScalarField::nut(), nutURoughWallFunctionFvPatchScalarField::yPlus(), and nutUWallFunctionFvPatchScalarField::yPlus().

◆ E_

scalar E_

protected

E coefficient.

Definition at line 114 of file nutWallFunctionFvPatchScalarField.H.

Referenced by nutUSpaldingWallFunctionFvPatchScalarField::calcUTau(), nutWallFunctionFvPatchScalarField::E(), nutkWallFunctionFvPatchScalarField::nut(), nutUWallFunctionFvPatchScalarField::nut(), nutURoughWallFunctionFvPatchScalarField::yPlus(), and nutUWallFunctionFvPatchScalarField::yPlus().

◆ yPlusLam_

scalar yPlusLam_

protected

Y+ at the edge of the laminar sublayer.

Definition at line 117 of file nutWallFunctionFvPatchScalarField.H.

Referenced by nutkWallFunctionFvPatchScalarField::nut(), nutUWallFunctionFvPatchScalarField::nut(), nutURoughWallFunctionFvPatchScalarField::yPlus(), and nutUWallFunctionFvPatchScalarField::yPlus().

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

src/MomentumTransportModels/momentumTransportModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H
src/MomentumTransportModels/momentumTransportModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ nutWallFunctionFvPatchScalarField() [1/4]

◆ nutWallFunctionFvPatchScalarField() [2/4]

◆ nutWallFunctionFvPatchScalarField() [3/4]

◆ nutWallFunctionFvPatchScalarField() [4/4]

Member Function Documentation

◆ checkType()

◆ nut()

◆ writeLocalEntries()

◆ TypeName()

◆ Cmu()

◆ kappa()

◆ E()

◆ nutw()

◆ yPlusLam() [1/2]

◆ yPlusLam() [2/2]

◆ yPlus()

◆ map()

◆ updateCoeffs()

◆ write()

Member Data Documentation

◆ Cmu_

◆ kappa_

◆ E_

◆ yPlusLam_