atmBoundaryLayer: Added documentation

OpenFOAM · Dec 14, 2018 · bd5a194 · bd5a194
1 parent 9c9f061
commit bd5a194
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/src/atmosphericModels/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.C b/src/atmosphericModels/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.C
@@ -171,7 +171,7 @@ tmp<scalarField> atmBoundaryLayer::k(const vectorField& p) const
 
     if (offset_)
     {
-        const scalarField z = (zDir_ & p) - zGround_;
+        const scalarField z((zDir_ & p) - zGround_);
         tk.ref() = pos0(z)*tk() + neg(z)*kLower_;
     }
 
@@ -188,7 +188,7 @@ tmp<scalarField> atmBoundaryLayer::epsilon(const vectorField& p) const
 
     if (offset_)
     {
-        const scalarField z = (zDir_ & p) - zGround_;
+        const scalarField z((zDir_ & p) - zGround_);
         tepsilon.ref() = pos0(z)*tepsilon() + neg(z)*epsilonLower_;
     }
 

diff --git a/src/atmosphericModels/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H b/src/atmosphericModels/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H
@@ -82,6 +82,9 @@ Usage
         Zref         | Reference height [m]             | yes       |
         z0           | Surface roughness height [m]     | yes       |
         zGround      | Minimum z-coordinate [m]         | yes       |
+        Ulower       | Velocity below the BL            | no        |
+        kLower       | Turbulence k below the BL        | no        |
+        epsilonLower | Turbulence epsilon below the BL  | no        |
     \endtable
 
     Example of the boundary condition specification: