This boundary condition provides a wall function for the turbulent viscosity (i.e. nut) based on velocity (i.e. U). Using Spalding's law gives a continuous nut profile to the wall. More...

Inheritance diagram for nutUSpaldingWallFunctionFvPatchScalarField:

[legend]

Collaboration diagram for nutUSpaldingWallFunctionFvPatchScalarField:

[legend]

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

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

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

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

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

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

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

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

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

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

	nutWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field. 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 fvPatchFieldMapper &)
	Construct by mapping given nutWallFunctionFvPatchScalarField onto a new patch. More...

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

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

const wallFunctionCoefficients &	wallCoeffs () const noexcept
	Return wallFunctionCoefficients. More...

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

Protected Member Functions
virtual tmp< scalarField >	calcNut () const
	Uncomment in case of intrumentation. More...

tmp< scalarField >	calcUTau (const scalarField &magGradU) const
	Calculate the friction velocity. More...

tmp< scalarField >	calcUTau (const scalarField &magGradU, const label maxIter, scalarField &err) const
	Calculate the friction velocity and number of iterations for convergence. More...

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

Protected Member Functions inherited from nutWallFunctionFvPatchScalarField
virtual const volVectorField &	U (const turbulenceModel &turb) const
	Helper to return the velocity field either from the turbulence model (default) or the mesh database. More...

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

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

Protected Attributes
const label	maxIter_
	Max iterations in calcNut. More...

const scalar	tolerance_
	Convergence tolerance. More...

Protected Attributes inherited from nutWallFunctionFvPatchScalarField
word	UName_
	Name of velocity field. More...

wallFunctionCoefficients	wallCoeffs_
	Wall-function coefficients. More...

Additional Inherited Members
Static Public Member Functions inherited from nutWallFunctionFvPatchScalarField
static const nutWallFunctionFvPatchScalarField &	nutw (const turbulenceModel &turbModel, const label patchi)
	Return the nut patchField for the given wall patch. More...

Detailed Description

This boundary condition provides a wall function for the turbulent viscosity (i.e. nut) based on velocity (i.e. U). Using Spalding's law gives a continuous nut profile to the wall.

$y^+ = u^+ + \frac{1}{E} \left[exp(\kappa u^+) - 1 - \kappa u^+\, - 0.5 (\kappa u^+)^2 - \frac{1}{6} (\kappa u^+)^3\right]$

where

	=	Wall-normal height of a cell centre in wall units
	=	Velocity at in wall units
$\kappa$	=	von Karman constant

Usage

Example of the boundary condition specification:

<patchName>
{
    // Mandatory entries
    type            nutUSpaldingWallFunction;

    // Optional entries
    maxIter         10;
    tolerance       0.0001;

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: nutUSpaldingWallFunction	word	yes	-
`maxIter`	Number of Newton-Raphson iterations	label	no	10
`tolerance`	Convergence tolerance	scalar	no	0.0001

The inherited entries are elaborated in:

nutWallFunctionFvPatchScalarField.H

Note

Suffers from non-exact restart since correctNut() (called through turbulence->validate) returns a slightly different value every time it is called. This is since the seed for the Newton-Raphson iteration uses the current value of *this (=nut ).
This can be avoided by overriding the tolerance. This also switches on a pre-detection whether the current nut already satisfies the turbulence conditions and if so does not change it at all. This means that the nut only changes if it 'has really changed'. This probably should be used with a tight tolerance, to make sure to kick every iteration, e.g. maxIter 100; tolerance 1e-7;

Source files

Definition at line 141 of file nutUSpaldingWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ nutUSpaldingWallFunctionFvPatchScalarField() [1/5]

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

Construct from patch and internal field.

Definition at line 206 of file nutUSpaldingWallFunctionFvPatchScalarField.C.

Referenced by nutUSpaldingWallFunctionFvPatchScalarField::clone().

Here is the caller graph for this function:

◆ nutUSpaldingWallFunctionFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 242 of file nutUSpaldingWallFunctionFvPatchScalarField.C.

◆ nutUSpaldingWallFunctionFvPatchScalarField() [3/5]

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

Construct by mapping given nutUSpaldingWallFunctionFvPatchScalarField onto a new patch.

Definition at line 223 of file nutUSpaldingWallFunctionFvPatchScalarField.C.

◆ nutUSpaldingWallFunctionFvPatchScalarField() [4/5]

nutUSpaldingWallFunctionFvPatchScalarField ( const nutUSpaldingWallFunctionFvPatchScalarField & wfpsf )

Construct as copy.

Definition at line 260 of file nutUSpaldingWallFunctionFvPatchScalarField.C.

◆ nutUSpaldingWallFunctionFvPatchScalarField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 276 of file nutUSpaldingWallFunctionFvPatchScalarField.C.

◆ ~nutUSpaldingWallFunctionFvPatchScalarField()

~nutUSpaldingWallFunctionFvPatchScalarField ( )

virtual

Destructor.

Definition at line 294 of file nutUSpaldingWallFunctionFvPatchScalarField.C.

Member Function Documentation

◆ calcNut()

Foam::tmp< Foam::scalarField > calcNut ( ) const

protectedvirtual

Uncomment in case of intrumentation.

mutable uint64_t invocations_; mutable uint64_t nontrivial_; mutable uint64_t nonconvergence_; mutable uint64_t iterations_;

Calculate the turbulent viscosity

Implements nutWallFunctionFvPatchScalarField.

Definition at line 32 of file nutUSpaldingWallFunctionFvPatchScalarField.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), nutUSpaldingWallFunctionFvPatchScalarField::calcUTau(), forAll, Foam::constant::atomic::group, IOobject::groupName(), Foam::mag(), Foam::max(), nutWallFunctionFvPatchScalarField::nutw(), Foam::foamVersion::patch, turbulenceModel::propertiesName, tmp< T >::ref(), Foam::sqr(), nutUSpaldingWallFunctionFvPatchScalarField::tolerance_, and nutWallFunctionFvPatchScalarField::U().

Here is the call graph for this function:

◆ calcUTau() [1/2]

Foam::tmp< Foam::scalarField > calcUTau ( const scalarField & magGradU ) const

protected

Calculate the friction velocity.

Definition at line 89 of file nutUSpaldingWallFunctionFvPatchScalarField.C.

Referenced by nutUSpaldingWallFunctionFvPatchScalarField::calcNut().

Here is the caller graph for this function:

◆ calcUTau() [2/2]

Foam::tmp< Foam::scalarField > calcUTau	(	const scalarField &	magGradU,
		const label	maxIter,
		scalarField &	err
	)		const

protected

Calculate the friction velocity and number of iterations for convergence.

Definition at line 100 of file nutUSpaldingWallFunctionFvPatchScalarField.C.

References Foam::exp(), f(), forAll, Foam::constant::atomic::group, IOobject::groupName(), Foam::constant::electromagnetic::kappa, Foam::mag(), magUp, Foam::max(), Foam::min(), tmp< T >::New(), Foam::foamVersion::patch, fvPatchField< Type >::patchInternalField(), turbulenceModel::propertiesName, List< T >::setSize(), Foam::sqr(), Foam::sqrt(), U, uTau, y, and Foam::Zero.

Here is the call graph for this function:

◆ writeLocalEntries()

void writeLocalEntries ( Ostream & os ) const

protected

Write local wall function variables.

Definition at line 193 of file nutUSpaldingWallFunctionFvPatchScalarField.C.

References os(), and Ostream::writeEntryIfDifferent().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "nutUSpaldingWallFunction" )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const

inlinevirtual

Construct and return a clone.

Definition at line 251 of file nutUSpaldingWallFunctionFvPatchScalarField.H.

References nutUSpaldingWallFunctionFvPatchScalarField::nutUSpaldingWallFunctionFvPatchScalarField().

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.

Definition at line 272 of file nutUSpaldingWallFunctionFvPatchScalarField.H.

References nutUSpaldingWallFunctionFvPatchScalarField::nutUSpaldingWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ yPlus()

Foam::tmp< Foam::scalarField > yPlus ( ) const

virtual

Calculate and return the yPlus at the boundary.

Implements nutWallFunctionFvPatchScalarField.

Definition at line 315 of file nutUSpaldingWallFunctionFvPatchScalarField.C.

References Foam::constant::atomic::group, IOobject::groupName(), Foam::mag(), Foam::foamVersion::patch, turbulenceModel::propertiesName, fvPatchField< Type >::snGrad(), U, and y.

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from nutWallFunctionFvPatchScalarField.

Definition at line 340 of file nutUSpaldingWallFunctionFvPatchScalarField.C.

References os(), nutWallFunctionFvPatchScalarField::write(), and fvPatchField< Type >::writeValueEntry().

Here is the call graph for this function:

Member Data Documentation

◆ maxIter_

const label maxIter_

protected

Max iterations in calcNut.

Definition at line 152 of file nutUSpaldingWallFunctionFvPatchScalarField.H.

◆ tolerance_

const scalar tolerance_

protected

Convergence tolerance.

Definition at line 157 of file nutUSpaldingWallFunctionFvPatchScalarField.H.

Referenced by nutUSpaldingWallFunctionFvPatchScalarField::calcNut().

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

src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ nutUSpaldingWallFunctionFvPatchScalarField() [1/5]

◆ nutUSpaldingWallFunctionFvPatchScalarField() [2/5]

◆ nutUSpaldingWallFunctionFvPatchScalarField() [3/5]

◆ nutUSpaldingWallFunctionFvPatchScalarField() [4/5]

◆ nutUSpaldingWallFunctionFvPatchScalarField() [5/5]

◆ ~nutUSpaldingWallFunctionFvPatchScalarField()

Member Function Documentation

◆ calcNut()

◆ calcUTau() [1/2]

◆ calcUTau() [2/2]

◆ writeLocalEntries()

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ yPlus()

◆ write()

Member Data Documentation

◆ maxIter_

◆ tolerance_