STYLE: add usage notes to more utilities and solvers

applications/utilities/mesh/advanced/PDRMesh/PDRMesh.C

@@ -614,6 +614,10 @@ label findPatch(const polyBoundaryMesh& patches, const word& patchName)
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Mesh and field preparation utility for PDR type simulations."
+    );
     #include "addOverwriteOption.H"
 
     argList::noFunctionObjects();  // Never use function objects

applications/utilities/mesh/advanced/collapseEdges/collapseEdges.C

@@ -63,13 +63,12 @@ using namespace Foam;
 
 int main(int argc, char *argv[])
 {
-    timeSelector::addOptions(true, false);
     argList::addNote
     (
         "Collapses small edges to a point.\n"
         "Optionally collapse small faces to a point and thin faces to an edge."
     );
-
+    timeSelector::addOptions(true, false);  // constant(true), zero(false)
     argList::addBoolOption
     (
         "collapseFaces",

applications/utilities/mesh/advanced/combinePatchFaces/combinePatchFaces.C

@@ -28,7 +28,7 @@ Group
     grpMeshAdvancedUtilities
 
 Description
-    Checks for multiple patch faces on same cell and combines them.
+    Checks for multiple patch faces on the same cell and combines them.
     Multiple patch faces can result from e.g. removal of refined
     neighbouring cells, leaving 4 exposed faces with same owner.
 
@@ -343,6 +343,11 @@ label mergeEdges(const scalar minCos, polyMesh& mesh)
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Checks for multiple patch faces on the same cell and combines them."
+    );
+
     #include "addOverwriteOption.H"
 
     argList::addArgument("featureAngle [0..180]");

applications/utilities/mesh/advanced/modifyMesh/modifyMesh.C

@@ -28,7 +28,7 @@ Group
     grpMeshAdvancedUtilities
 
 Description
-    Manipulates mesh elements.
+    Manipulate mesh elements.
 
     Actions are:
         (boundary)points:
@@ -336,6 +336,11 @@ label findCell(const primitiveMesh& mesh, const point& nearPoint)
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Manipulate mesh elements.\n"
+        "For example, moving points, splitting/collapsing edges etc."
+    );
     #include "addOverwriteOption.H"
     #include "addDictOption.H"
 

applications/utilities/mesh/advanced/refineHexMesh/refineHexMesh.C

@@ -28,7 +28,7 @@ Group
     grpMeshAdvancedUtilities
 
 Description
-    Refines a hex mesh by 2x2x2 cell splitting.
+    Refine a hex mesh by 2x2x2 cell splitting for the specified cellSet.
 
 \*---------------------------------------------------------------------------*/
 
@@ -56,6 +56,10 @@ using namespace Foam;
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Refine a hex mesh by 2x2x2 cell splitting for the specified cellSet"
+    );
     #include "addOverwriteOption.H"
     #include "addRegionOption.H"
     argList::addArgument("cellSet");

applications/utilities/mesh/advanced/refineWallLayer/refineWallLayer.C

@@ -28,7 +28,7 @@ Group
     grpMeshAdvancedUtilities
 
 Description
-    Utility to refine cells next to patches.
+    Refine cells next to specified patches.
 
     Arguments:
         1: List of patch name regular expressions
@@ -61,6 +61,12 @@ using namespace Foam;
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Refine cells next to specified patches.\n"
+        "The list of patches may contain regular expressions.\n"
+    );
+
     #include "addOverwriteOption.H"
     argList::addArgument("patches");
     argList::addArgument("edgeFraction");

applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C

@@ -28,8 +28,8 @@ Group
     grpMeshAdvancedUtilities
 
 Description
-    Tries to figure out what the refinement level is on refined cartesian
-    meshes. Run BEFORE snapping.
+    Attempt to determine the refinement levels of a refined cartesian mesh.
+    Run BEFORE snapping.
 
     Writes
     - volScalarField 'refinementLevel' with current refinement level.
@@ -98,9 +98,14 @@ bool limitRefinementLevel
 }
 
 
-
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Attempt to determine refinement levels of a refined cartesian mesh.\n"
+        "Run BEFORE snapping!"
+    );
+
     argList::addBoolOption
     (
         "readLevel",

applications/utilities/mesh/advanced/removeFaces/removeFaces.C

@@ -28,7 +28,7 @@ Group
     grpMeshAdvancedUtilities
 
 Description
-    Utility to remove faces (combines cells on both sides).
+    Remove faces specified in faceSet by combining cells on both sides.
 
     Takes faceSet of candidates for removal and writes faceSet with faces that
     will actually be removed. (because e.g. would cause two faces between the
@@ -53,6 +53,10 @@ using namespace Foam;
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Remove faces specified in faceSet by combining cells on both sides"
+    );
     #include "addOverwriteOption.H"
     argList::addArgument("faceSet");
 

applications/utilities/mesh/advanced/selectCells/selectCells.C

@@ -335,6 +335,11 @@ label selectOutsideCells
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Select cells in relation to surface"
+    );
+
     argList::noParallel();
 
     #include "setRootCase.H"

applications/utilities/mesh/advanced/snappyRefineMesh/snappyRefineMesh.C

@@ -28,7 +28,7 @@ Group
     grpMeshAdvancedUtilities
 
 Description
-    Utility to refine cells near to a surface.
+    Refine cells near to a surface.
 
 \*---------------------------------------------------------------------------*/
 
@@ -623,6 +623,10 @@ void classifyCells
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "Refine cells near to a surface"
+    );
     argList::noParallel();
 
     #include "setRootCase.H"