Merge branch 'develop' into 'master'

Final content for 1812 release

executables/cartesian2DMesh/cartesian2DMesh.C

@@ -25,7 +25,7 @@ Application
     Generates cartesian mesh
 
 Description
-    Generates a 2D cartesian mesh
+    Takes a triangulated surface and generates a 2D cartesian mesh
 
 \*---------------------------------------------------------------------------*/
 
@@ -36,14 +36,19 @@ using namespace Foam;
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
-// Main program:
-
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "(cfmesh)\n"
+        "Takes a triangulated surface"
+        " and generates a 2D cartesian mesh"
+    );
+
     #include "setRootCase.H"
     #include "createTime.H"
 
-    // 2d cartesian mesher cannot be run in parallel
+    // 2D cartesian mesher cannot be run in parallel
     argList::noParallel();
 
     Module::cartesian2DMeshGenerator cmg(runTime);

executables/cartesianMesh/cartesianMesh.C

@@ -25,7 +25,7 @@ Application
     Generates cartesian mesh
 
 Description
-    - takes a triangulated surface and generates a cartesian mesh
+    Takes a triangulated surface and generates a cartesian mesh
 
 \*---------------------------------------------------------------------------*/
 
@@ -38,6 +38,13 @@ using namespace Foam;
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "(cfmesh)\n"
+        "Takes a triangulated surface"
+        " and generates a cartesian mesh"
+    );
+
     #include "setRootCase.H"
     #include "createTime.H"
 

executables/pMesh/pMesh.C

@@ -38,6 +38,13 @@ using namespace Foam;
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "(cfmesh)\n"
+        "Takes a triangulated surface"
+        " and generates a body-fitted polyhedral mesh"
+    );
+
     #include "setRootCase.H"
     #include "createTime.H"
 

executables/tetMesh/tetMesh.C

@@ -38,6 +38,13 @@ using namespace Foam;
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "(cfmesh)\n"
+        "Takes a triangulated surface"
+        " and generates a tetrahedral mesh"
+    );
+
     #include "setRootCase.H"
     #include "createTime.H"
 

meshLibrary/cartesian2DMesh/cartesian2DMeshGenerator/cartesian2DMeshGenerator.C

@@ -286,7 +286,7 @@ Foam::Module::cartesian2DMeshGenerator::cartesian2DMeshGenerator
             checkMeshDict cmd(meshDict_);
         }
 
-        fileName surfaceFile = meshDict_.lookup("surfaceFile");
+        fileName surfaceFile(meshDict_.lookup("surfaceFile"));
         if (Pstream::parRun())
         {
             surfaceFile = ".."/surfaceFile;

meshLibrary/cartesianMesh/cartesianMeshGenerator/cartesianMeshGenerator.C

@@ -342,7 +342,7 @@ Foam::Module::cartesianMeshGenerator::cartesianMeshGenerator(const Time& time)
             checkMeshDict cmd(meshDict_);
         }
 
-        fileName surfaceFile = meshDict_.lookup("surfaceFile");
+        fileName surfaceFile(meshDict_.lookup("surfaceFile"));
         if (Pstream::parRun())
             surfaceFile = ".."/surfaceFile;
 

meshLibrary/tetMesh/tetMeshGenerator/tetMeshGenerator.C

@@ -322,7 +322,7 @@ Foam::Module::tetMeshGenerator::tetMeshGenerator(const Time& time)
             checkMeshDict cmd(meshDict_);
         }
 
-        const fileName surfaceFile = meshDict_.lookup("surfaceFile");
+        const fileName surfaceFile(meshDict_.lookup("surfaceFile"));
 
         surfacePtr_ = new triSurf(runTime_.path()/surfaceFile);
 

meshLibrary/utilities/anisotropicMeshing/coordinateModification/boxScaling.H

@@ -46,6 +46,10 @@ namespace Foam
 namespace Module
 {
 
+// Forward declarations
+class boxScaling;
+Ostream& operator<<(Ostream&, const boxScaling&);
+
 /*---------------------------------------------------------------------------*\
                          Class boxScaling Declaration
 \*---------------------------------------------------------------------------*/

meshLibrary/utilities/containers/VRWGraph/VRWGraph.H

@@ -51,7 +51,9 @@ namespace Foam
 namespace Module
 {
 
+// Forward declarations
 class VRWGraph;
+Ostream& operator<<(Ostream&, const VRWGraph&);
 
 class rowElement
 {

meshLibrary/utilities/containers/VRWGraphList/VRWGraphList.H

@@ -47,6 +47,10 @@ namespace Foam
 namespace Module
 {
 
+// Forward declarations
+class VRWGraphList;
+Ostream& operator<<(Ostream&, const VRWGraphList&);
+
 /*---------------------------------------------------------------------------*\
                         Class VRWGraphList Declaration
 \*---------------------------------------------------------------------------*/

meshLibrary/utilities/meshes/polyMeshGen/polyMeshGenFaces.C

@@ -29,7 +29,7 @@ License
 #include "IOobjectList.H"
 #include "faceSet.H"
 #include "demandDrivenData.H"
-#include "ListOps.H"
+#include "stringListOps.H"
 
 // * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * * //
 
@@ -268,15 +268,16 @@ Foam::labelList Foam::Module::polyMeshGenFaces::findPatches
     const word& patchName
 ) const
 {
-    const labelList ids = findIndices(patchNames(), patchName);
+    const labelList patchIDs =
+        findMatchingStrings(regExp(patchName), patchNames());
 
-    if (ids.empty())
+    if (patchIDs.empty())
     {
         WarningInFunction
             << "Cannot find any patch names matching " << patchName << endl;
     }
 
-    return ids;
+    return patchIDs;
 }
 
 

meshLibrary/utilities/meshes/triSurf/triSurfFacets.C

@@ -27,7 +27,7 @@ License
 #include "pointIOField.H"
 #include "IOobjectList.H"
 #include "pointSet.H"
-#include "ListOps.H"
+#include "stringListOps.H"
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
@@ -89,17 +89,18 @@ Foam::labelList Foam::Module::triSurfFacets::findPatches
     const word& patchName
 ) const
 {
-    const labelList ids = findIndices(patchNames(), patchName);
+    const labelList patchIDs =
+        findMatchingStrings(regExp(patchName), patchNames());
 
     # ifdef DEBUGtriSurf
-    if (ids.empty())
+    if (patchIDs.empty())
     {
         WarningInFunction
             << "Cannot find any patch names matching " << patchName << endl;
     }
     # endif
 
-    return ids;
+    return patchIDs;
 }
 
 

meshLibrary/voronoiMesh/voronoiMeshGenerator/voronoiMeshGenerator.C

@@ -385,7 +385,7 @@ Foam::Module::voronoiMeshGenerator::voronoiMeshGenerator(const Time& time)
         if (true)
             checkMeshDict cmd(meshDict_);
 
-        const fileName surfaceFile = meshDict_.lookup("surfaceFile");
+        const fileName surfaceFile(meshDict_.lookup("surfaceFile"));
 
         surfacePtr_ = new triSurf(runTime_.path()/surfaceFile);
 

utilities/FLMAToSurface/FLMAToSurface.C

@@ -40,6 +40,12 @@ using namespace Foam::Module;
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "(cfmesh)\n"
+        "Reads the AVL's surface mesh format."
+    );
+
     argList::noParallel();
     argList::validArgs.clear();
 

utilities/FMSToSurface/FMSToSurface.C

@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Description
-    Creates surface patches from surface subsets
+    Convert a FMS file to another surface format
 
 \*---------------------------------------------------------------------------*/
 
@@ -101,6 +101,12 @@ void exportFeatureEdges
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "(cfmesh)\n"
+        "Convert a FMS file to another surface format."
+    );
+
     argList::noParallel();
     argList::validArgs.clear();
 

utilities/FMSToVTK/FMSToVTK.C

@@ -326,6 +326,13 @@ void writeFacetsToVTK
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "(cfmesh)\n"
+        "Convert a surface file to VTK multiblock dataset format,"
+        " including the patches, feature edges and surface features."
+    );
+
     argList::noParallel();
     argList::validArgs.clear();
 

utilities/checkSurfaceMesh/checkSurfaceMesh.C

@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Description
-    Reads the specified surface and writes it in the fms format.
+    Perform surface mesh checks
 
 \*---------------------------------------------------------------------------*/
 
@@ -40,6 +40,12 @@ using namespace Foam::Module;
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "(cfmesh)\n"
+        "Perform surface mesh checks"
+    );
+
     argList::noParallel();
     argList::validArgs.clear();
     argList::validArgs.append("input surface file");

utilities/copySurfaceParts/copySurfaceParts.C

@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Description
-    Finds feature edges and corners of a triangulated surface
+    Copy parts of a surface mesh
 
 \*---------------------------------------------------------------------------*/
 
@@ -41,6 +41,12 @@ using namespace Foam::Module;
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "(cfmesh)\n"
+        "Copy parts of a surface mesh"
+    );
+
     argList::noParallel();
     argList::validArgs.clear();
     argList::validArgs.append("input surface file");

utilities/extrudeEdgesInto2DSurface/extrudeEdgesInto2DSurface.C

@@ -39,6 +39,13 @@ using namespace Foam::Module;
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "(cfmesh)\n"
+        "Reads the surface mesh, remove the selected facets"
+        " and writes the modified mesh into a new file"
+    );
+
     argList::noParallel();
     argList::validArgs.clear();
 

utilities/generateBoundaryLayers/generateBoundaryLayers.C

@@ -108,6 +108,13 @@ void layerRefinement(polyMeshGen& mesh, const dictionary& meshDict)
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "(cfmesh)\n"
+        "Generate boundary layers in the existing mesh,"
+        " based on the settings given in meshDict."
+    );
+
     argList::addBoolOption("2DLayers");
 
     #include "setRootCase.H"

utilities/importSurfaceAsSubset/importSurfaceAsSubset.C

@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Description
-    Finds feature edges and corners of a triangulated surface
+    Import a subset of a surface
 
 \*---------------------------------------------------------------------------*/
 
@@ -42,6 +42,12 @@ using namespace Foam::Module;
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "(cfmesh)\n"
+        "Import a subset of a surface"
+    );
+
     argList::noParallel();
     argList::validArgs.clear();
     argList::validArgs.append("master surface file");

utilities/improveMeshQuality/improveMeshQuality.C

@@ -23,7 +23,7 @@ License
 
 Description
     Performs point relocations in the mesh (smoothing) in order to
-    improve quality measures. It does not make the mesh invalied.
+    improve quality measures. It does not make the mesh invalid.
 
 \*---------------------------------------------------------------------------*/
 
@@ -38,6 +38,13 @@ using namespace Foam::Module;
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "(cfmesh)\n"
+        "Performs point relocations in the mesh (smoothing) in order to"
+        " improve quality measures."
+    );
+
     argList::validArgs.clear();
 
     argList::addOption("nLoops", "int");

utilities/improveSymmetryPlanes/improveSymmetryPlanes.C

@@ -38,6 +38,13 @@ using namespace Foam::Module;
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "(cfmesh)\n"
+        "Ensures that all mesh points belonging to a symmetryPlane are"
+        " in a plane."
+    );
+
     #include "setRootCase.H"
     #include "createTime.H"
 

utilities/mergeSurfacePatches/mergeSurfacePatches.C

@@ -296,6 +296,12 @@ autoPtr<triSurf> mergeSurfacePatches
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "(cfmesh)\n"
+        "Merge the supplied list of patches onto a single patch."
+    );
+
     argList::noParallel();
     argList::validArgs.clear();
 

utilities/meshToFPMA/meshToFPMA.C

@@ -37,6 +37,12 @@ using namespace Foam::Module;
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "(cfmesh)\n"
+        "Writes the mesh in fpma format readable by AVL's CfdWM"
+    );
+
     #include "setRootCase.H"
     #include "createTime.H"
 

utilities/patchesToSubsets/patchesToSubsets.C

@@ -40,6 +40,12 @@ using namespace Foam::Module;
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "(cfmesh)\n"
+        "Converts specified patches into subsets"
+    );
+
     argList::noParallel();
     argList::validArgs.clear();
 

utilities/preparePar/preparePar.C

@@ -25,7 +25,7 @@ Application
     Prepares the case for a parallel mesh generation run
 
 Description
-    - creates processor* directories which contain data for processors
+    Creates processor* directories which contain data for processors
 
 \*---------------------------------------------------------------------------*/
 
@@ -41,6 +41,7 @@ int main(int argc, char *argv[])
 {
     argList::addNote
     (
+        "(cfmesh)\n"
         "Create processor directories in preparation for a parallel run"
     );
 

utilities/removeSurfaceFacets/removeSurfaceFacets.C

@@ -38,6 +38,13 @@ using namespace Foam::Module;
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "(cfmesh)\n"
+        "Reads the surface mesh, remove the selected facets"
+        " and writes the modified mesh into a new file"
+    );
+
     argList::noParallel();
     argList::validArgs.clear();
 

utilities/scaleMesh/scaleMesh.C

@@ -37,6 +37,12 @@ using namespace Foam::Module;
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "(cfmesh)\n"
+        "Scales the mesh into other units"
+    );
+
     argList::validArgs.append("scalingFactor");
 
     #include "setRootCase.H"

utilities/scaleSurfaceMesh/scaleSurfaceMesh.C

@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Description
-    Scales surface vertices by a precribed factor.
+    Scales surface vertices by a prescribed factor.
 
 \*---------------------------------------------------------------------------*/
 
@@ -39,6 +39,12 @@ using namespace Foam::Module;
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "(cfmesh)\n"
+        "Scales surface vertices by a prescribed factor"
+    );
+
     argList::noParallel();
     argList::validArgs.clear();
     argList::validArgs.append("input surface file");

utilities/subsetToPatch/subsetToPatch.C

@@ -119,6 +119,12 @@ void makePatchFromSubset
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "(cfmesh)\n"
+        "Creates surface patches from surface subsets"
+    );
+
     argList::noParallel();
     argList::validArgs.clear();
 

utilities/surfaceFeatureEdges/surfaceFeatureEdges.C

@@ -43,11 +43,17 @@ using namespace Foam::Module;
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "(cfmesh)\n"
+        "Finds feature edges and corners of a triangulated surface"
+    );
+
     argList::noParallel();
     argList::validArgs.clear();
     argList::validArgs.append("input surface file");
     argList::validArgs.append("output surface file");
-    argList::addOption("angle", "scalar");
+    argList::addOption("angle", "scalar", "feature angle (degrees)");
     argList args(argc, argv);
 
     const fileName inFileName(args[1]);

utilities/surfaceGenerateBoundingBox/surfaceGenerateBoundingBox.C

@@ -44,6 +44,12 @@ using namespace Foam::Module;
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "(cfmesh)\n"
+        "Finds feature edges and corners of a triangulated surface"
+    );
+
     argList::noParallel();
     argList::validArgs.clear();
     argList::validArgs.append("input surface file");

utilities/surfaceToFMS/surfaceToFMS.C

@@ -37,9 +37,16 @@ using namespace Foam;
 
 int main(int argc, char *argv[])
 {
+    argList::addNote
+    (
+        "(cfmesh)\n"
+        "Reads the specified surface and writes it in the fms format"
+    );
+
     argList::noParallel();
     argList::validArgs.clear();
     argList::validArgs.append("input surface file");
+
     argList args(argc, argv);
 
     const fileName inFileName(args[1]);