This boundary condition provides a wall constraint on the turbulent viscosity (i.e. nut) based on the turbulent kinetic energy (i.e. k) for atmospheric boundary layer modelling. It is designed to be used in conjunction with the atmBoundaryLayerInletVelocity boundary condition. More...

#include <atmNutkWallFunctionFvPatchScalarField.H>

Inheritance diagram for atmNutkWallFunctionFvPatchScalarField:

[legend]

Collaboration diagram for atmNutkWallFunctionFvPatchScalarField:

[legend]

Public Member Functions
	TypeName ("atmNutkWallFunction")
	Runtime type information.
	atmNutkWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field.
	atmNutkWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	atmNutkWallFunctionFvPatchScalarField (const atmNutkWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given atmNutkWallFunctionFvPatchScalarField onto a new patch.
	atmNutkWallFunctionFvPatchScalarField (const atmNutkWallFunctionFvPatchScalarField &)
	Construct as copy.
	atmNutkWallFunctionFvPatchScalarField (const atmNutkWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference.
virtual tmp< fvPatchField< scalar > >	clone () const
	Return a clone.
virtual tmp< fvPatchField< scalar > >	clone (const DimensionedField< scalar, volMesh > &iF) const
	Clone with an internal field reference.
virtual void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object.
virtual void	rmap (const fvPatchScalarField &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField.
virtual void	write (Ostream &) const
	Write.
Public Member Functions inherited from nutkWallFunctionFvPatchScalarField
	TypeName ("nutkWallFunction")
	Runtime type information.
	nutkWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field.
	nutkWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	nutkWallFunctionFvPatchScalarField (const nutkWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given nutkWallFunctionFvPatchScalarField onto a new patch.
	nutkWallFunctionFvPatchScalarField (const nutkWallFunctionFvPatchScalarField &)
	Construct as copy.
	nutkWallFunctionFvPatchScalarField (const nutkWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference.
virtual tmp< scalarField >	yPlus () const
	Calculate and return the yPlus at the boundary.
Public Member Functions inherited from nutWallFunctionFvPatchScalarField
	TypeName ("nutWallFunction")
	Runtime type information.
	nutWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field.
	nutWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given nutWallFunctionFvPatchScalarField onto a new patch.
	nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &)
	Construct as copy.
	nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference.
const wallFunctionCoefficients &	wallCoeffs () const noexcept
	Return wallFunctionCoefficients.
virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field.

Protected Member Functions
virtual tmp< scalarField >	calcNut () const
	Calculate the turbulent viscosity.
void	writeLocalEntries (Ostream &) const
	Write local wall function variables.
Protected Member Functions inherited from nutkWallFunctionFvPatchScalarField
void	writeLocalEntries (Ostream &) const
	Write local wall function variables.
Protected Member Functions inherited from nutWallFunctionFvPatchScalarField
virtual const volVectorField &	U (const turbulenceModel &turb) const
	Helper to return the velocity field either from the turbulence model (default) or the mesh database.
virtual void	checkType ()
	Check the type of the patch.
void	writeLocalEntries (Ostream &) const
	Write local wall function variables.

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.
Protected Attributes inherited from nutWallFunctionFvPatchScalarField
word	UName_
	Name of velocity field.
wallFunctionCoefficients	wallCoeffs_
	Wall-function coefficients.

Detailed Description

This boundary condition provides a wall constraint on the turbulent viscosity (i.e. nut) based on the turbulent kinetic energy (i.e. k) for atmospheric boundary layer modelling. It is designed to be used in conjunction with the atmBoundaryLayerInletVelocity boundary condition.

The governing equation of the boundary condition:

$\‍[ u = \frac{u^*}{\kappa} ln \left(\frac{z + z_0}{z_0}\right) \‍]$

where

	=	Friction velocity
$\kappa$	=	von Kármán constant
	=	Surface roughness length [m]
	=	Ground-normal coordinate

Required fields:

      nut    | Turbulent viscosity              [m2/s]
      k      | Turbulent kinetic energy         [m2/s2]

References:

        Theoretical expressions (tag:HW):
            Hargreaves, D. M., & Wright, N. G. (2007).
            On the use of the k–ε model in commercial CFD software to model
            the neutral atmospheric boundary layer.
            J. of wind engineering and industrial aerodynamics, 95(5), 355-369.
            DOI:10.1016/j.jweia.2006.08.002

Required fields:

      nut    | Turbulent viscosity              [m2/s]
      k      | Turbulent kinetic energy         [m2/s2]

Usage

Example of the boundary condition specification:

<patchName>
{
    // Mandatory entries
    type            atmNutkWallFunction;
    z0              <PatchFunction1<scalar>>;

    // Optional entries
    boundNut        <bool>;

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: atmNutkWallFunction	word	yes	-
`z0`	Surface roughness length [m]	PatchFunction1<scalar>	yes	-
`boundNut`	Flag to zero-bound nut near wall	bool	no	false

The inherited entries are elaborated in:

Note

boundNut entry is set false for backward compatibility reasons.
nutkAtmRoughWallFunction was renamed to atmNutkWallFunction.

Source files

Definition at line 164 of file atmNutkWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ atmNutkWallFunctionFvPatchScalarField() [1/5]

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

Construct from patch and internal field.

Definition at line 119 of file atmNutkWallFunctionFvPatchScalarField.C.

References nutkWallFunctionFvPatchScalarField::nutkWallFunctionFvPatchScalarField(), and p.

Referenced by atmNutkWallFunctionFvPatchScalarField(), atmNutkWallFunctionFvPatchScalarField(), atmNutkWallFunctionFvPatchScalarField(), and TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ atmNutkWallFunctionFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 145 of file atmNutkWallFunctionFvPatchScalarField.C.

References dict, Foam::New(), nutkWallFunctionFvPatchScalarField::nutkWallFunctionFvPatchScalarField(), and p.

Here is the call graph for this function:

◆ atmNutkWallFunctionFvPatchScalarField() [3/5]

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

Construct by mapping given atmNutkWallFunctionFvPatchScalarField onto a new patch.

Definition at line 131 of file atmNutkWallFunctionFvPatchScalarField.C.

References atmNutkWallFunctionFvPatchScalarField(), clone(), nutkWallFunctionFvPatchScalarField::nutkWallFunctionFvPatchScalarField(), and p.

Here is the call graph for this function:

◆ atmNutkWallFunctionFvPatchScalarField() [4/5]

atmNutkWallFunctionFvPatchScalarField ( const atmNutkWallFunctionFvPatchScalarField & rwfpsf )

Construct as copy.

Definition at line 158 of file atmNutkWallFunctionFvPatchScalarField.C.

References atmNutkWallFunctionFvPatchScalarField(), clone(), and nutkWallFunctionFvPatchScalarField::nutkWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ atmNutkWallFunctionFvPatchScalarField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 169 of file atmNutkWallFunctionFvPatchScalarField.C.

References atmNutkWallFunctionFvPatchScalarField(), clone(), and nutkWallFunctionFvPatchScalarField::nutkWallFunctionFvPatchScalarField().

Here is the call graph for this function:

Member Function Documentation

◆ calcNut()

tmp< scalarField > calcNut ( ) const

protectedvirtual

Calculate the turbulent viscosity.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 37 of file atmNutkWallFunctionFvPatchScalarField.C.

References e, Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, IOobject::groupName(), k, Foam::log(), Foam::max(), tmp< T >::New(), nutWallFunctionFvPatchScalarField::nutw(), Foam::pow025(), turbulenceModel::propertiesName, Foam::sqrt(), nutWallFunctionFvPatchScalarField::wallCoeffs_, y, and nutkWallFunctionFvPatchScalarField::yPlus().

Here is the call graph for this function:

◆ writeLocalEntries()

void writeLocalEntries ( Ostream & os ) const

protected

Write local wall function variables.

Definition at line 103 of file atmNutkWallFunctionFvPatchScalarField.C.

References os().

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "atmNutkWallFunction" )

Runtime type information.

References atmNutkWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [1/2]

virtual tmp< fvPatchField< scalar > > clone ( ) const

inlinevirtual

Return a clone.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 259 of file atmNutkWallFunctionFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Referenced by atmNutkWallFunctionFvPatchScalarField(), atmNutkWallFunctionFvPatchScalarField(), and atmNutkWallFunctionFvPatchScalarField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clone() [2/2]

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

inlinevirtual

Clone with an internal field reference.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 267 of file atmNutkWallFunctionFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

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 183 of file atmNutkWallFunctionFvPatchScalarField.C.

◆ rmap()

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

virtual

Reverse map the given fvPatchField onto this fvPatchField.

Definition at line 197 of file atmNutkWallFunctionFvPatchScalarField.C.

References Foam::refCast().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 215 of file atmNutkWallFunctionFvPatchScalarField.C.

References os(), nutWallFunctionFvPatchScalarField::write(), writeLocalEntries(), and fvPatchField< Type >::writeValueEntry().

Here is the call graph for this function:

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

src/atmosphericModels/derivedFvPatchFields/wallFunctions/atmNutkWallFunction/atmNutkWallFunctionFvPatchScalarField.H
src/atmosphericModels/derivedFvPatchFields/wallFunctions/atmNutkWallFunction/atmNutkWallFunctionFvPatchScalarField.C

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ atmNutkWallFunctionFvPatchScalarField() [1/5]

◆ atmNutkWallFunctionFvPatchScalarField() [2/5]

◆ atmNutkWallFunctionFvPatchScalarField() [3/5]

◆ atmNutkWallFunctionFvPatchScalarField() [4/5]

◆ atmNutkWallFunctionFvPatchScalarField() [5/5]

Member Function Documentation

◆ calcNut()

◆ writeLocalEntries()

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ autoMap()

◆ rmap()

◆ write()