DOC-STYLE: various release changes

src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.C

@@ -48,6 +48,7 @@ Foam::epsilonWallFunctionFvPatchScalarField::blendingTypeNames
 
 Foam::scalar Foam::epsilonWallFunctionFvPatchScalarField::tolerance_ = 1e-5;
 
+
 // * * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * //
 
 void Foam::epsilonWallFunctionFvPatchScalarField::setMaster()

src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H

@@ -74,9 +74,9 @@ Usage
     \table
       Property  | Description                       | Type | Req'd  | Dflt
       type      | Type name: epsilonWallFunction    | word | yes    | -
-      lowReCorrection | Flag for low-Re correction  | bool |  no    | false
+      lowReCorrection | Flag: apply low-Re correction | bool |  no  | false
       blending  | Viscous/inertial sublayer blending method <!--
-                -->                                 | word |  no    | stepwise
+                                                --> | word |  no    | stepwise
       n         | Binomial blending exponent        | scalar | no   | 2.0
     \endtable
 
@@ -189,8 +189,6 @@ class epsilonWallFunctionFvPatchScalarField
 :
     public fixedValueFvPatchField<scalar>
 {
-private:
-
     // Private Enumerations
 
         //- Options for the blending treatment of viscous and inertial sublayers

src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kLowReWallFunction/kLowReWallFunctionFvPatchScalarField.H

@@ -56,7 +56,7 @@ Usage
     where the entries mean:
     \table
       Property  | Description                     | Type   | Req'd | Dflt
-      type      | Type name: kLowReWallFunction   | word | yes    | -
+      type      | Type name: kLowReWallFunction   | word   | yes   | -
       Ceps2     | Model coefficient               | scalar | no    |  1.9
       Ck        | Model coefficient               | scalar | no    | -0.416
       Bk        | Model coefficient               | scalar | no    |  8.366

src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H

@@ -32,8 +32,10 @@ Group
 
 Description
     This boundary condition provides a simple wrapper around the zero-gradient
-    condition, which can be used for \c k, \c q, and \c R fields for
-    the case of high Reynolds number flow using wall functions.
+    condition, which can be used for the turbulent kinetic energy, i.e. \c k,
+    square-root of turbulent kinetic energy, i.e. \c q, and Reynolds stress
+    tensor fields, i.e. \c R, for the cases of high Reynolds number flow
+    using wall functions.
 
 Usage
     Example of the boundary condition specification:

src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H

@@ -31,8 +31,8 @@ Group
     grpWallFunctions
 
 Description
-    This boundary condition provides a wall constraint on the turbulent
-    viscosity, i.e. \c nut for low Reynolds number models.
+    This boundary condition provides a wall constraint on the
+    turbulent viscosity, i.e. \c nut, for low Reynolds number models.
     It sets \c nut to zero, and provides an access function to calculate \c y+.
 
 Usage

src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUBlendedWallFunction/nutUBlendedWallFunctionFvPatchScalarField.H

@@ -31,8 +31,10 @@ Group
 
 Description
     This boundary condition provides a wall constraint on the turbulent
-    viscosity, i.e. \c nut, when using wall functions based on
-    a blending of viscous and inertial sublayer contributions.
+    viscosity, i.e. \c nut, based on velocity, i.e. \c U, using a
+    binomial-function wall-function blending method between the viscous
+    and inertial sublayer predictions of \c nut for low- and high-Reynolds
+    number turbulence models.
 
         \f[
             u_\tau = (u_{\tau,v}^n + u_{\tau,l}^n)^{1/n}
@@ -46,12 +48,13 @@ Description
     \endvartable
 
     Reference:
-    See the section that describes 'automatic wall treatment'
     \verbatim
-        Menter, F., Ferreira, J. C., Esch, T., Konno, B. (2003).
-        The SST Turbulence Model with Improved Wall Treatment
-        for Heat Transfer Predictions in Gas Turbines.
-        Proceedings of the International Gas Turbine Congress 2003 Tokyo
+        See the section that describes 'automatic wall treatment':
+            Menter, F., Ferreira, J. C., Esch, T., Konno, B. (2003).
+            The SST turbulence model with improved wall treatment
+            for heat transfer predictions in gas turbines.
+            In Proceedings of the International Gas Turbine Congress.
+            November, 2003. Tokyo, Japan. pp. 2-7.
     \endverbatim
 
 Usage
@@ -62,7 +65,7 @@ Usage
         // Mandatory entries (unmodifiable)
         type            nutUBlendedWallFunction;
 
-        // Optional entries
+        // Optional entries (unmodifiable)
         n               4.0;
 
         // Optional (inherited) entries
@@ -72,9 +75,9 @@ Usage
 
     where the entries mean:
     \table
-      Property  | Description                         | Type | Req'd  | Dflt
-      type      | Type name: nutUBlendedWallFunction  | word | yes    | -
-      n         | Blending factor                     | scalar | no   | 4.0
+      Property  | Description                         | Type   | Req'd  | Dflt
+      type      | Type name: nutUBlendedWallFunction  | word   | yes    | -
+      n         | Blending factor                     | scalar | no     | 4.0
     \endtable
 
     The inherited entries are elaborated in:

src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H

@@ -32,8 +32,8 @@ Group
 
 Description
     This boundary condition provides a wall constraint on the turbulent
-    viscosity, i.e. \c nut, when using wall functions for rough walls,
-    based on velocity, \c U.
+    viscosity, i.e. \c nut, based on velocity i.e. \c U, for low- and
+    high-Reynolds number turbulence models for rough walls.
 
 Usage
     Example of the boundary condition specification:
@@ -74,9 +74,6 @@ Note
     \c turbulence->validate) returns a slightly different value every time
     it is called.
     See \link nutUSpaldingWallFunctionFvPatchScalarField.C \endlink.
-    - Can be avoided by seeding the NR with e.g. the laminar viscosity
-    or tightening the convergence tolerance to e.g. 1e-7 and the max
-    number of iterations to 100.
 
 SourceFiles
     nutURoughWallFunctionFvPatchScalarField.C

src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H

@@ -32,9 +32,8 @@ Group
 
 Description
     This boundary condition provides a wall constraint on the turbulent
-    viscosity, i.e. \c nut, when using wall functions for rough walls,
-    based on velocity, \c U, using Spalding's law to give a continuous \c nut
-    profile to the wall (y+ = 0)
+    viscosity, i.e. \c nut, based on velocity, i.e. \c U. Using Spalding's
+    law gives a continuous \c nut profile to the wall.
 
         \f[
             y^+ = u^+ + \frac{1}{E} \left[exp(\kappa u^+) - 1 - \kappa u^+\,
@@ -81,13 +80,11 @@ Note
     \c turbulence->validate) returns a slightly different value every time
     it is called. This is since the seed for the Newton-Raphson iteration
     uses the current value of \c *this (\c =nut ).
-
     - This can be avoided by overriding the tolerance. This also switches on
     a pre-detection whether the current nut already satisfies the turbulence
     conditions and if so does not change it at all. This means that the nut
     only changes if it 'has really changed'. This probably should be used with
     a tight tolerance, to make sure to kick every iteration, e.g.
-
         maxIter     100;
         tolerance   1e-7;
 

src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H

@@ -32,10 +32,10 @@ Group
 
 Description
     This boundary condition provides a wall constraint on the turbulent
-    viscosity, i.e. \c nut, when using wall functions, based on
-    velocity, i.e. \c U.
+    viscosity, i.e. \c nut, based on velocity, i.e. \c U, for low- and
+    high-Reynolds number turbulence models.
 
-    As input, the user specifies a look-up table of \c U+ as a function of
+    As input, the user specifies a look-up table of \c u+ as a function of
     near-wall Reynolds number.
 
     The table should be located in the \c $FOAM_CASE/constant directory.
@@ -58,7 +58,7 @@ Usage
     \table
       Property    | Description                          | Type | Req'd | Dflt
       type        | Type name: nutUTabulatedWallFunction | word | yes   | -
-      uPlusTable  | U+ as a function of Re table name    | word | yes   | -
+      uPlusTable  | u+ as a function of Re table name    | word | yes   | -
     \endtable
 
     The inherited entries are elaborated in:

src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H

@@ -32,8 +32,8 @@ Group
 
 Description
     This boundary condition provides a wall constraint on the turbulent
-    viscosity, i.e. \c nut, when using wall functions, based on
-    velocity, \c U.
+    viscosity, i.e. \c nut, based on velocity, i.e. \c U, for low- and
+    high-Reynolds number turbulence models.
 
 Usage
     Example of the boundary condition specification:

src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H

@@ -35,6 +35,8 @@ Description
     boundary conditions which provide a wall constraint on various fields, such
     as turbulent viscosity, i.e. \c nut, or turbulent kinetic energy dissipation
     rate, i.e. \c epsilon, for low- and high-Reynolds number turbulence models.
+    The class is not an executable itself, yet a provider for common entries
+    to its derived boundary conditions.
 
     Reference:
     \verbatim
@@ -72,6 +74,7 @@ Usage
         E               9.8;
         blending        stepwise;
         n               4.0;
+        U               U;
 
         // Optional (inherited) entries
         ...
@@ -86,6 +89,7 @@ Usage
       E         | Wall roughness parameter       | scalar | no    | 9.8
       blending  | Viscous/inertial sublayer blending | word | no  | stepwise
       n         | Binomial blending exponent     | scalar | no    | 2.0
+      U         | Name of the velocity field     | word   | no    | U
     \endtable
 
     The inherited entries are elaborated in:
@@ -151,11 +155,8 @@ Usage
       \Gamma       | \f$0.01 (y^+)^4 / (1.0 + 5.0 y^+)\f$
     \endvartable
 
-Note
-    - \c nutWallFunction is not directly usable.
-
 See also
-    Foam::fixedValueFvPatchField
+    - Foam::fixedValueFvPatchField
 
 SourceFiles
     nutWallFunctionFvPatchScalarField.C

src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H

@@ -32,9 +32,10 @@ Group
 
 Description
     This boundary condition provides a wall constraint on the turbulent
-    kinematic viscosity, i.e. \c nut, when using wall functions for rough walls,
-    based on the turbulent kinetic energy, \c k. The condition manipulates the
-    wall roughness parameter, i.e. \c E, to account for roughness effects.
+    viscosity, i.e. \c nut, when using wall functions for rough walls,
+    based on the turbulent kinetic energy, i.e. \c k. The condition
+    manipulates the wall roughness parameter, i.e. \c E, to account
+    for roughness effects.
 
     Parameter ranges:
     - roughness height = sand-grain roughness (0 for smooth walls)
@@ -105,7 +106,7 @@ protected:
         //- Compute the roughness function
         virtual scalar fnRough(const scalar KsPlus, const scalar Cs) const;
 
-        //- Calculate the turbulence viscosity
+        //- Calculate the turbulent viscosity
         virtual tmp<scalarField> calcNut() const;
 
 

src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H

@@ -32,8 +32,8 @@ Group
 
 Description
     This boundary condition provides a wall constraint on the turbulent
-    viscosity, i.e. \c nut, when using wall functions,
-    based on the turbulent kinetic energy, \c k.
+    viscosity, i.e. \c nut, based on the turbulent kinetic energy,
+    i.e. \c k, for for low- and high-Reynolds number turbulence models.
 
 Usage
     Example of the boundary condition specification:

src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H

@@ -78,13 +78,12 @@ Usage
     \endverbatim
 
     \table
-      Property  | Description                     | Type | Req'd  | Dflt
-      type      | Type name: omegaWallFunction    | word | yes    | -
-      blended   | Blending switch (Deprecated)    | bool | no     | true
-      beta1     | Model coefficient               | scalar | no   | 0.075
+      Property  | Description                     | Type   | Req'd  | Dflt
+      type      | Type name: omegaWallFunction    | word   | yes    | -
+      beta1     | Model coefficient               | scalar | no     | 0.075
       blending  | Viscous/inertial sublayer blending method <!--
-                -->                               | word  | no    | binomial2
-      n         | Binomial blending exponent      | sclar | no    | 2.0
+                                              --> | word   | no     | binomial2
+      n         | Binomial blending exponent      | scalar | no     | 2.0
     \endtable
 
     The inherited entries are elaborated in:
@@ -185,10 +184,10 @@ Note
     the specified \c nutWallFunction in order to ensure that each patch
     possesses the same set of values for these coefficients.
   - The reason why \c binomial2 and \c binomial blending methods exist at
-    the same time is to ensure the elementwise backward compatibility with
-    the previous versions since \c binomial2 and \c binomial with n=2 will
-    yield slightly different output due to the miniscule differences in the
-    implementation of the basic functions (i.e. pow, sqrt, sqr).
+    the same time is to ensure the bitwise regression with the previous
+    versions since \c binomial2 and \c binomial with \c n=2 will yield
+    slightly different output due to the miniscule differences in the
+    implementation of the basic functions (i.e. \c pow, \c sqrt, \c sqr).
 
 See also
     - Foam::epsilonWallFunctionFvPatchScalarField
@@ -218,8 +217,6 @@ class omegaWallFunctionFvPatchScalarField
 :
     public fixedValueFvPatchField<scalar>
 {
-private:
-
     // Private Enumerations
 
         //- Options for the blending treatment of viscous and inertial sublayers

src/atmosphericModels/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H

@@ -31,7 +31,7 @@ Group
     grpRASBoundaryConditions grpInletBoundaryConditions
 
 Description
-    Base class to set log-law type ground-normal inflow boundary conditions for
+    Base class to set log-law type ground-normal inlet boundary conditions for
     wind velocity and turbulence quantities for homogeneous, two-dimensional,
     dry-air, equilibrium and neutral atmospheric boundary layer (ABL) modelling.
 
@@ -85,15 +85,6 @@ Description
       C_2      | Curve-fitting coefficient for \c YGCJ profiles       [-]
     \endvartable
 
-Note
-    - The \c RH expressions are special cases of those in \c YGCJ when \c C1=0
-    and \c C2=1. Both \c C1 and \c C2 can be determined by nonlinear fitting
-    of (\c YGCJ:Eq. 19) with an experimental dataset for \c k. By default,
-    \c atmBoundaryLayerInlet boundary conditions compute \c RH expressions.
-    - \c z is the ground-normal height relative to the global minimum height
-    of the inlet patch; therefore, the minimum of \c z is always zero
-    irrespective of the absolute z-coordinate of the computational patch.
-
     Reference:
     \verbatim
         The ground-normal profile expressions (tag:RH):
@@ -135,6 +126,35 @@ Note
     \endverbatim
 
 Usage
+    Example of the entries provided for the inherited boundary conditions:
+    \verbatim
+    inlet
+    {
+        // Mandatory and other optional entries
+        ...
+
+        // Mandatory (inherited) entries (runtime modifiable)
+        flowDir         (1 0 0);
+        zDir            (0 0 1);
+        Uref            10.0;
+        Zref            0.0;
+        z0              uniform 0.1;
+        d               uniform 0.0;
+
+        // Optional (inherited) entries (unmodifiable)
+        kappa           0.41;
+        Cmu             0.09;
+        initABL         true;
+        phi             phi;
+        C1              0.0;
+        C2              1.0;
+
+        // Conditional mandatory (inherited) entries (runtime modifiable)
+        value           uniform 0;    // when initABL=false
+    }
+    \endverbatim
+
+    where the entries mean:
     \table
       Property  | Description              | Type          | Req'd | Deflt
       flowDir   | Flow direction           | TimeFunction1<vector> | yes | -
@@ -160,6 +180,13 @@ Usage
     \endtable
 
 Note
+    - The \c RH expressions are special cases of those in \c YGCJ when \c C1=0
+    and \c C2=1. Both \c C1 and \c C2 can be determined by nonlinear fitting
+    of (\c YGCJ:Eqs. 19-20) with an experimental dataset for \c k. By default,