This boundary condition provides a turbulent kinematic viscosity condition when using wall functions for rough walls, based on velocity. 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 &)
	Construct by mapping given. More...

	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 ()
	Return reference to the roughness scale factor to allow. 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. More...

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

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

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

Private Member Functions
virtual tmp< scalarField >	calcYPlus (const scalarField &magUp) const
	Calculate yPLus. More...

virtual tmp< scalarField >	calcNut () const
	Calculate the turbulence viscosity. More...

Private Attributes
scalar	roughnessHeight_
	Height. More...

scalar	roughnessConstant_
	Constant. More...

scalar	roughnessFactor_
	Scale factor. More...

Additional Inherited Members
Static Public Member Functions inherited from nutWallFunctionFvPatchScalarField
static scalar	yPlusLam (const scalar kappa, const scalar E)
	Calculate the Y+ at the edge of the laminar sublayer. More...

Protected Member Functions inherited from nutWallFunctionFvPatchScalarField
virtual void	checkType ()
	Check the type of the patch. More...

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

Protected Attributes inherited from nutWallFunctionFvPatchScalarField
scalar	Cmu_
	Cmu coefficient. More...

scalar	kappa_
	Von Karman constant. More...

scalar	E_
	E coefficient. More...

scalar	yPlusLam_
	Y+ at the edge of the laminar sublayer. More...

Detailed Description

This boundary condition provides a turbulent kinematic viscosity condition when using wall functions for rough walls, based on velocity.

Patch usage

Property	Description	Required
`roughnessHeight`	roughness height	yes
`roughnessConstant`	roughness constanr	yes
`roughnessFactor`	scaling factor	yes

Example of the boundary condition specification:

    myPatch
    {
        type            nutURoughWallFunction;
        roughnessHeight 1e-5;
        roughnessConstant 0.5;
        roughnessFactor 1;
    }

See also: Foam::nutWallFunctionFvPatchScalarField

Source files

Definition at line 95 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 206 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 234 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 219 of file nutURoughWallFunctionFvPatchScalarField.C.

◆ nutURoughWallFunctionFvPatchScalarField() [4/5]

nutURoughWallFunctionFvPatchScalarField ( const nutURoughWallFunctionFvPatchScalarField & rwfpsf )

Construct as copy.

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

Member Function Documentation

◆ calcYPlus()

tmp< scalarField > calcYPlus ( const scalarField & magUp ) const

privatevirtual

Calculate yPLus.

Definition at line 79 of file nutURoughWallFunctionFvPatchScalarField.C.

References Foam::atan(), Foam::cos(), dimensionedInternalField(), forAll, Foam::constant::universal::G, Foam::constant::atomic::group, IOobject::groupName(), Foam::log(), Foam::mag(), magUp, Foam::max(), turbulenceModel::nu(), patchi, turbulenceModel::propertiesName, Foam::Re(), Foam::sin(), y, and turbulenceModel::y().

Referenced by nutURoughWallFunctionFvPatchScalarField::calcNut(), and nutURoughWallFunctionFvPatchScalarField::yPlus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calcNut()

tmp< scalarField > calcNut ( ) const

privatevirtual

Calculate the turbulence viscosity.

Implements nutWallFunctionFvPatchScalarField.

Definition at line 39 of file nutURoughWallFunctionFvPatchScalarField.C.

References GeometricField::boundaryField(), nutURoughWallFunctionFvPatchScalarField::calcYPlus(), dimensionedInternalField(), forAll, Foam::constant::atomic::group, IOobject::groupName(), Foam::mag(), magUp, turbulenceModel::nu(), patchi, fvPatchField::patchInternalField(), turbulenceModel::propertiesName, Foam::Re(), Foam::sqr(), turbulenceModel::U(), y, turbulenceModel::y(), and nutWallFunctionFvPatchScalarField::yPlusLam_.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "nutURoughWallFunction" )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const

inlinevirtual

Construct and return a clone.

Definition at line 163 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 180 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 196 of file nutURoughWallFunctionFvPatchScalarField.H.

References nutURoughWallFunctionFvPatchScalarField::roughnessHeight_.

◆ roughnessHeight() [2/2]

scalar& roughnessHeight ( )

inline

Return reference to the roughness height to allow adjustment.

Definition at line 202 of file nutURoughWallFunctionFvPatchScalarField.H.

References nutURoughWallFunctionFvPatchScalarField::roughnessHeight_.

◆ roughnessConstant() [1/2]

scalar roughnessConstant ( ) const

inline

Return the roughness constant scale.

Definition at line 209 of file nutURoughWallFunctionFvPatchScalarField.H.

References nutURoughWallFunctionFvPatchScalarField::roughnessConstant_.

◆ roughnessConstant() [2/2]

scalar& roughnessConstant ( )

inline

Return reference to the roughness constant to allow adjustment.

Definition at line 215 of file nutURoughWallFunctionFvPatchScalarField.H.

References nutURoughWallFunctionFvPatchScalarField::roughnessConstant_.

◆ roughnessFactor() [1/2]

scalar roughnessFactor ( ) const

inline

Return the roughness scale factor.

Definition at line 221 of file nutURoughWallFunctionFvPatchScalarField.H.

References nutURoughWallFunctionFvPatchScalarField::roughnessFactor_.

◆ roughnessFactor() [2/2]

scalar& roughnessFactor ( )

inline

Return reference to the roughness scale factor to allow.

adjustment

Definition at line 228 of file nutURoughWallFunctionFvPatchScalarField.H.

◆ yPlus()

tmp< scalarField > yPlus ( ) const

virtual

Calculate and return the yPlus at the boundary.

Implements nutWallFunctionFvPatchScalarField.

Definition at line 274 of file nutURoughWallFunctionFvPatchScalarField.C.

References GeometricField::boundaryField(), nutURoughWallFunctionFvPatchScalarField::calcYPlus(), dimensionedInternalField(), Foam::constant::atomic::group, IOobject::groupName(), Foam::mag(), magUp, patchi, turbulenceModel::propertiesName, and turbulenceModel::U().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from nutWallFunctionFvPatchScalarField.

Definition at line 293 of file nutURoughWallFunctionFvPatchScalarField.C.

References token::END_STATEMENT, Foam::nl, nutURoughWallFunctionFvPatchScalarField::roughnessConstant_, nutURoughWallFunctionFvPatchScalarField::roughnessFactor_, nutURoughWallFunctionFvPatchScalarField::roughnessHeight_, fvPatchField::write(), Ostream::writeKeyword(), and nutWallFunctionFvPatchScalarField::writeLocalEntries().

Here is the call graph for this function:

Field Documentation

◆ roughnessHeight_

scalar roughnessHeight_

private

Height.

Definition at line 104 of file nutURoughWallFunctionFvPatchScalarField.H.

Referenced by nutURoughWallFunctionFvPatchScalarField::roughnessHeight(), and nutURoughWallFunctionFvPatchScalarField::write().

◆ roughnessConstant_

scalar roughnessConstant_

private

Constant.

Definition at line 107 of file nutURoughWallFunctionFvPatchScalarField.H.

Referenced by nutURoughWallFunctionFvPatchScalarField::roughnessConstant(), and nutURoughWallFunctionFvPatchScalarField::write().

◆ roughnessFactor_

scalar roughnessFactor_

private

Scale factor.

Definition at line 110 of file nutURoughWallFunctionFvPatchScalarField.H.

Referenced by nutURoughWallFunctionFvPatchScalarField::roughnessFactor(), and nutURoughWallFunctionFvPatchScalarField::write().

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

Private Member Functions

Private Attributes

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

◆ calcYPlus()

◆ calcNut()

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

Field Documentation

◆ roughnessHeight_

◆ roughnessConstant_

◆ roughnessFactor_