ENH: Updates to doxygen docs

src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H

@@ -34,13 +34,14 @@ Description
     the calculation.  The current options include:
     - \c mean: arithmetic mean:
         \f[
-            \overline{x} = \frac{\Sigma x i}{\Sigma i}
+            \overline{x} = \frac{1}{N}\displaystyle\sum\limits_{i=0}^N x_i
         \f]
     - \c prime2Mean: prime-squared mean
         \f[
-            \overline{x'}^2 = \frac{\Sigma (x - \overline{x}) i}{\Sigma i}
+            \overline{x'}^2 = \frac{1}{N}\displaystyle\sum\limits_{i=0}^N
+            (x_i - \overline{x})^2
         \f]
-    - base: average over 'time', or 'iteration' (\f$i\f$ in the above)
+    - base: average over 'time', or 'iteration' (\f$N\f$ in the above)
     - window: optional averaging window, specified in 'base' units
 
     \note

src/postProcessing/functionObjects/field/fieldValues/faceSource/faceSource.H

@@ -28,6 +28,7 @@ Description
     Face source variant of field value function object. Values of user-
     specified fields reported for collections of faces.
 
+    \verbatim
     faceObj1                        // Name also used to identify output folder
     {
         type            faceSource;
@@ -48,6 +49,7 @@ Description
             U
         );
     }
+    \endverbatim
 
     source:
     - faceZone       : requires a 'sourceName' entry to specify the faceZone
@@ -56,34 +58,37 @@ Description
                        sampleDict.
 
     operation is one of:
-      - none
+    - none
-      - sum
+    - sum
-      - average
+    - average (ensemble)
-      - weightedAverage
+    - weightedAverage
-      - areaAverage
+    - areaAverage
-      - areaIntegrate
+    - areaIntegrate
-      - min
+    - min
-      - max
+    - max
-      - CoV (Coefficient of variation: standard deviation/mean)
+    - CoV (Coefficient of variation: standard deviation/mean)
-      - areaNormalAverage   (vector with first component (average of) inproduct
+    - areaNormalAverage   (vector with first component (average of) inproduct
-                             of value and face area vector)
+                         of value and face area vector)
-      - areaNormalIntegrate (   ,,          ,,           (sum of)       ,,
+    - areaNormalIntegrate (   ,,          ,,           (sum of)       ,,
 
-    Notes:
+    For example, to calculate the volumetric or mass flux across a patch,
+    apply the 'sum' operator to the flux field (typically \c phi)
+
+    \note
     - faces on empty patches get ignored
-    - if the field is a volField the faceZone can only consist of boundary
+    - if the field is a volField the \c faceZone can only consist of boundary
-      faces.
+      faces
-    - all fields get oriented according to the faceZone (so you might e.g. see
+    - all fields get oriented according to the \c faceZone (so you might
-      negative pressure)
+      e.g. see negative pressure)
-    - using sampledSurfaces:
+    - using \c sampledSurfaces:
-            - they do not do surface fields
+        - they do not do surface fields
-            - if interpolate=true they use interpolationCellPoint
+        - if interpolate=true they use \c interpolationCellPoint
-              otherwise they use cell values
+          otherwise they use cell values
-            - each triangle in sampledSurface is logically only in one cell
+        - each triangle in \c sampledSurface is logically only in one cell
-              so interpolation will be wrong when triangles are larger than
+          so interpolation will be wrong when triangles are larger than
-              cells. This can only happen for sampling on triSurfaceMesh.
+          cells. This can only happen for sampling on \c triSurfaceMesh
-            - take care when using isoSurfaces - these might have duplicate
+        - take care when using isoSurfaces - these might have duplicate
-              triangles so integration might be wrong
+          triangles so integration might be wrong
 
 SourceFiles
     faceSource.C

src/thermophysicalModels/radiationModels/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H

@@ -33,6 +33,11 @@ Description
 
     \heading Patch usage
 
+    \table
+        Property     | Description             | Required    | Default value
+        T            | temperature field name  | no          | T
+    \endtable
+
     Example of the boundary condition specification:
     \verbatim
     myPatch

src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H

@@ -28,8 +28,11 @@ Group
     grpIcoWallFunctions
 
 Description
-    This boundary condition is applied to turbulence \c k, \c q, and \c R
+    This boundary condition provides a suitable condition for turbulence
-    when using wall functions, and simply enforces a zero-gradient condition.
+    \c k, \c q, and \c R fields for the case of high Reynolds number flow using
+    wall functions.
+
+    It is a simple wrapper around the zero-gradient condition.
 
     \heading Patch usage