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...

#include <nutURoughWallFunctionFvPatchScalarField.H>

Inheritance diagram for nutURoughWallFunctionFvPatchScalarField:

[legend]

Collaboration diagram for nutURoughWallFunctionFvPatchScalarField:

[legend]

Public Member Functions
	TypeName ("nutURoughWallFunction")
	Runtime type information.
	nutURoughWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field.
	nutURoughWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	nutURoughWallFunctionFvPatchScalarField (const nutURoughWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given nutURoughWallFunctionFvPatchScalarField onto a new patch.
	nutURoughWallFunctionFvPatchScalarField (const nutURoughWallFunctionFvPatchScalarField &)
	Construct as copy.
	nutURoughWallFunctionFvPatchScalarField (const nutURoughWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference.
virtual tmp< fvPatchField< scalar > >	clone () const
	Return a clone.
virtual tmp< fvPatchField< scalar > >	clone (const DimensionedField< scalar, volMesh > &iF) const
	Clone with an internal field reference.
scalar	roughnessHeight () const noexcept
	Return the roughness height.
scalar &	roughnessHeight () noexcept
	Return reference to the roughness height to allow adjustment.
scalar	roughnessConstant () const noexcept
	Return the roughness constant scale.
scalar &	roughnessConstant () noexcept
	Return reference to the roughness constant to allow adjustment.
scalar	roughnessFactor () const noexcept
	Return the roughness scale factor.
scalar &	roughnessFactor () noexcept
	Return reference to the roughness scale factor to allow adjustment.
virtual tmp< scalarField >	yPlus () const
	Calculate and return the yPlus at the boundary.
virtual void	write (Ostream &os) const
	Write.
Public Member Functions inherited from nutWallFunctionFvPatchScalarField
	TypeName ("nutWallFunction")
	Runtime type information.
	nutWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field.
	nutWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given nutWallFunctionFvPatchScalarField onto a new patch.
	nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &)
	Construct as copy.
	nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference.
const wallFunctionCoefficients &	wallCoeffs () const noexcept
	Return wallFunctionCoefficients.
virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field.

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.
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.
virtual void	checkType ()
	Check the type of the patch.
void	writeLocalEntries (Ostream &) const
	Write local wall function variables.
Protected Attributes inherited from nutWallFunctionFvPatchScalarField
word	UName_
	Name of velocity field.
wallFunctionCoefficients	wallCoeffs_
	Wall-function coefficients.

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 134 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 227 of file nutURoughWallFunctionFvPatchScalarField.C.

References nutWallFunctionFvPatchScalarField::nutWallFunctionFvPatchScalarField(), p, and Foam::Zero.

Referenced by nutURoughWallFunctionFvPatchScalarField(), nutURoughWallFunctionFvPatchScalarField(), nutURoughWallFunctionFvPatchScalarField(), and TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 261 of file nutURoughWallFunctionFvPatchScalarField.C.

References dict, nutWallFunctionFvPatchScalarField::nutWallFunctionFvPatchScalarField(), and p.

Here is the call graph for this function:

◆ 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 243 of file nutURoughWallFunctionFvPatchScalarField.C.

References nutURoughWallFunctionFvPatchScalarField(), nutWallFunctionFvPatchScalarField::nutWallFunctionFvPatchScalarField(), and p.

Here is the call graph for this function:

◆ nutURoughWallFunctionFvPatchScalarField() [4/5]

nutURoughWallFunctionFvPatchScalarField ( const nutURoughWallFunctionFvPatchScalarField & rwfpsf )

Construct as copy.

Definition at line 278 of file nutURoughWallFunctionFvPatchScalarField.C.

References nutURoughWallFunctionFvPatchScalarField(), and nutWallFunctionFvPatchScalarField::nutWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ nutURoughWallFunctionFvPatchScalarField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 293 of file nutURoughWallFunctionFvPatchScalarField.C.

References nutURoughWallFunctionFvPatchScalarField(), and nutWallFunctionFvPatchScalarField::nutWallFunctionFvPatchScalarField().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "nutURoughWallFunction" )

Runtime type information.

References nutURoughWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [1/2]

virtual tmp< fvPatchField< scalar > > clone ( ) const

inlinevirtual

Return a clone.

Definition at line 249 of file nutURoughWallFunctionFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ clone() [2/2]

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

inlinevirtual

Clone with an internal field reference.

Definition at line 257 of file nutURoughWallFunctionFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ roughnessHeight() [1/2]

scalar roughnessHeight ( ) const

inlinenoexcept

Return the roughness height.

Definition at line 273 of file nutURoughWallFunctionFvPatchScalarField.H.

References Foam::noexcept.

◆ roughnessHeight() [2/2]

scalar & roughnessHeight ( )

inlinenoexcept

Return reference to the roughness height to allow adjustment.

Definition at line 281 of file nutURoughWallFunctionFvPatchScalarField.H.

References Foam::noexcept.

◆ roughnessConstant() [1/2]

scalar roughnessConstant ( ) const

inlinenoexcept

Return the roughness constant scale.

Definition at line 289 of file nutURoughWallFunctionFvPatchScalarField.H.

References Foam::noexcept.

◆ roughnessConstant() [2/2]

scalar & roughnessConstant ( )

inlinenoexcept

Return reference to the roughness constant to allow adjustment.

Definition at line 297 of file nutURoughWallFunctionFvPatchScalarField.H.

References Foam::noexcept.

◆ roughnessFactor() [1/2]

scalar roughnessFactor ( ) const

inlinenoexcept

Return the roughness scale factor.

Definition at line 305 of file nutURoughWallFunctionFvPatchScalarField.H.

References Foam::noexcept.

◆ roughnessFactor() [2/2]

scalar & roughnessFactor ( )

inlinenoexcept

Return reference to the roughness scale factor to allow adjustment.

Definition at line 314 of file nutURoughWallFunctionFvPatchScalarField.H.

References Foam::noexcept.

◆ yPlus()

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

virtual

Calculate and return the yPlus at the boundary.

Implements nutWallFunctionFvPatchScalarField.

Definition at line 312 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 332 of file nutURoughWallFunctionFvPatchScalarField.C.

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

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