Public Member Functions | List of all members
atmBoundaryLayerInletKFvPatchScalarField Class Reference
Turbulence models » RAS turbulence » Boundary conditionsBoundary conditions » | Inlet

This boundary condition provides a log-law type ground-normal inlet boundary condition for the turbulent kinetic energy (i.e. k) for homogeneous, two-dimensional, dry-air, equilibrium and neutral atmospheric boundary layer modelling. More...

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

Public Member Functions

 TypeName ("atmBoundaryLayerInletK")
 
 atmBoundaryLayerInletKFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 
 atmBoundaryLayerInletKFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 
 atmBoundaryLayerInletKFvPatchScalarField (const atmBoundaryLayerInletKFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 
virtual tmp< fvPatchScalarField > clone () const
 
 atmBoundaryLayerInletKFvPatchScalarField (const atmBoundaryLayerInletKFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 
virtual tmp< fvPatchScalarField > clone (const DimensionedField< scalar, volMesh > &iF) const
 
virtual void updateCoeffs ()
 
virtual void autoMap (const fvPatchFieldMapper &)
 
virtual void rmap (const fvPatchScalarField &, const labelList &)
 
virtual void write (Ostream &) const
 
- Public Member Functions inherited from atmBoundaryLayer
 atmBoundaryLayer (const Time &time, const polyPatch &pp)
 
 atmBoundaryLayer (const Time &time, const polyPatch &pp, const dictionary &dict)
 
 atmBoundaryLayer (const atmBoundaryLayer &abl, const fvPatch &patch, const fvPatchFieldMapper &mapper)
 
 atmBoundaryLayer (const atmBoundaryLayer &)
 
vector flowDir () const
 
vector zDir () const
 
tmp< scalarField > Ustar (const scalarField &z0) const
 
void autoMap (const fvPatchFieldMapper &)
 
void rmap (const atmBoundaryLayer &, const labelList &)
 
tmp< vectorField > U (const vectorField &pCf) const
 
tmp< scalarField > k (const vectorField &pCf) const
 
tmp< scalarField > epsilon (const vectorField &pCf) const
 
tmp< scalarField > omega (const vectorField &pCf) const
 
void write (Ostream &) const
 

Additional Inherited Members

- Protected Attributes inherited from atmBoundaryLayer
bool initABL_
 

Detailed Description

This boundary condition provides a log-law type ground-normal inlet boundary condition for the turbulent kinetic energy (i.e. k) for homogeneous, two-dimensional, dry-air, equilibrium and neutral atmospheric boundary layer modelling.

The ground-normal k profile expression:

\[ k = \frac{(u^*)^2}{\sqrt{C_\mu}} \sqrt{C_1 \ln \left( \frac{z - d + z_0}{z_0} \right) + C_2} \]

where

$ k $ = Ground-normal turbulent kinetic energy profile [m^2/s^3]
$ u^* $ = Friction velocity [m/s]
$ C_\mu $ = Empirical model constant [-]
$ C_1 $ = Curve-fitting coefficient for YGCJ profiles [-]
$ C_2 $ = Curve-fitting coefficient for YGCJ profiles [-]

Required fields: 

        k    | Turbulent kinetic energy                         [m2/s2]
Usage
Example of the boundary condition specification: 
inlet
{
    // Mandatory entries (unmodifiable)
    type            atmBoundaryLayerInletK;

    // Mandatory/Optional (inherited) entries (unmodifiable)
    ...
    flowDir         (1 0 0);    // not used
    zDir            (0 0 1);    // not used
}

where the entries mean:

Property Description Type Reqd Deflt
type Type name: atmBoundaryLayerInletK word yes -

The inherited entries are elaborated in:

See also
Source files

Definition at line 139 of file atmBoundaryLayerInletKFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ atmBoundaryLayerInletKFvPatchScalarField() [1/4]

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

Definition at line 37 of file atmBoundaryLayerInletKFvPatchScalarField.C.

Referenced by atmBoundaryLayerInletKFvPatchScalarField::clone().

Here is the caller graph for this function:

◆ atmBoundaryLayerInletKFvPatchScalarField() [2/4]

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

Definition at line 49 of file atmBoundaryLayerInletKFvPatchScalarField.C.

References dict, dictionary::getOrDefault(), k, Field::operator=(), p, and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ atmBoundaryLayerInletKFvPatchScalarField() [3/4]

atmBoundaryLayerInletKFvPatchScalarField ( const atmBoundaryLayerInletKFvPatchScalarField &  psf,
const fvPatch &  p,
const DimensionedField< scalar, volMesh > &  iF,
const fvPatchFieldMapper &  mapper 
)

Definition at line 78 of file atmBoundaryLayerInletKFvPatchScalarField.C.

◆ atmBoundaryLayerInletKFvPatchScalarField() [4/4]

atmBoundaryLayerInletKFvPatchScalarField ( const atmBoundaryLayerInletKFvPatchScalarField &  psf,
const DimensionedField< scalar, volMesh > &  iF 
)

Definition at line 92 of file atmBoundaryLayerInletKFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "atmBoundaryLayerInletK"  )

◆ clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual

Definition at line 179 of file atmBoundaryLayerInletKFvPatchScalarField.H.

References atmBoundaryLayerInletKFvPatchScalarField::atmBoundaryLayerInletKFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [2/2]

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

Definition at line 196 of file atmBoundaryLayerInletKFvPatchScalarField.H.

References atmBoundaryLayerInletKFvPatchScalarField::atmBoundaryLayerInletKFvPatchScalarField().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Definition at line 104 of file atmBoundaryLayerInletKFvPatchScalarField.C.

References atmBoundaryLayer::k(), and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ autoMap()

void autoMap ( const fvPatchFieldMapper &  m)
virtual

Definition at line 118 of file atmBoundaryLayerInletKFvPatchScalarField.C.

References atmBoundaryLayer::autoMap().

Here is the call graph for this function:

◆ rmap()

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

Definition at line 128 of file atmBoundaryLayerInletKFvPatchScalarField.C.

References atmBoundaryLayer::rmap().

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Definition at line 142 of file atmBoundaryLayerInletKFvPatchScalarField.C.

References os(), atmBoundaryLayer::write(), and fvPatchField::write().

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