From 740b1eead841c2b5d2f5e77c908394b21e570a63 Mon Sep 17 00:00:00 2001
From: Kutalmis Bercin <kutalmis.bercin@esi-group.com>
Date: Wed, 23 Jun 2021 17:49:33 +0100
Subject: [PATCH] DOC: turbulenceFields: improve header documentation

---
 .../field/turbulenceFields/turbulenceFields.H | 26 +++++++++++--------
 1 file changed, 15 insertions(+), 11 deletions(-)

diff --git a/src/functionObjects/field/turbulenceFields/turbulenceFields.H b/src/functionObjects/field/turbulenceFields/turbulenceFields.H
index 60d1b0263de..739b1c1599c 100644
--- a/src/functionObjects/field/turbulenceFields/turbulenceFields.H
+++ b/src/functionObjects/field/turbulenceFields/turbulenceFields.H
@@ -62,22 +62,26 @@ Usage
         libs        (fieldFunctionObjects);
 
         // Mandatory entries (runtime modifiable)
-        // Either field or fields entries
-        fields      (R devRhoReff);
-        field       R;
 
-        // Optional (inherited) entries
+            // Either of the below
+            // Option-1
+            fields      (R devRhoReff);
+
+            // Option-2
+            field       R;
+
+        // Inherited entries
         ...
     }
     \endverbatim
 
     where the entries mean:
     \table
-      Property     | Description                           | Type | Req'd | Dflt
-      type         | Type name: turbulenceFields           | word |  yes  | -
-      libs         | Library name: fieldFunctionObjects    | word |  yes  | -
+      Property     | Description                           | Type | Reqd | Deflt
+      type         | Type name: turbulenceFields           | word | yes  | -
+      libs         | Library name: fieldFunctionObjects    | word | yes  | -
       fields       | Names of fields to store (see below)  | wordList | yes | -
-      field        | Name of a field to store (see below)  | word | yes | -
+      field        | Name of a field to store (see below)  | word | yes  | -
     \endtable
 
     where \c fields can include:
@@ -153,8 +157,8 @@ public:
             cfEpsilon,      //!< "Turbulent kinetic energy dissipation rate"
             cfOmega,        //!< "Specific dissipation rate"
             cfNuTilda,      //!< "Modified turbulent viscosity"
-            cfMut,          //!< "Turbulent viscosity"
-            cfMuEff,        //!< "Effective turbulent viscosity"
+            cfMut,          //!< "Turbulent dynamic viscosity"
+            cfMuEff,        //!< "Effective turbulent dynamic viscosity"
             cfAlphat,       //!< "Turbulence thermal diffusivity"
             cfAlphaEff,     //!< "Effective turbulence thermal diffusivity"
             cfR,            //!< "Reynolds stress tensor"
@@ -184,7 +188,7 @@ public:
         //- Names for incompressibleField turbulence fields
         static const Enum<incompressibleField> incompressibleFieldNames_;
 
-        //- Turbulence closure model name
+        //- Name of the turbulence properties dictionary
         static const word modelName_;
 
 
-- 
GitLab