Public Member Functions | Protected Member Functions | List of all members
atmNutWallFunctionFvPatchScalarField 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) and velocity (i.e. U) for atmospheric boundary layer modelling. More...

Inheritance diagram for atmNutWallFunctionFvPatchScalarField:
Inheritance graph
[legend]
Collaboration diagram for atmNutWallFunctionFvPatchScalarField:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("atmNutWallFunction")
 
 atmNutWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 
 atmNutWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 
 atmNutWallFunctionFvPatchScalarField (const atmNutWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 
 atmNutWallFunctionFvPatchScalarField (const atmNutWallFunctionFvPatchScalarField &)
 
virtual tmp< fvPatchScalarField > clone () const
 
 atmNutWallFunctionFvPatchScalarField (const atmNutWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 
virtual tmp< fvPatchScalarField > clone (const DimensionedField< scalar, volMesh > &iF) const
 
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 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
 

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 }
 
- Protected Attributes inherited from nutWallFunctionFvPatchScalarField
enum blendingType blending_
 
const scalar n_
 
word UName_
 
scalar Cmu_
 
scalar kappa_
 
scalar E_
 
scalar yPlusLam_
 
- 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) based on the turbulent kinetic energy (i.e. k) and velocity (i.e. U) for atmospheric boundary layer modelling.

The governing equation of the boundary condition:

\[ \tau_w = {U^*_u} {U^*_k} \]

with

\[ {U^*_u} = \frac{\kappa U_w}{ln(z_p / z_0)} \]

\[ {U^*_k} = C_{\mu}^{1/4} \sqrt{k} \]

where

$ \tau_w $ = wall shear stress
$ U^*_u $ = local friction velocity based on near-ground velocity
$ U^*_k $ = local friction velocity based on near-ground k
$ \kappa $ = von Kármán constant
$ U_w $ = near-ground velocity
$ z_p $ = vertical coordinate
$ z_0 $ = surface roughness length [m]
$ C_mu $ = empirical model constant
$ k $ = turbulent kinetic energy

References: 

        Theoretical expressions (tags:RH, SBJM, SM):
            Richards, P. J., & Hoxey, R. P. (1993).
            Appropriate boundary conditions for computational wind
            engineering models using the k-ε turbulence model.
            In Computational Wind Engineering 1 (pp. 145-153).
            DOI:10.1016/B978-0-444-81688-7.50018-8

            Sørensen, N. N., Bechmann, A., Johansen, J., Myllerup, L.,
            Botha, P., Vinther, S., & Nielsen, B. S. (2007).
            Identification of severe wind conditions using
            a Reynolds Averaged Navier-Stokes solver.
            In Journal of Physics: Conference
            series (Vol. 75, No. 1, p. 012053).
            DOI:10.1088/1742-6596/75/1/012053

            Sumner, J., & Masson, C. (2012).
            k−ε simulations of the neutral atmospheric boundary layer:
            analysis and correction of discretization errors on practical grids.
            International journal for numerical
            methods in fluids, 70(6), 724-741.
            DOI:10.1002/fld.2709

Required fields: 

      nut     | Turbulent viscosity      [m2/s]
      k       | Turbulent kinetic energy [m2/s2]
Usage
Example of the boundary condition specification: 
<patchName>
{
    // Mandatory entries (unmodifiable)
    type            atmNutWallFunction;
    z0Min           0.001;

    // Mandatory entries (runtime modifiable)
    z0              uniform 0.001;

    // Optional (inherited) entries
    ...
}

where the entries mean:

Property Description Type Reqd Dflt
type Type name: nutAtmWallFunction word yes -
z0Min Minimum surface roughness length [m] scalar yes -
z0 Surface roughness length [m] PatchFunction1<scalar> yes -

The inherited entries are elaborated in:

See also
Source files

Definition at line 207 of file atmNutWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ atmNutWallFunctionFvPatchScalarField() [1/5]

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

Definition at line 110 of file atmNutWallFunctionFvPatchScalarField.C.

Referenced by atmNutWallFunctionFvPatchScalarField::clone().

Here is the caller graph for this function:

◆ atmNutWallFunctionFvPatchScalarField() [2/5]

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

Definition at line 136 of file atmNutWallFunctionFvPatchScalarField.C.

◆ atmNutWallFunctionFvPatchScalarField() [3/5]

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

Definition at line 122 of file atmNutWallFunctionFvPatchScalarField.C.

◆ atmNutWallFunctionFvPatchScalarField() [4/5]

atmNutWallFunctionFvPatchScalarField ( const atmNutWallFunctionFvPatchScalarField &  rwfpsf)

Definition at line 157 of file atmNutWallFunctionFvPatchScalarField.C.

◆ atmNutWallFunctionFvPatchScalarField() [5/5]

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

Definition at line 168 of file atmNutWallFunctionFvPatchScalarField.C.

Member Function Documentation

◆ calcNut()

tmp< scalarField > calcNut ( ) const
protectedvirtual

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 36 of file atmNutWallFunctionFvPatchScalarField.C.

References nutWallFunctionFvPatchScalarField::Cmu_, Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::constant::atomic::group, IOobject::groupName(), k, nutWallFunctionFvPatchScalarField::kappa_, Foam::log(), Foam::mag(), magUp, Foam::max(), tmp::New(), nutWallFunctionFvPatchScalarField::nutw(), Foam::foamVersion::patch, fvPatchField::patchInternalField(), Foam::pow025(), turbulenceModel::propertiesName, Foam::sqrt(), tauw, and y.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "atmNutWallFunction"  )

◆ clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 270 of file atmNutWallFunctionFvPatchScalarField.H.

References atmNutWallFunctionFvPatchScalarField::atmNutWallFunctionFvPatchScalarField().

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 287 of file atmNutWallFunctionFvPatchScalarField.H.

References atmNutWallFunctionFvPatchScalarField::atmNutWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ autoMap()

void autoMap ( const fvPatchFieldMapper &  m)
virtual

Definition at line 182 of file atmNutWallFunctionFvPatchScalarField.C.

◆ rmap()

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

Definition at line 192 of file atmNutWallFunctionFvPatchScalarField.C.

◆ write()

void write ( Ostream &  os) const
virtual

Reimplemented from nutWallFunctionFvPatchScalarField.

Definition at line 206 of file atmNutWallFunctionFvPatchScalarField.C.

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

Here is the call graph for this function:
The documentation for this class was generated from the following files:

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17