This boundary condition provides a wall function on the turbulent viscosity (i.e. nut) based on velocity (i.e. U) for low- and high-Reynolds number applications for rough walls. More...

Inheritance diagram for nutURoughWallFunctionFvPatchScalarField:

[legend]

Collaboration diagram for nutURoughWallFunctionFvPatchScalarField:

[legend]

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

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

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

	nutURoughWallFunctionFvPatchScalarField (const nutURoughWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)

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

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

	nutURoughWallFunctionFvPatchScalarField (const nutURoughWallFunctionFvPatchScalarField &, 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...

scalar	roughnessHeight () const noexcept
	Return the roughness height. More...

scalar &	roughnessHeight () noexcept
	Return reference to the roughness height to allow adjustment. More...

scalar	roughnessConstant () const noexcept
	Return the roughness constant scale. More...

scalar &	roughnessConstant () noexcept
	Return reference to the roughness constant to allow adjustment. More...

scalar	roughnessFactor () const noexcept
	Return the roughness scale factor. More...

scalar &	roughnessFactor () noexcept

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 &)

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

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

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

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

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

virtual void	write (Ostream &) const
	Write. 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...

Protected Member Functions inherited from nutWallFunctionFvPatchScalarField
virtual const volVectorField &	U (const turbulenceModel &turb) const

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

virtual tmp< scalarField >	calcNut () const =0
	Calculate the turbulent viscosity. More...

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

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

wallFunctionCoefficients	wallCoeffs_
	Wall-function coefficients. More...

Detailed Description

This boundary condition provides a wall function on the turbulent viscosity (i.e. nut) based on velocity (i.e. U) for low- and high-Reynolds number applications for rough walls.

Usage

Example of the boundary condition specification:

<patchName>
{
    // Mandatory entries
    type                nutURoughWallFunction;
    roughnessHeight     1e-5;
    roughnessConstant   0.5;
    roughnessFactor     1;

    // Optional entries
    maxIter             10;
    tolerance           0.0001;

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: nutURoughWallFunction	word	yes	-
`roughnessHeight`	Roughness height	scalar	yes	-
`roughnessConstant`	Roughness constant	scalar	yes	-
`roughnessFactor`	Scaling factor	scalar	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. See nutUSpaldingWallFunctionFvPatchScalarField.C.

Source files

Definition at line 138 of file nutURoughWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ nutURoughWallFunctionFvPatchScalarField() [1/5]

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

Construct from patch and internal field.

Definition at line 234 of file nutURoughWallFunctionFvPatchScalarField.C.

◆ nutURoughWallFunctionFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 268 of file nutURoughWallFunctionFvPatchScalarField.C.

◆ nutURoughWallFunctionFvPatchScalarField() [3/5]

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

Construct by mapping given nutURoughWallFunctionFvPatchScalarField onto a new patch

Definition at line 250 of file nutURoughWallFunctionFvPatchScalarField.C.

◆ nutURoughWallFunctionFvPatchScalarField() [4/5]

nutURoughWallFunctionFvPatchScalarField ( const nutURoughWallFunctionFvPatchScalarField & rwfpsf )

Construct as copy.

Definition at line 285 of file nutURoughWallFunctionFvPatchScalarField.C.

◆ nutURoughWallFunctionFvPatchScalarField() [5/5]

nutURoughWallFunctionFvPatchScalarField	(	const nutURoughWallFunctionFvPatchScalarField &	rwfpsf,
		const DimensionedField< scalar, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 300 of file nutURoughWallFunctionFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "nutURoughWallFunction" )

Runtime type information.

◆ clone() [1/2]

virtual tmp< fvPatchScalarField > clone ( ) const

inlinevirtual

Construct and return a clone.

Definition at line 216 of file nutURoughWallFunctionFvPatchScalarField.H.

◆ 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 232 of file nutURoughWallFunctionFvPatchScalarField.H.

◆ roughnessHeight() [1/2]

scalar roughnessHeight ( ) const

inlinenoexcept

Return the roughness height.

Definition at line 249 of file nutURoughWallFunctionFvPatchScalarField.H.

◆ roughnessHeight() [2/2]

scalar & roughnessHeight ( )

inlinenoexcept

Return reference to the roughness height to allow adjustment.

Definition at line 255 of file nutURoughWallFunctionFvPatchScalarField.H.

◆ roughnessConstant() [1/2]

scalar roughnessConstant ( ) const

inlinenoexcept

Return the roughness constant scale.

Definition at line 261 of file nutURoughWallFunctionFvPatchScalarField.H.

◆ roughnessConstant() [2/2]

scalar & roughnessConstant ( )

inlinenoexcept

Return reference to the roughness constant to allow adjustment.

Definition at line 267 of file nutURoughWallFunctionFvPatchScalarField.H.

◆ roughnessFactor() [1/2]

scalar roughnessFactor ( ) const

inlinenoexcept

Return the roughness scale factor.

Definition at line 273 of file nutURoughWallFunctionFvPatchScalarField.H.

◆ roughnessFactor() [2/2]

scalar & roughnessFactor ( )

inlinenoexcept

Return reference to the roughness scale factor to allow adjustment

Definition at line 280 of file nutURoughWallFunctionFvPatchScalarField.H.

◆ yPlus()

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

virtual

Calculate and return the yPlus at the boundary.

Implements nutWallFunctionFvPatchScalarField.

Definition at line 319 of file nutURoughWallFunctionFvPatchScalarField.C.

References IOobject::groupName(), Foam::mag(), magUp, turbulenceModel::propertiesName, and U.

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from nutWallFunctionFvPatchScalarField.

Definition at line 339 of file nutURoughWallFunctionFvPatchScalarField.C.

References os(), and ObukhovLength::write().

Here is the call graph for this function:

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

src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ nutURoughWallFunctionFvPatchScalarField() [1/5]

◆ nutURoughWallFunctionFvPatchScalarField() [2/5]

◆ nutURoughWallFunctionFvPatchScalarField() [3/5]

◆ nutURoughWallFunctionFvPatchScalarField() [4/5]

◆ nutURoughWallFunctionFvPatchScalarField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ roughnessHeight() [1/2]

◆ roughnessHeight() [2/2]

◆ roughnessConstant() [1/2]

◆ roughnessConstant() [2/2]

◆ roughnessFactor() [1/2]

◆ roughnessFactor() [2/2]

◆ yPlus()

◆ write()