atmNutkWallFunctionFvPatchScalarField Class Reference

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...

Inheritance diagram for atmNutkWallFunctionFvPatchScalarField:
[legend]
Collaboration diagram for atmNutkWallFunctionFvPatchScalarField:
[legend]

Public Member Functions

 TypeName ("atmNutkWallFunction")
 Runtime type information. More...
 
 atmNutkWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field. More...
 
 atmNutkWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 atmNutkWallFunctionFvPatchScalarField (const atmNutkWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 
 atmNutkWallFunctionFvPatchScalarField (const atmNutkWallFunctionFvPatchScalarField &)
 Construct as copy. More...
 
virtual tmp< fvPatchScalarFieldclone () const
 Construct and return a clone. More...
 
 atmNutkWallFunctionFvPatchScalarField (const atmNutkWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchScalarFieldclone (const DimensionedField< scalar, volMesh > &iF) const
 Construct and return a clone setting internal field reference. 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 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 &)
 
 nutkWallFunctionFvPatchScalarField (const nutkWallFunctionFvPatchScalarField &)
 Construct as copy. More...
 
virtual tmp< fvPatchScalarFieldclone () const
 Construct and return a clone. More...
 
 nutkWallFunctionFvPatchScalarField (const nutkWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchScalarFieldclone (const DimensionedField< scalar, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual tmp< scalarFieldyPlus () const
 Calculate and return the yPlus at the boundary. More...
 
virtual void write (Ostream &) 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 &)
 
 nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &)
 Construct as copy. More...
 
 nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< scalarFieldyPlus () const =0
 Calculate and return the yPlus at the boundary. More...
 
const wallFunctionCoefficientswallCoeffs () const noexcept
 Return wallFunctionCoefficients. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 

Protected Member Functions

virtual tmp< scalarFieldcalcNut () const
 Calculate the turbulent viscosity. More...
 
void writeLocalEntries (Ostream &) const
 Write local wall function variables. More...
 
- Protected Member Functions inherited from nutkWallFunctionFvPatchScalarField
virtual tmp< scalarFieldcalcNut () const
 Calculate the turbulent viscosity. More...
 
void writeLocalEntries (Ostream &) const
 Write local wall function variables. More...
 
- Protected Member Functions inherited from nutWallFunctionFvPatchScalarField
virtual const volVectorFieldU (const turbulenceModel &turb) const
 
virtual void checkType ()
 Check the type of the patch. More...
 
virtual tmp< scalarFieldcalcNut () const =0
 Calculate the turbulent viscosity. More...
 
void writeLocalEntries (Ostream &) const
 Write local wall function variables. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from nutWallFunctionFvPatchScalarField
static const nutWallFunctionFvPatchScalarFieldnutw (const turbulenceModel &turbModel, const label patchi)
 Return the nut patchField for the given wall patch. More...
 
- Protected Attributes inherited from nutWallFunctionFvPatchScalarField
word UName_
 Name of velocity field. More...
 
wallFunctionCoefficients wallCoeffs_
 Wall-function coefficients. More...
 

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

\( u^* \) = Friction velocity
\( \kappa \) = von Kármán constant
\( z_0 \) = Surface roughness length [m]
\( z \) = 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 168 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 126 of file atmNutkWallFunctionFvPatchScalarField.C.

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

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

◆ atmNutkWallFunctionFvPatchScalarField() [4/5]

◆ atmNutkWallFunctionFvPatchScalarField() [5/5]

Construct as copy setting internal field reference.

Definition at line 176 of file atmNutkWallFunctionFvPatchScalarField.C.

Member Function Documentation

◆ calcNut()

tmp< scalarField > calcNut ( ) const
protectedvirtual

◆ writeLocalEntries()

void writeLocalEntries ( Ostream os) const
protected

Write local wall function variables.

Definition at line 110 of file atmNutkWallFunctionFvPatchScalarField.C.

References os(), and Ostream::writeEntryIfDifferent().

Referenced by atmNutkWallFunctionFvPatchScalarField::write().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ TypeName()

TypeName ( "atmNutkWallFunction"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp< fvPatchScalarField > clone ( ) const
inlinevirtual

Construct and return a clone.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 234 of file atmNutkWallFunctionFvPatchScalarField.H.

◆ clone() [2/2]

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 250 of file atmNutkWallFunctionFvPatchScalarField.H.

◆ autoMap()

void autoMap ( const fvPatchFieldMapper m)
virtual

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

Definition at line 190 of file atmNutkWallFunctionFvPatchScalarField.C.

References atmBoundaryLayer::autoMap().

Here is the call 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 204 of file atmNutkWallFunctionFvPatchScalarField.C.

References atmBoundaryLayer::rmap().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 222 of file atmNutkWallFunctionFvPatchScalarField.C.

References os(), ObukhovLength::write(), and atmNutkWallFunctionFvPatchScalarField::writeLocalEntries().

Here is the call graph for this function:

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