Public Member Functions | List of all members
atmBoundaryLayer Class Reference
Turbulence » RAS turbulence » RAS boundary conditionsBoundary Conditions » | Inlet boundary Conditions

This class provides functions to evaluate the velocity and turbulence distributions appropriate for atmospheric boundary layers (ABL). More...

Inheritance diagram for atmBoundaryLayer:
Inheritance graph
[legend]

Public Member Functions

 atmBoundaryLayer ()
 Construct null. More...
 
 atmBoundaryLayer (const vectorField &p, const dictionary &)
 Construct from the coordinates field and dictionary. More...
 
 atmBoundaryLayer (const atmBoundaryLayer &, const fvPatchFieldMapper &)
 Construct by mapping given. More...
 
 atmBoundaryLayer (const atmBoundaryLayer &)
 Construct as copy. More...
 
const vector & flowDir () const
 Return flow direction. More...
 
const vector & zDir () const
 Return z-direction. More...
 
const scalarField & Ustar () const
 Return friction velocity. More...
 
void autoMap (const fvPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object. More...
 
void rmap (const atmBoundaryLayer &, const labelList &)
 Reverse map the given fvPatchField onto this fvPatchField. More...
 
tmp< vectorField > U (const vectorField &p) const
 Return the velocity distribution for the ATM. More...
 
tmp< scalarField > k (const vectorField &p) const
 Return the turbulent kinetic energy distribution for the ATM. More...
 
tmp< scalarField > epsilon (const vectorField &p) const
 Return the turbulent dissipation rate distribution for the ATM. More...
 
void write (Ostream &) const
 Write. More...
 

Detailed Description

This class provides functions to evaluate the velocity and turbulence distributions appropriate for atmospheric boundary layers (ABL).

The profile is derived from the friction velocity, flow direction and "vertical" direction:

\[ U = \frac{U^*}{\kappa} ln\left(\frac{z - z_g + z_0}{z_0}\right) \]

\[ k = \frac{(U^*)^2}{\sqrt{C_mu}} \]

\[ \epsilon = \frac{(U^*)^3}{\kappa(z - z_g + z_0)} \]

where

$ U^* $ = Friction velocity
$ \kappa $ = von Karman's constant
$ C_mu $ = Turbulence viscosity coefficient
$ z $ = Vertical coordinate
$ z_0 $ = Surface roughness height [m]
$ z_g $ = Minimum z-coordinate [m]

and

\[ U^* = \kappa\frac{U_{ref}}{ln\left(\frac{Z_{ref} + z_0}{z_0}\right)} \]

where

$ U_{ref} $ = Reference velocity at $Z_{ref}$ [m/s]
$ Z_{ref} $ = Reference height [m]

Use in the atmBoundaryLayerInletVelocity, atmBoundaryLayerInletK and atmBoundaryLayerInletEpsilon boundary conditions.

Reference: D.M. Hargreaves and N.G. Wright, "On the use of the k-epsilon model in commercial CFD software to model the neutral atmospheric boundary layer", Journal of Wind Engineering and Industrial Aerodynamics 95(2007), pp 355-369.

Usage
Property Description Required Default
flowDir Flow direction yes
zDir Vertical direction yes
kappa von Karman's constant no 0.41
Cmu Turbulence viscosity coefficient no 0.09
Uref Reference velocity [m/s] yes
Zref Reference height [m] yes
z0 Surface roughness height [m] yes
zGround Minimum z-coordinate [m] yes

Example of the boundary condition specification: 

    ground
    {
        type            atmBoundaryLayerInletVelocity;
        flowDir         (1 0 0);
        zDir            (0 0 1);
        Uref            10.0;
        Zref            20.0;
        z0              uniform 0.1;
        zGround         uniform 0.0;
    }
Note
D.M. Hargreaves and N.G. Wright recommend Gamma epsilon in the k-epsilon model should be changed from 1.3 to 1.11 for consistency. The roughness height (Er) is given by Er = 20 z0 following the same reference.
Source files

Definition at line 205 of file atmBoundaryLayer.H.

Constructor & Destructor Documentation

◆ atmBoundaryLayer() [1/4]

atmBoundaryLayer ( )

Construct null.

Definition at line 35 of file atmBoundaryLayer.C.

Referenced by atmBoundaryLayer::atmBoundaryLayer().

Here is the caller graph for this function:

◆ atmBoundaryLayer() [2/4]

atmBoundaryLayer ( const vectorField &  p,
const dictionary &  dict 
)

Construct from the coordinates field and dictionary.

Definition at line 49 of file atmBoundaryLayer.C.

References Foam::abort(), atmBoundaryLayer::atmBoundaryLayer(), Foam::FatalError, FatalErrorInFunction, Foam::log(), and Foam::mag().

Here is the call graph for this function:

◆ atmBoundaryLayer() [3/4]

atmBoundaryLayer ( const atmBoundaryLayer &  ptf,
const fvPatchFieldMapper &  mapper 
)

Construct by mapping given.

atmBoundaryLayer onto a new patch

Definition at line 77 of file atmBoundaryLayer.C.

◆ atmBoundaryLayer() [4/4]

atmBoundaryLayer ( const atmBoundaryLayer &  blpvf)

Construct as copy.

Definition at line 94 of file atmBoundaryLayer.C.

Member Function Documentation

◆ flowDir()

const vector& flowDir ( ) const
inline

Return flow direction.

Definition at line 264 of file atmBoundaryLayer.H.

◆ zDir()

const vector& zDir ( ) const
inline

Return z-direction.

Definition at line 270 of file atmBoundaryLayer.H.

◆ Ustar()

const scalarField& Ustar ( ) const
inline

Return friction velocity.

Definition at line 276 of file atmBoundaryLayer.H.

References atmBoundaryLayer::autoMap(), atmBoundaryLayer::epsilon(), atmBoundaryLayer::k(), atmBoundaryLayer::rmap(), atmBoundaryLayer::U(), and atmBoundaryLayer::write().

Here is the call graph for this function:

◆ autoMap()

void autoMap ( const fvPatchFieldMapper &  m)

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

Definition at line 110 of file atmBoundaryLayer.C.

References Field< Type >::autoMap(), and atmBoundaryLayer::rmap().

Referenced by atmBoundaryLayerInletEpsilonFvPatchScalarField::autoMap(), atmBoundaryLayerInletKFvPatchScalarField::autoMap(), atmBoundaryLayerInletVelocityFvPatchVectorField::autoMap(), and atmBoundaryLayer::Ustar().

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

◆ rmap()

void rmap ( const atmBoundaryLayer &  blptf,
const labelList &  addr 
)

Reverse map the given fvPatchField onto this fvPatchField.

Definition at line 119 of file atmBoundaryLayer.C.

References Field< Type >::rmap().

Referenced by atmBoundaryLayer::autoMap(), atmBoundaryLayerInletKFvPatchScalarField::rmap(), atmBoundaryLayerInletEpsilonFvPatchScalarField::rmap(), atmBoundaryLayerInletVelocityFvPatchVectorField::rmap(), and atmBoundaryLayer::Ustar().

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

◆ U()

tmp< vectorField > U ( const vectorField &  p) const

Return the velocity distribution for the ATM.

Definition at line 130 of file atmBoundaryLayer.C.

References Foam::log().

Referenced by atmBoundaryLayer::Ustar().

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

◆ k()

tmp< scalarField > k ( const vectorField &  p) const

Return the turbulent kinetic energy distribution for the ATM.

Definition at line 142 of file atmBoundaryLayer.C.

References Foam::sqr(), and Foam::sqrt().

Referenced by atmBoundaryLayer::Ustar().

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

◆ epsilon()

tmp< scalarField > epsilon ( const vectorField &  p) const

Return the turbulent dissipation rate distribution for the ATM.

Definition at line 148 of file atmBoundaryLayer.C.

References p, and Foam::pow3().

Referenced by atmBoundaryLayer::Ustar().

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

◆ write()

void write ( Ostream &  os) const

Write.

Definition at line 154 of file atmBoundaryLayer.C.

References token::END_STATEMENT, Foam::nl, Field< Type >::writeEntry(), and Ostream::writeKeyword().

Referenced by atmBoundaryLayer::Ustar(), atmBoundaryLayerInletEpsilonFvPatchScalarField::write(), atmBoundaryLayerInletKFvPatchScalarField::write(), and atmBoundaryLayerInletVelocityFvPatchVectorField::write().

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:
Generated by   doxygen 1.8.13