Merge pull request #5 from timofeymukha/develop

Merge develop in prep for 0.7.0

docs/configuration.rst

@@ -0,0 +1,21 @@
+.. _configuration:
+
+Configuration
+=============
+
+There are some shared options that apply to all all models.
+The most important ones relate to the sampling of the data to the wall model,
+which are discussed in a separate section, see :ref:`sampling`.
+Here, we list the others.
+
+
+- :code:`silent`. This controls the verbosity of the wall model in the log file.
+  Currently, if one sets this to 1 the wall model will no longer print information
+  on time consumption.
+- :code:`copyToPatchInternalField`.
+  If true, the wall values of :code:`nut` will be copied to the wall-adjacent 
+  cell.
+  This promotes the stability of the model.
+
+
+

docs/index.rst

@@ -21,6 +21,7 @@ If you use the library, please cite the following publication:
    quickstart
    wallmodelling
    grid_construction
+   configuration
    sampling
    troubleshooting
    zzreferences

docs/sampling.rst

@@ -15,7 +15,7 @@ The alternatives are :code:`Tree` and :code:`Crawling`, the former being the def
 The :code:`Tree` sampler uses the :code:`indexedOctree` class available in OpenFOAM in order to search for the cell
 containing any given point.
 For each face, the point to search for is computed by following the face normal for a distance :math:`h` prescribed by
-the user for this face. 
+the user for this face.
 The advantage of the :code:`Tree` sampler is that it does not rely on mesh structure in any way.
 **NB**: the :code:`Tree` sampler is known to crash :code:`reconstructPar`, when :code:`cyclicAMI` boundaries are present
 in the case.

wallModels/wallModelFvPatchScalarField.H

@@ -24,15 +24,16 @@ Class
     
     Handles creating and storing fields used by the wall models.
     The following fields are created and stored in the registry.
-    - h, the patch fields of which hold the distance to the cells used for
-    sampling. This field is read and must be present for the simulation to run.
+    - hSampler or h, the patch fields of which hold the distance to the cells 
+    used for sampling. This field is read and must be present for the simulation
+    to run.
     - samplingCells, which marks the cells used for sampling with a value
     corresponding to the index of the patch that uses them.
     - uTauPredicted, the patch fields of which hold the value of uTau as
     predicted by the wall model.
     - wallShearStress, the patch fields of which hold the value of the wall 
     shear stress.
-    - wallGradU, the patch fields of which store the wall-nromal of the velocity
+    - wallGradU, the patch fields of which store the wall-normal of the velocity
     gradient.