This boundary condition provides a wall constraint on the turbulent viscosity, i.e. nut, when using wall functions for rough walls, based on the turbulent kinetic energy, i.e. k. The condition manipulates the wall roughness parameter, i.e. E, to account for roughness effects. More...

Inheritance diagram for nutkRoughWallFunctionFvPatchScalarField:

[legend]

Collaboration diagram for nutkRoughWallFunctionFvPatchScalarField:

[legend]

Public Member Functions
	TypeName ("nutkRoughWallFunction")

	nutkRoughWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)

	nutkRoughWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)

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

	nutkRoughWallFunctionFvPatchScalarField (const nutkRoughWallFunctionFvPatchScalarField &)

virtual tmp< fvPatchScalarField >	clone () const

	nutkRoughWallFunctionFvPatchScalarField (const nutkRoughWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)

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

scalarField &	Ks ()

scalarField &	Cs ()

virtual void	autoMap (const fvPatchFieldMapper &)

virtual void	rmap (const fvPatchScalarField &, const labelList &)

virtual void	write (Ostream &) const

Public Member Functions inherited from nutkWallFunctionFvPatchScalarField
	TypeName ("nutkWallFunction")

	nutkWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)

	nutkWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)

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

	nutkWallFunctionFvPatchScalarField (const nutkWallFunctionFvPatchScalarField &)

	nutkWallFunctionFvPatchScalarField (const nutkWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)

virtual tmp< scalarField >	yPlus () 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 ()

Protected Member Functions
virtual scalar	fnRough (const scalar KsPlus, const scalar Cs) const

virtual tmp< scalarField >	calcNut () const

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

virtual void	checkType ()

virtual void	writeLocalEntries (Ostream &) const

Protected Attributes
scalarField	Ks_

scalarField	Cs_

Protected Attributes inherited from nutWallFunctionFvPatchScalarField
enum blendingType	blending_

const scalar	n_

word	UName_

scalar	Cmu_

scalar	kappa_

scalar	E_

scalar	yPlusLam_

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 }

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, when using wall functions for rough walls, based on the turbulent kinetic energy, i.e. k. The condition manipulates the wall roughness parameter, i.e. E, to account for roughness effects.

Parameter ranges:

roughness height = sand-grain roughness (0 for smooth walls)
roughness constant = 0.5-1.0

Usage

Example of the boundary condition specification:

<patchName>
{
    // Mandatory entries (unmodifiable)
    type            nutkRoughWallFunction;
    Ks              uniform 0;
    Cs              uniform 0.5;

    // Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Req'd	Dflt
`type`	Type name: nutkRoughWallFunction	word	yes	-
`Ks`	Sand-grain roughness height	scalarField	yes	-
`Cs`	Roughness constant	scalarField	yes	-

The inherited entries are elaborated in:

nutkWallFunctionFvPatchScalarField.H

Source files

Definition at line 108 of file nutkRoughWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ nutkRoughWallFunctionFvPatchScalarField() [1/5]

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

Definition at line 125 of file nutkRoughWallFunctionFvPatchScalarField.C.

Referenced by nutkRoughWallFunctionFvPatchScalarField::clone().

Here is the caller graph for this function:

◆ nutkRoughWallFunctionFvPatchScalarField() [2/5]

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

Definition at line 153 of file nutkRoughWallFunctionFvPatchScalarField.C.

◆ nutkRoughWallFunctionFvPatchScalarField() [3/5]

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

Definition at line 138 of file nutkRoughWallFunctionFvPatchScalarField.C.

◆ nutkRoughWallFunctionFvPatchScalarField() [4/5]

nutkRoughWallFunctionFvPatchScalarField ( const nutkRoughWallFunctionFvPatchScalarField & rwfpsf )

Definition at line 167 of file nutkRoughWallFunctionFvPatchScalarField.C.

◆ nutkRoughWallFunctionFvPatchScalarField() [5/5]

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

Definition at line 179 of file nutkRoughWallFunctionFvPatchScalarField.C.

Member Function Documentation

◆ fnRough()

Foam::scalar fnRough	(	const scalar	KsPlus,
		const scalar	Cs
	)		const

protectedvirtual

Definition at line 32 of file nutkRoughWallFunctionFvPatchScalarField.C.

References Cs, Foam::log(), Foam::pow(), and Foam::sin().

Referenced by nutkRoughWallFunctionFvPatchScalarField::calcNut().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calcNut()

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

protectedvirtual

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 55 of file nutkRoughWallFunctionFvPatchScalarField.C.

References nutWallFunctionFvPatchScalarField::Cmu_, nutkRoughWallFunctionFvPatchScalarField::Cs_, Foam::expressions::patchExpr::debug, Foam::constant::electromagnetic::e, nutWallFunctionFvPatchScalarField::E_, Foam::endl(), nutkRoughWallFunctionFvPatchScalarField::fnRough(), forAll, Foam::constant::atomic::group, IOobject::groupName(), Foam::Info, k, turbulenceModel::k(), nutWallFunctionFvPatchScalarField::kappa_, nutkRoughWallFunctionFvPatchScalarField::Ks_, Foam::log(), Foam::max(), Foam::min(), turbulenceModel::nu(), nutWallFunctionFvPatchScalarField::nutw(), Foam::foamVersion::patch, Foam::pow025(), turbulenceModel::propertiesName, tmp::ref(), Foam::sqrt(), y, turbulenceModel::y(), and nutkWallFunctionFvPatchScalarField::yPlus().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "nutkRoughWallFunction" )

◆ clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const

inlinevirtual

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 173 of file nutkRoughWallFunctionFvPatchScalarField.H.

References nutkRoughWallFunctionFvPatchScalarField::nutkRoughWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [2/2]

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

inlinevirtual

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 190 of file nutkRoughWallFunctionFvPatchScalarField.H.

References nutkRoughWallFunctionFvPatchScalarField::nutkRoughWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ Ks()

scalarField& Ks ( )

inline

Definition at line 206 of file nutkRoughWallFunctionFvPatchScalarField.H.

References nutkRoughWallFunctionFvPatchScalarField::Ks_.

◆ Cs()

scalarField& Cs ( )

inline

Definition at line 212 of file nutkRoughWallFunctionFvPatchScalarField.H.

References nutkRoughWallFunctionFvPatchScalarField::Cs_.

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m )

virtual

Definition at line 193 of file nutkRoughWallFunctionFvPatchScalarField.C.

◆ rmap()

void rmap	(	const fvPatchScalarField &	ptf,
		const labelList &	addr
	)

virtual

Definition at line 204 of file nutkRoughWallFunctionFvPatchScalarField.C.

References nutkRoughWallFunctionFvPatchScalarField::Cs_, and nutkRoughWallFunctionFvPatchScalarField::Ks_.

◆ write()

void write ( Ostream & os ) const

virtual

Reimplemented from nutWallFunctionFvPatchScalarField.

Definition at line 220 of file nutkRoughWallFunctionFvPatchScalarField.C.

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

Here is the call graph for this function:

Member Data Documentation

◆ Ks_

scalarField Ks_

protected

Definition at line 117 of file nutkRoughWallFunctionFvPatchScalarField.H.

Referenced by nutkRoughWallFunctionFvPatchScalarField::calcNut(), nutkRoughWallFunctionFvPatchScalarField::Ks(), and nutkRoughWallFunctionFvPatchScalarField::rmap().

◆ Cs_

scalarField Cs_

protected

Definition at line 120 of file nutkRoughWallFunctionFvPatchScalarField.H.

Referenced by nutkRoughWallFunctionFvPatchScalarField::calcNut(), nutkRoughWallFunctionFvPatchScalarField::Cs(), and nutkRoughWallFunctionFvPatchScalarField::rmap().

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

src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ nutkRoughWallFunctionFvPatchScalarField() [1/5]

◆ nutkRoughWallFunctionFvPatchScalarField() [2/5]

◆ nutkRoughWallFunctionFvPatchScalarField() [3/5]

◆ nutkRoughWallFunctionFvPatchScalarField() [4/5]

◆ nutkRoughWallFunctionFvPatchScalarField() [5/5]

Member Function Documentation

◆ fnRough()

◆ calcNut()

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ Ks()

◆ Cs()

◆ autoMap()

◆ rmap()

◆ write()

Member Data Documentation

◆ Ks_

◆ Cs_