ENH: Updated function object documentation

src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H

@@ -28,8 +28,45 @@ Group
     grpForcesFunctionObjects
 
 Description
-    Derived from the forces function object, creates a specialisation to
+    This function object extends the Foam::forces function object by providing
-    calculate lift and drag forces.
+    lift, drag and moment coefficients.
+
+    Example of function object specification:
+    \verbatim
+    forceCoeffs1
+    {
+        type        forceCoeffs;
+        functionObjectLibs ("libforces.so");
+        ...
+        log         yes;
+        patches     (walls);
+        liftDir     (0 1 0);
+        dragDir     (-1 0 0);
+        pitchAxis   (0 0 1);
+        magUInf     100;
+        lRef        3.5;
+        ARef        2.2;
+    }
+    \endverbatim
+
+    \heading Function object usage
+    \table
+        Property     | Description             | Required    | Default value
+        type         | type name: forces       | yes         |
+        log          | write force data to standard output | no | no
+        patches      | patches included in the forces calculation | yes |
+        liftDir      | lift direction          | yes         |
+        dragDir      | drag direction          | yes         |
+        pitchAxis    | picth axis              | yes         |
+        magUInf      | free stream velocity magnitude | yes  |
+        lRef         | reference length scale for moment calculations | yes |
+        ARef         | reference area          | yes |
+    \endtable
+
+SeeAlso
+    Foam::functionObject
+    Foam::OutputFilterFunctionObject
+    Foam::forces
 
 SourceFiles
     forceCoeffs.C

src/postProcessing/functionObjects/forces/forces/forces.H

@@ -28,16 +28,49 @@ Group
     grpForcesFunctionObjects
 
 Description
-    Calculates the forces and moments by integrating the pressure and
+    This function object calculates the forces and moments by integrating the
-    skin-friction forces over a given list of patches.
+    pressure and skin-friction forces over a given list of patches.
 
     Member function forces::write() calculates the forces/moments and
     writes the forces/moments into the file \<timeDir\>/forces.dat
 
+    Example of function object specification:
+    \verbatim
+    forces1
+    {
+        type        forces;
+        functionObjectLibs ("libforces.so");
+        ...
+        log         yes;
+        patches     (walls);
+        
+    }
+    \endverbatim
+
+    \heading Function object usage
+    \table
+        Property     | Description             | Required    | Default value
+        type         | type name: forces       | yes         |
+        log          | write force data to standard output | no | no
+        patches      | patches included in the forces calculation | yes |
+        pName        | pressure field name     | no          | p
+        UName        | velocity field name     | no          | U
+        rhoName      | density field name (see below) | no   | rho
+        CofR         | centre of rotation (see below) | no   |
+        directForceDensity | force density supplied directly (see below)|no|no
+        fDName       | name of force density field (see below) | no | fD
+    \endtable
+
 Note
-    The centre of rotation for moment calculations can either be specified
+  - For incompressible cases, set \c rhoName to \c rhoInf.  You will then be
-    by an \c CofR entry, or be taken from origin of the local coordinateSystem.
+    required to provide a \c rhoInf value corresponding to the free-stream
-    For example,
+    constant density.
+  - If the force density is supplied directly, set the \c directForceDensity
+    flag to 'yes', and supply the force density field using the \c
+    fDName entry
+  - The centre of rotation (CofR) for moment calculations can either be
+    specified by an \c CofR entry, or be taken from origin of the local
+    coordinate system.  For example,
     \verbatim
         CofR        (0 0 0);
     \endverbatim
@@ -51,6 +84,11 @@ Note
         }
     \endverbatim
 
+SeeAlso
+    Foam::functionObject
+    Foam::OutputFilterFunctionObject
+    Foam::forceCoeffs
+
 SourceFiles
     forces.C
     IOforces.H