From 52e79b47037fc5e93fa5f5854d775b6a08fb4cee Mon Sep 17 00:00:00 2001
From: Henry Weller <http://cfd.direct>
Date: Wed, 4 May 2016 08:51:39 +0100
Subject: [PATCH] functionObjects: Updated docs

---
 .../dataConversion/foamToVTK/foamToVTK.C              |  4 ++--
 .../functionObjects/doc/functionObjects.dox           | 11 ++++-------
 src/postProcessing/functionObjects/field/div/div.H    |  2 +-
 src/postProcessing/functionObjects/field/grad/grad.H  |  2 +-
 src/postProcessing/functionObjects/field/mag/mag.H    |  2 +-
 .../forces/pressureTools/pressureTools.H              |  2 +-
 .../forces/wallShearStress/wallShearStress.H          |  2 +-
 .../functionObjects/lagrangian/cloudInfo/cloudInfo.H  |  2 +-
 .../functionObjects/utilities/abort/abort.H           |  2 +-
 .../utilities/partialWrite/partialWrite.H             |  2 +-
 .../removeRegisteredObject/removeRegisteredObject.H   |  2 +-
 .../writeRegisteredObject/writeRegisteredObject.H     |  2 +-
 12 files changed, 16 insertions(+), 19 deletions(-)

diff --git a/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C b/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C
index 1bdbe8baf4..cebe442ca0 100644
--- a/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C
+++ b/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C
@@ -191,7 +191,7 @@ void print(Ostream& os, const wordList& flds)
 labelList getSelectedPatches
 (
     const polyBoundaryMesh& patches,
-    const List<wordRe>& excludePatches  //HashSet<word>& excludePatches
+    const List<wordRe>& excludePatches
 )
 {
     DynamicList<label> patchIDs(patches.size());
@@ -205,7 +205,7 @@ labelList getSelectedPatches
         if
         (
             isType<emptyPolyPatch>(pp)
-            || (Pstream::parRun() && isType<processorPolyPatch>(pp))
+         || (Pstream::parRun() && isType<processorPolyPatch>(pp))
         )
         {
             Info<< "    discarding empty/processor patch " << patchi
diff --git a/src/postProcessing/functionObjects/doc/functionObjects.dox b/src/postProcessing/functionObjects/doc/functionObjects.dox
index 4fa79c730c..5cab990a61 100644
--- a/src/postProcessing/functionObjects/doc/functionObjects.dox
+++ b/src/postProcessing/functionObjects/doc/functionObjects.dox
@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2012-2014 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2012-2016 OpenFOAM Foundation
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -36,12 +36,9 @@ utility.
 
 \linebreak
 The current range of features comprises of:
-- \ref grpCloudFunctionObjects
+- \ref grpLagrangianFunctionObjects
 - \ref grpFieldFunctionObjects
 - \ref grpForcesFunctionObjects
-- \ref grpFVFunctionObjects
-- \ref grpIOFunctionObjects
-- \ref grpJobControlFunctionObjects
 - \ref grpUtilitiesFunctionObjects
 
 \linebreak
@@ -78,7 +75,7 @@ Where:
     region   | name of region for multi-region cases | no       |
     enabled  | on/off switch                         | no       | yes
     timeStart| start time                            | no       |
-    timeEnd  | end time                              | no       | 
+    timeEnd  | end time                              | no       |
     outputControl | when to output: either 'outputTime' or 'timeStep'| no | timeStep
     outputInterval| steps between output when outputControl=timeStep | no | 1
 \endtable
@@ -88,7 +85,7 @@ typically used as the name of the output directory for any derived data.  The
 \c type entry defines the type of function object properties that follow.
 Since the function objects are packaged into separate libraries, the user must
 tell the code where to find the function object implementation, identified
-using the \c libs entry.  
+using the \c libs entry.
 
 
 \*---------------------------------------------------------------------------*/
diff --git a/src/postProcessing/functionObjects/field/div/div.H b/src/postProcessing/functionObjects/field/div/div.H
index 8fe81600fe..97f96b0a20 100644
--- a/src/postProcessing/functionObjects/field/div/div.H
+++ b/src/postProcessing/functionObjects/field/div/div.H
@@ -25,7 +25,7 @@ Class
     Foam::functionObjects::div
 
 Group
-    grpFVFunctionObjects
+    grpFieldFunctionObjects
 
 Description
     This function object calculates the divergence of a field.  The operation is
diff --git a/src/postProcessing/functionObjects/field/grad/grad.H b/src/postProcessing/functionObjects/field/grad/grad.H
index d017c57f48..124c676037 100644
--- a/src/postProcessing/functionObjects/field/grad/grad.H
+++ b/src/postProcessing/functionObjects/field/grad/grad.H
@@ -25,7 +25,7 @@ Class
     Foam::functionObjects::grad
 
 Group
-    grpFVFunctionObjects
+    grpFieldFunctionObjects
 
 Description
     This function object calculates the gradient of a field.  The operation is
diff --git a/src/postProcessing/functionObjects/field/mag/mag.H b/src/postProcessing/functionObjects/field/mag/mag.H
index 13de0cc074..934b906e16 100644
--- a/src/postProcessing/functionObjects/field/mag/mag.H
+++ b/src/postProcessing/functionObjects/field/mag/mag.H
@@ -25,7 +25,7 @@ Class
     Foam::functionObjects::mag
 
 Group
-    grpFVFunctionObjects
+    grpFieldFunctionObjects
 
 Description
     This function object calculates the magnitude of a field.  The operation
diff --git a/src/postProcessing/functionObjects/forces/pressureTools/pressureTools.H b/src/postProcessing/functionObjects/forces/pressureTools/pressureTools.H
index 67a04f8466..9270d67fee 100644
--- a/src/postProcessing/functionObjects/forces/pressureTools/pressureTools.H
+++ b/src/postProcessing/functionObjects/forces/pressureTools/pressureTools.H
@@ -25,7 +25,7 @@ Class
     Foam::functionObjects::pressureTools
 
 Group
-    grpUtilitiesFunctionObjects
+    grpForcesFunctionObjects
 
 Description
     This function object includes tools to manipulate the pressure into
diff --git a/src/postProcessing/functionObjects/forces/wallShearStress/wallShearStress.H b/src/postProcessing/functionObjects/forces/wallShearStress/wallShearStress.H
index cd00e72466..3fa7f2a96a 100644
--- a/src/postProcessing/functionObjects/forces/wallShearStress/wallShearStress.H
+++ b/src/postProcessing/functionObjects/forces/wallShearStress/wallShearStress.H
@@ -25,7 +25,7 @@ Class
     Foam::functionObjects::wallShearStress
 
 Group
-    grpUtilitiesFunctionObjects
+    grpForcesFunctionObjects
 
 Description
     This function object evaluates and outputs the shear stress at wall
diff --git a/src/postProcessing/functionObjects/lagrangian/cloudInfo/cloudInfo.H b/src/postProcessing/functionObjects/lagrangian/cloudInfo/cloudInfo.H
index 54c119cb2b..5361877799 100644
--- a/src/postProcessing/functionObjects/lagrangian/cloudInfo/cloudInfo.H
+++ b/src/postProcessing/functionObjects/lagrangian/cloudInfo/cloudInfo.H
@@ -25,7 +25,7 @@ Class
     Foam::functionObjects::cloudInfo
 
 Group
-    grpCloudFunctionObjects
+    grpLagrangianFunctionObjects
 
 Description
     This function object outputs Lagrangian cloud information to a file.  The
diff --git a/src/postProcessing/functionObjects/utilities/abort/abort.H b/src/postProcessing/functionObjects/utilities/abort/abort.H
index 4224d980bb..1cb6a47f76 100644
--- a/src/postProcessing/functionObjects/utilities/abort/abort.H
+++ b/src/postProcessing/functionObjects/utilities/abort/abort.H
@@ -25,7 +25,7 @@ Class
     Foam::functionObjects::abort
 
 Group
-    grpJobControlFunctionObjects
+    grpUtilitiesFunctionObjects
 
 Description
     Watches for presence of the named file in the $FOAM_CASE directory
diff --git a/src/postProcessing/functionObjects/utilities/partialWrite/partialWrite.H b/src/postProcessing/functionObjects/utilities/partialWrite/partialWrite.H
index e5ba6ff936..800bbcb17a 100644
--- a/src/postProcessing/functionObjects/utilities/partialWrite/partialWrite.H
+++ b/src/postProcessing/functionObjects/utilities/partialWrite/partialWrite.H
@@ -25,7 +25,7 @@ Class
     Foam::functionObjects::partialWrite
 
 Group
-    grpIOFunctionObjects
+    grpUtilitiesFunctionObjects
 
 Description
     This function object allows user-selected fields/registered objects to be
diff --git a/src/postProcessing/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H b/src/postProcessing/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H
index b8a7da75bb..5b19534309 100644
--- a/src/postProcessing/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H
+++ b/src/postProcessing/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H
@@ -25,7 +25,7 @@ Class
     Foam::functionObjects::removeRegisteredObject
 
 Group
-    grpIOFunctionObjects
+    grpUtilitiesFunctionObjects
 
 Description
     This function object removes registered objects if present in the database
diff --git a/src/postProcessing/functionObjects/utilities/writeRegisteredObject/writeRegisteredObject.H b/src/postProcessing/functionObjects/utilities/writeRegisteredObject/writeRegisteredObject.H
index efae29d045..4a34dccc3c 100644
--- a/src/postProcessing/functionObjects/utilities/writeRegisteredObject/writeRegisteredObject.H
+++ b/src/postProcessing/functionObjects/utilities/writeRegisteredObject/writeRegisteredObject.H
@@ -25,7 +25,7 @@ Class
     Foam::functionObjects::writeRegisteredObject
 
 Group
-    grpIOFunctionObjects
+    grpUtilitiesFunctionObjects
 
 Description
     This function object allows specification of different writing frequency