nutWallFunctionFvPatchScalarField: Added documentation for default co…

…efficients Patch provided by Bruno Santos Resolves bug-report http://www.openfoam.org/mantisbt/view.php?id=1930
OpenFOAM · Nov 29, 2015 · 82270c6 · 82270c6
1 parent 52fa798
commit 82270c6
Showing 1 changed file with 16 additions and 1 deletion.
diff --git a/...Fields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H b/...Fields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H
@@ -34,14 +34,29 @@ Description
 
     \heading Patch usage
 
-    Example of the boundary condition specification:
+    \table
+        Property  | Description         | Required   | Default value
+        Cmu       | Cmu coefficient     | no         | 0.09
+        kappa     | Von Karman constant | no         | 0.41
+        E         | E coefficient       | no         | 9.8
+    \endtable
+
+    Examples of the boundary condition specification:
     \verbatim
     myPatch
     {
         type            nutWallFunction;
+        value           uniform 0.0;
     }
     \endverbatim
 
+    Reference for the default model coefficients:
+    \verbatim
+        H. Versteeg, W. Malalasekera
+        An Introduction to Computational Fluid Dynamics: The Finite Volume
+        Method, subsection "3.5.2 k-epsilon model"
+    \endverbatim
+
 SeeAlso
     Foam::fixedValueFvPatchField