nutURoughWallFunctionFvPatchScalarField Class Reference

This boundary condition provides a wall constraint on the turbulent viscosity, i.e. nut, based on velocity i.e. U, for low- and high-Reynolds number turbulence models for rough walls. More...

Inheritance diagram for nutURoughWallFunctionFvPatchScalarField:

Collaboration diagram for nutURoughWallFunctionFvPatchScalarField:

Public Member Functions
	TypeName ("nutURoughWallFunction")
	nutURoughWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	nutURoughWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	nutURoughWallFunctionFvPatchScalarField (const nutURoughWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	nutURoughWallFunctionFvPatchScalarField (const nutURoughWallFunctionFvPatchScalarField &)
virtual tmp< fvPatchScalarField >	clone () const
	nutURoughWallFunctionFvPatchScalarField (const nutURoughWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
virtual tmp< fvPatchScalarField >	clone (const DimensionedField< scalar, volMesh > &iF) const
scalar	roughnessHeight () const
scalar &	roughnessHeight ()
scalar	roughnessConstant () const
scalar &	roughnessConstant ()
scalar	roughnessFactor () const
scalar &	roughnessFactor ()
virtual tmp< scalarField >	yPlus () const
virtual void	write (Ostream &os) const
Public Member Functions inherited from nutWallFunctionFvPatchScalarField
	TypeName ("nutWallFunction")
	nutWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	nutWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &)
	nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
scalar	Cmu () const
scalar	kappa () const
scalar	E () const
scalar	yPlusLam () const
scalar	blend (const scalar nutVis, const scalar nutLog, const scalar yPlus) const
virtual void	updateCoeffs ()

Additional Inherited Members
Static Public Member Functions inherited from nutWallFunctionFvPatchScalarField
static const nutWallFunctionFvPatchScalarField &	nutw (const turbulenceModel &turbModel, const label patchi)
static scalar	yPlusLam (const scalar kappa, const scalar E)
Protected Types inherited from nutWallFunctionFvPatchScalarField
enum	blendingType { STEPWISE, MAX, BINOMIAL, EXPONENTIAL }
Protected Member Functions inherited from nutWallFunctionFvPatchScalarField
virtual const volVectorField &	U (const turbulenceModel &turb) const
virtual void	checkType ()
Protected Attributes inherited from nutWallFunctionFvPatchScalarField
enum blendingType	blending_
const scalar	n_
word	UName_
scalar	Cmu_
scalar	kappa_
scalar	E_
scalar	yPlusLam_
Static Protected Attributes inherited from nutWallFunctionFvPatchScalarField
static const Enum< blendingType >	blendingTypeNames

Detailed Description

This boundary condition provides a wall constraint on the turbulent viscosity, i.e. nut, based on velocity i.e. U, for low- and high-Reynolds number turbulence models for rough walls.

Usage

Example of the boundary condition specification:

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

    // Optional entries (unmodifiable)
    maxIter             10;
    tolerance           0.0001;

    // Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Req'd	Dflt
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

• nutURoughWallFunctionFvPatchScalarField.H
• nutURoughWallFunctionFvPatchScalarField.C

Definition at line 134 of file nutURoughWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

nutURoughWallFunctionFvPatchScalarField() [1/5]

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

Definition at line 220 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
	)

Definition at line 254 of file nutURoughWallFunctionFvPatchScalarField.C.

nutURoughWallFunctionFvPatchScalarField() [3/5]

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

Definition at line 236 of file nutURoughWallFunctionFvPatchScalarField.C.

nutURoughWallFunctionFvPatchScalarField() [4/5]

nutURoughWallFunctionFvPatchScalarField

(

const nutURoughWallFunctionFvPatchScalarField &

rwfpsf

)

Definition at line 271 of file nutURoughWallFunctionFvPatchScalarField.C.

nutURoughWallFunctionFvPatchScalarField() [5/5]

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

Definition at line 286 of file nutURoughWallFunctionFvPatchScalarField.C.

Member Function Documentation

TypeName()

TypeName

(

"nutURoughWallFunction"

)

clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const

inlinevirtual

Definition at line 212 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

Definition at line 229 of file nutURoughWallFunctionFvPatchScalarField.H.

References nutURoughWallFunctionFvPatchScalarField::nutURoughWallFunctionFvPatchScalarField().

Here is the call graph for this function:

roughnessHeight() [1/2]

scalar roughnessHeight ( ) const

inline

Definition at line 245 of file nutURoughWallFunctionFvPatchScalarField.H.

roughnessHeight() [2/2]

scalar& roughnessHeight ( )

inline

Definition at line 251 of file nutURoughWallFunctionFvPatchScalarField.H.

roughnessConstant() [1/2]

scalar roughnessConstant ( ) const

inline

Definition at line 257 of file nutURoughWallFunctionFvPatchScalarField.H.

roughnessConstant() [2/2]

scalar& roughnessConstant ( )

inline

Definition at line 263 of file nutURoughWallFunctionFvPatchScalarField.H.

roughnessFactor() [1/2]

scalar roughnessFactor ( ) const

inline

Definition at line 269 of file nutURoughWallFunctionFvPatchScalarField.H.

roughnessFactor() [2/2]

scalar& roughnessFactor ( )

inline

Definition at line 276 of file nutURoughWallFunctionFvPatchScalarField.H.

yPlus()

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

virtual

Implements nutWallFunctionFvPatchScalarField.

Definition at line 303 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

Reimplemented from nutWallFunctionFvPatchScalarField.

Definition at line 323 of file nutURoughWallFunctionFvPatchScalarField.C.

References os(), and fvPatchField::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