This boundary condition provides a wall constraint on the turbulent kinematic viscosity, i.e. nut, when using wall functions for rough walls, based on velocity, U. 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
	Return the roughness height. More...

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

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

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

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

scalar &	roughnessFactor ()

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

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 viscous sublayer. More...

virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. 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...

static scalar	yPlusLam (const scalar kappa, const scalar E)
	Calculate the y+ at the edge of the viscous sublayer. 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...

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

scalar	Cmu_
	Cmu coefficient. More...

scalar	kappa_
	Von Karman constant. More...

scalar	E_
	E coefficient. More...

scalar	yPlusLam_
	Estimated y+ value at the edge of the viscous sublayer. More...

Detailed Description

This boundary condition provides a wall constraint on the turbulent kinematic viscosity, i.e. nut, when using wall functions for rough walls, based on velocity, U.

Usage

Property	Description	Required	Default value
`roughnessHeight`	Roughness height	yes
`roughnessConstant`	Roughness constanr	yes
`roughnessFactor`	Scaling factor	yes
`Cmu`	Model coefficient	no	0.09
`kappa`	Von Karman constant	no	0.41
`E`	Model coefficient	no	9.8
`maxIter`	Number of Newton-Raphson iterations	no	10
`tolerance`	Convergence tolerance	no	0.0001

Example of the boundary condition specification:

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

        // Optional entries
    }

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. Can be avoided by seeding the NR with e.g. the laminar viscosity or tightening the convergence tolerance to e.g. 1e-7 and the max number of iterations to 100.

See also: Foam::nutWallFunctionFvPatchScalarField

Source files

Definition at line 139 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.

Referenced by nutURoughWallFunctionFvPatchScalarField::clone().

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.

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

◆ nutURoughWallFunctionFvPatchScalarField() [4/5]

nutURoughWallFunctionFvPatchScalarField ( const nutURoughWallFunctionFvPatchScalarField & rwfpsf )

Construct as copy.

Definition at line 278 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 293 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 217 of file nutURoughWallFunctionFvPatchScalarField.H.

References nutURoughWallFunctionFvPatchScalarField::nutURoughWallFunctionFvPatchScalarField().

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

References nutURoughWallFunctionFvPatchScalarField::nutURoughWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ roughnessHeight() [1/2]

scalar roughnessHeight ( ) const

inline

Return the roughness height.

Definition at line 250 of file nutURoughWallFunctionFvPatchScalarField.H.

◆ roughnessHeight() [2/2]

scalar& roughnessHeight ( )

inline

Return reference to the roughness height to allow adjustment.

Definition at line 256 of file nutURoughWallFunctionFvPatchScalarField.H.

◆ roughnessConstant() [1/2]

scalar roughnessConstant ( ) const

inline

Return the roughness constant scale.

Definition at line 263 of file nutURoughWallFunctionFvPatchScalarField.H.

◆ roughnessConstant() [2/2]

scalar& roughnessConstant ( )

inline

Return reference to the roughness constant to allow adjustment.

Definition at line 269 of file nutURoughWallFunctionFvPatchScalarField.H.

◆ roughnessFactor() [1/2]

scalar roughnessFactor ( ) const

inline

Return the roughness scale factor.

Definition at line 275 of file nutURoughWallFunctionFvPatchScalarField.H.

◆ roughnessFactor() [2/2]

scalar& roughnessFactor ( )

inline

Return reference to the roughness scale factor to allow adjustment

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

References Foam::constant::atomic::group, IOobject::groupName(), Foam::mag(), magUp, Foam::foamVersion::patch, 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 330 of file nutURoughWallFunctionFvPatchScalarField.C.

References fvPatchField< Type >::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()