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

Inheritance diagram for nutkRoughWallFunctionFvPatchScalarField:

[legend]

Collaboration diagram for nutkRoughWallFunctionFvPatchScalarField:

[legend]

Public Member Functions
	TypeName ("nutkRoughWallFunction")
	Runtime type information. More...

	nutkRoughWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field. More...

	nutkRoughWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	nutkRoughWallFunctionFvPatchScalarField (const nutkRoughWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given. More...

	nutkRoughWallFunctionFvPatchScalarField (const nutkRoughWallFunctionFvPatchScalarField &)=delete
	Disallow copy without setting internal field reference. More...

	nutkRoughWallFunctionFvPatchScalarField (const nutkRoughWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Copy constructor 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...

const scalarField &	Ks () const
	Return the roughness height. More...

scalarField &	Ks ()
	Return reference to the roughness height to allow adjustment. More...

const scalarField &	Cs () const
	Return the roughness constant scale. More...

scalarField &	Cs ()
	Return reference to the roughness constant to allow adjustment. More...

virtual void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...

virtual void	rmap (const fvPatchScalarField &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField. More...

virtual void	reset (const fvPatchScalarField &)
	Reset the fvPatchField to the given fvPatchField. More...

virtual void	write (Ostream &) const
	Write. More...

Public Member Functions inherited from nutkWallFunctionFvPatchScalarField
	TypeName ("nutkWallFunction")
	Runtime type information. More...

	nutkWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field. More...

	nutkWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	nutkWallFunctionFvPatchScalarField (const nutkWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given. More...

	nutkWallFunctionFvPatchScalarField (const nutkWallFunctionFvPatchScalarField &)=delete
	Disallow copy without setting internal field reference. More...

	nutkWallFunctionFvPatchScalarField (const nutkWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Copy constructor setting internal field reference. More...

virtual tmp< scalarField >	yPlus () const
	Calculate and return the yPlus at the boundary. 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 &)=delete
	Disallow copy without setting internal field reference. More...

	nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Copy constructor 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 laminar sublayer. More...

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

Protected Member Functions
virtual tmp< scalarField >	nut () const
	Calculate the turbulence viscosity. 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...

Additional Inherited Members
Static Public Member Functions inherited from nutWallFunctionFvPatchScalarField
static const nutWallFunctionFvPatchScalarField &	nutw (const momentumTransportModel &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 laminar sublayer. 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 turbulence kinetic energy. The condition manipulates the E parameter to account for roughness effects.

Reference:

    Cebeci, T., & Bradshaw, P. (1977).
    Momentum transfer in boundary layers.
    Washington, DC, Hemisphere Publishing Corp.; New York,
    McGraw-Hill Book Co., 1977. 407 p.

Usage

Property	Description	Required	Default value
`Ks`	sand-grain roughness height	yes
`Cs`	roughness constant	yes

Parameter ranges

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

Example of the boundary condition specification:

    <patchName>
    {
        type            nutkRoughWallFunction;
        Ks              uniform 1e-5;
        Cs              uniform 0.5;
        value           uniform 0;
    }

See also: Foam::nutkWallFunctionFvPatchScalarField

Source files

Definition at line 99 of file nutkRoughWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ nutkRoughWallFunctionFvPatchScalarField() [1/5]

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

Construct from patch and internal field.

Definition at line 137 of file nutkRoughWallFunctionFvPatchScalarField.C.

Referenced by nutkRoughWallFunctionFvPatchScalarField::clone(), nutkRoughWallFunctionFvPatchScalarField::nut(), and nutkRoughWallFunctionFvPatchScalarField::nutkRoughWallFunctionFvPatchScalarField().

Here is the caller graph for this function:

◆ nutkRoughWallFunctionFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 149 of file nutkRoughWallFunctionFvPatchScalarField.C.

References nutkRoughWallFunctionFvPatchScalarField::nutkRoughWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ nutkRoughWallFunctionFvPatchScalarField() [3/5]

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

Construct by mapping given.

nutkRoughWallFunctionFvPatchScalarField onto a new patch

Definition at line 162 of file nutkRoughWallFunctionFvPatchScalarField.C.

References nutkRoughWallFunctionFvPatchScalarField::nutkRoughWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ nutkRoughWallFunctionFvPatchScalarField() [4/5]

nutkRoughWallFunctionFvPatchScalarField ( const nutkRoughWallFunctionFvPatchScalarField & )

delete

Disallow copy without setting internal field reference.

◆ nutkRoughWallFunctionFvPatchScalarField() [5/5]

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

Copy constructor setting internal field reference.

Definition at line 176 of file nutkRoughWallFunctionFvPatchScalarField.C.

References nutkRoughWallFunctionFvPatchScalarField::autoMap().

Here is the call graph for this function:

Member Function Documentation

◆ nut()

tmp< scalarField > nut ( ) const

protectedvirtual

Calculate the turbulence viscosity.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 69 of file nutkRoughWallFunctionFvPatchScalarField.C.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "nutkRoughWallFunction" )

Runtime type information.

◆ clone()

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

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 175 of file nutkRoughWallFunctionFvPatchScalarField.H.

References nutkRoughWallFunctionFvPatchScalarField::nutkRoughWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ Ks() [1/2]

const scalarField& Ks ( ) const

inline

Return the roughness height.

Definition at line 191 of file nutkRoughWallFunctionFvPatchScalarField.H.

◆ Ks() [2/2]

scalarField& Ks ( )

inline

Return reference to the roughness height to allow adjustment.

Definition at line 197 of file nutkRoughWallFunctionFvPatchScalarField.H.

◆ Cs() [1/2]

const scalarField& Cs ( ) const

inline

Return the roughness constant scale.

Definition at line 204 of file nutkRoughWallFunctionFvPatchScalarField.H.

◆ Cs() [2/2]

scalarField& Cs ( )

inline

Return reference to the roughness constant to allow adjustment.

Definition at line 210 of file nutkRoughWallFunctionFvPatchScalarField.H.

References nutkRoughWallFunctionFvPatchScalarField::autoMap(), nutkRoughWallFunctionFvPatchScalarField::reset(), nutkRoughWallFunctionFvPatchScalarField::rmap(), and nutkRoughWallFunctionFvPatchScalarField::write().

Here is the call graph for this function:

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m )

virtual

Map (and resize as needed) from self given a mapping object.

Definition at line 190 of file nutkRoughWallFunctionFvPatchScalarField.C.

References nutkRoughWallFunctionFvPatchScalarField::rmap().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rmap()

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

virtual

Reverse map the given fvPatchField onto this fvPatchField.

Definition at line 201 of file nutkRoughWallFunctionFvPatchScalarField.C.

References nutkRoughWallFunctionFvPatchScalarField::reset(), and Field< Type >::rmap().

Referenced by nutkRoughWallFunctionFvPatchScalarField::autoMap(), and nutkRoughWallFunctionFvPatchScalarField::Cs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset()

void reset ( const fvPatchScalarField & ptf )

virtual

Reset the fvPatchField to the given fvPatchField.

Used for mesh to mesh mapping

Definition at line 217 of file nutkRoughWallFunctionFvPatchScalarField.C.

References Field< Type >::reset().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from nutWallFunctionFvPatchScalarField.

Definition at line 231 of file nutkRoughWallFunctionFvPatchScalarField.C.

References Foam::makePatchTypeField(), fvPatchField< Type >::write(), Foam::writeEntry(), and nutWallFunctionFvPatchScalarField::writeLocalEntries().

Referenced by nutkRoughWallFunctionFvPatchScalarField::Cs().

Here is the call graph for this function:

Here is the caller graph for this function:

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

src/MomentumTransportModels/momentumTransportModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H
src/MomentumTransportModels/momentumTransportModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.C

Public Member Functions

Protected Member Functions

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

◆ nut()

◆ TypeName()

◆ clone()

◆ Ks() [1/2]

◆ Ks() [2/2]

◆ Cs() [1/2]

◆ Cs() [2/2]

◆ autoMap()

◆ rmap()

◆ reset()

◆ write()