diff --git a/applications/solvers/electromagnetics/magneticFoam/magneticFoam.C b/applications/solvers/electromagnetics/magneticFoam/magneticFoam.C index 5a7b067da53e9a4059b48ad35ebea6aba8994a5c..e0bc47fe530699e88a370b16d467bf0671a66d90 100644 --- a/applications/solvers/electromagnetics/magneticFoam/magneticFoam.C +++ b/applications/solvers/electromagnetics/magneticFoam/magneticFoam.C @@ -50,19 +50,19 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "noH", - "do not write the magnetic field intensity field" + "Do not write the magnetic field intensity field" ); argList::addBoolOption ( "noB", - "do not write the magnetic flux density field" + "Do not write the magnetic flux density field" ); argList::addBoolOption ( "HdotGradH", - "write the paramagnetic particle force field" + "Write the paramagnetic particle force field" ); #include "addCheckCaseOptions.H" diff --git a/applications/utilities/mesh/advanced/combinePatchFaces/combinePatchFaces.C b/applications/utilities/mesh/advanced/combinePatchFaces/combinePatchFaces.C index 3ccc8fd094bbf3fc4c118ba3f05602b4cdfd38ab..51397c4fb21df1a596b6899d388212e38154e9d7 100644 --- a/applications/utilities/mesh/advanced/combinePatchFaces/combinePatchFaces.C +++ b/applications/utilities/mesh/advanced/combinePatchFaces/combinePatchFaces.C @@ -350,12 +350,12 @@ int main(int argc, char *argv[]) ( "concaveAngle", "degrees", - "specify concave angle [0..180] (default: 30 degrees)" + "Specify concave angle [0..180] (default: 30 degrees)" ); argList::addBoolOption ( "meshQuality", - "read user-defined mesh quality criterions from system/meshQualityDict" + "Read user-defined mesh quality criterions from system/meshQualityDict" ); #include "setRootCase.H" diff --git a/applications/utilities/mesh/advanced/refineHexMesh/refineHexMesh.C b/applications/utilities/mesh/advanced/refineHexMesh/refineHexMesh.C index ff9f3be692773c6364856eb4fdb2a4779389c235..b9ab10d6d16d7e6338caffe13eeb4058cc00b8fe 100644 --- a/applications/utilities/mesh/advanced/refineHexMesh/refineHexMesh.C +++ b/applications/utilities/mesh/advanced/refineHexMesh/refineHexMesh.C @@ -62,7 +62,7 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "minSet", - "remove cells from input cellSet to keep to 2:1 ratio" + "Remove cells from input cellSet to keep to 2:1 ratio" " (default is to extend set)" ); diff --git a/applications/utilities/mesh/advanced/refineWallLayer/refineWallLayer.C b/applications/utilities/mesh/advanced/refineWallLayer/refineWallLayer.C index 44ac8c0e26e31e50a2ae0ad89ac2a736a55410f6..b83d5095114fba7cf49842701512b33d06071e02 100644 --- a/applications/utilities/mesh/advanced/refineWallLayer/refineWallLayer.C +++ b/applications/utilities/mesh/advanced/refineWallLayer/refineWallLayer.C @@ -69,7 +69,7 @@ int main(int argc, char *argv[]) ( "useSet", "name", - "restrict cells to refine based on specified cellSet name" + "Restrict cells to refine based on specified cellSet name" ); diff --git a/applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C b/applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C index 34a22e98c4407c5285a67d80832faa14ebe2f82d..44a4aabf25cfb2a7c44231839f56ece889d980d9 100644 --- a/applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C +++ b/applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C @@ -104,7 +104,7 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "readLevel", - "read level from refinementLevel file" + "Read level from refinementLevel file" ); #include "setRootCase.H" diff --git a/applications/utilities/mesh/advanced/splitCells/splitCells.C b/applications/utilities/mesh/advanced/splitCells/splitCells.C index ee1d02e57dd37f1515b715b7b9c9662ff2039153..00fb0f7688eaac8bf1887b0f1a7120b8e841e371 100644 --- a/applications/utilities/mesh/advanced/splitCells/splitCells.C +++ b/applications/utilities/mesh/advanced/splitCells/splitCells.C @@ -524,7 +524,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "split cells with flat faces" + "Split cells with flat faces" ); #include "addOverwriteOption.H" argList::noParallel(); @@ -534,17 +534,18 @@ int main(int argc, char *argv[]) ( "set", "name", - "split cells from specified cellSet only" + "Split cells from specified cellSet only" ); argList::addBoolOption ( "geometry", - "use geometric cut for hexes as well" + "Use geometric cut for hexes as well" ); argList::addOption ( "tol", - "scalar", "edge snap tolerance (default 0.2)" + "scalar", + "Edge snap tolerance (default 0.2)" ); #include "setRootCase.H" diff --git a/applications/utilities/mesh/conversion/ansysToFoam/ansysToFoam.L b/applications/utilities/mesh/conversion/ansysToFoam/ansysToFoam.L index 2c0f74050ad6288b443762cd3891512f75a5fa3d..f9cdc426550585d49f83e7fcaa67fb7542a91a74 100644 --- a/applications/utilities/mesh/conversion/ansysToFoam/ansysToFoam.L +++ b/applications/utilities/mesh/conversion/ansysToFoam/ansysToFoam.L @@ -304,7 +304,7 @@ int main(int argc, char *argv[]) ( "scale", "factor", - "geometry scaling factor - default is 1" + "Geometry scaling factor - default is 1" ); argList args(argc, argv); diff --git a/applications/utilities/mesh/conversion/ccm/ccmToFoam/ccmToFoam.C b/applications/utilities/mesh/conversion/ccm/ccmToFoam/ccmToFoam.C index 98fa7d42a9f771e9cab21a218866eb94e35fa511..ea71b9a409e0787e101c20ab116ae47d114577eb 100644 --- a/applications/utilities/mesh/conversion/ccm/ccmToFoam/ccmToFoam.C +++ b/applications/utilities/mesh/conversion/ccm/ccmToFoam/ccmToFoam.C @@ -103,57 +103,57 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "ascii", - "write in ASCII format instead of binary" + "Write in ASCII format instead of binary" ); argList::addBoolOption ( "export", - "re-export mesh in CCM format for post-processing" + "Re-export mesh in CCM format for post-processing" ); argList::addBoolOption ( "list", - "list some information about the geometry" + "List some information about the geometry" ); argList::addOption ( "remap", "name", - "use specified remapping dictionary instead of <constant/remapping>" + "Use specified remapping dictionary instead of <constant/remapping>" ); argList::addOption ( "name", "name", - "provide alternative base name when re-exporting (implies -export). " + "Provide alternative base name when re-exporting (implies -export). " "Default is <meshExport>." ); argList::addBoolOption ( "noBaffles", - "remove any baffles by merging the faces" + "Remove any baffles by merging the faces" ); argList::addBoolOption ( "merge", - "merge in-place interfaces" + "Merge in-place interfaces" ); argList::addBoolOption ( "numbered", - "use numbered names (eg, patch_0, zone_0) only" + "Use numbered names (eg, patch_0, zone_0) only" ); argList::addOption ( "scale", "scale", - "geometry scaling factor - default is 1 (ie, no scaling)" + "Geometry scaling factor - default is 1 (ie, no scaling)" ); argList::addBoolOption ( "solids", - "treat any solid cells present just like fluid cells. " - "the default is to remove them." + "Treat any solid cells present just like fluid cells. " + "The default is to remove them." ); argList args(argc, argv); diff --git a/applications/utilities/mesh/conversion/ccm/foamToCcm/foamToCcm.C b/applications/utilities/mesh/conversion/ccm/foamToCcm/foamToCcm.C index db76532030b93ebf1709875b27cd114efc46c60b..3ba2feaec59b5899f07afc9e1eaf77f1a6cad532 100644 --- a/applications/utilities/mesh/conversion/ccm/foamToCcm/foamToCcm.C +++ b/applications/utilities/mesh/conversion/ccm/foamToCcm/foamToCcm.C @@ -91,29 +91,29 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "mesh", - "convert mesh only" + "Convert mesh only" ); argList::addOption ( "name", "name", - "provide alternative base name. Default is <meshExport>." + "Provide alternative base name. Default is <meshExport>." ); argList::addBoolOption ( "overwrite", - "no backup of existing output files" + "No backup of existing output files" ); argList::addOption ( "remap", "name", - "use specified remapping dictionary instead of <constant/remapping>" + "Use specified remapping dictionary instead of <constant/remapping>" ); argList::addBoolOption ( "results", - "convert results only" + "Convert results only" ); #include "setRootCase.H" diff --git a/applications/utilities/mesh/conversion/cfx4ToFoam/cfx4ToFoam.C b/applications/utilities/mesh/conversion/cfx4ToFoam/cfx4ToFoam.C index afaf80aaf10215b5805b30f45959547157a71424..edff7513d160676ce5ab6505381560145bf77abe 100644 --- a/applications/utilities/mesh/conversion/cfx4ToFoam/cfx4ToFoam.C +++ b/applications/utilities/mesh/conversion/cfx4ToFoam/cfx4ToFoam.C @@ -54,7 +54,7 @@ int main(int argc, char *argv[]) ( "scale", "factor", - "geometry scaling factor - default is 1" + "Geometry scaling factor - default is 1" ); argList args(argc, argv); diff --git a/applications/utilities/mesh/conversion/fireToFoam/fireToFoam.C b/applications/utilities/mesh/conversion/fireToFoam/fireToFoam.C index c7c6277d4b9f406db66aae6c9693c2352fe744b3..c6a5e46f0974b999198c5ede8eed162dcd331098 100644 --- a/applications/utilities/mesh/conversion/fireToFoam/fireToFoam.C +++ b/applications/utilities/mesh/conversion/fireToFoam/fireToFoam.C @@ -68,18 +68,18 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "ascii", - "write in ASCII format instead of binary" + "Write in ASCII format instead of binary" ); argList::addBoolOption ( "check", - "perform edge checking as well" + "Perform edge checking as well" ); argList::addOption ( "scale", "scale", - "geometry scaling factor - default is 1 (no scaling)" + "Geometry scaling factor - default is 1 (no scaling)" ); diff --git a/applications/utilities/mesh/conversion/fluent3DMeshToFoam/fluent3DMeshToFoam.L b/applications/utilities/mesh/conversion/fluent3DMeshToFoam/fluent3DMeshToFoam.L index f4ab86e9a713478c4ddbacffa06e483a090f6cfb..732acf48f5e21728f288410195fee1072a21888c 100644 --- a/applications/utilities/mesh/conversion/fluent3DMeshToFoam/fluent3DMeshToFoam.L +++ b/applications/utilities/mesh/conversion/fluent3DMeshToFoam/fluent3DMeshToFoam.L @@ -779,25 +779,25 @@ int main(int argc, char *argv[]) ( "scale", "factor", - "geometry scaling factor - default is 1" + "Geometry scaling factor - default is 1" ); argList::addOption ( "ignoreCellGroups", "names", - "specify cell groups to ignore" + "Specify cell groups to ignore" ); argList::addOption ( "ignoreFaceGroups", "names", - "specify face groups to ignore" + "Specify face groups to ignore" ); argList::addBoolOption ( "cubit", - "special parsing of (incorrect) cubit files" + "Special parsing of (incorrect) cubit files" ); argList args(argc, argv); diff --git a/applications/utilities/mesh/conversion/fluentMeshToFoam/fluentMeshToFoam.L b/applications/utilities/mesh/conversion/fluentMeshToFoam/fluentMeshToFoam.L index f01a59ffe96776c5fbe94ce9909cfcb2d68aa8bc..669114ba0307cb2aa7f1e791bcc887d2440ea40f 100644 --- a/applications/utilities/mesh/conversion/fluentMeshToFoam/fluentMeshToFoam.L +++ b/applications/utilities/mesh/conversion/fluentMeshToFoam/fluentMeshToFoam.L @@ -871,23 +871,23 @@ int main(int argc, char *argv[]) ( "scale", "factor", - "geometry scaling factor - default is 1" + "Geometry scaling factor - default is 1" ); argList::addOption ( "2D", "thickness", - "use when converting a 2-D mesh (applied before scale)" + "Use when converting a 2-D mesh (applied before scale)" ); argList::addBoolOption ( "writeSets", - "write cell zones and patches as sets" + "Write cell zones and patches as sets" ); argList::addBoolOption ( "writeZones", - "write cell zones as zones" + "Write cell zones as zones" ); argList args(argc, argv); diff --git a/applications/utilities/mesh/conversion/foamToFireMesh/foamToFireMesh.C b/applications/utilities/mesh/conversion/foamToFireMesh/foamToFireMesh.C index 00f53e3570ce667e88753f4e173edb841737b63d..9a9759df229fd92d4b186ab6ed671cf9793dc313 100644 --- a/applications/utilities/mesh/conversion/foamToFireMesh/foamToFireMesh.C +++ b/applications/utilities/mesh/conversion/foamToFireMesh/foamToFireMesh.C @@ -58,7 +58,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "read OpenFOAM mesh and write an AVL/FIRE fpma format" + "Read OpenFOAM mesh and write an AVL/FIRE fpma format" ); argList::noParallel(); timeSelector::addOptions(); @@ -66,13 +66,13 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "ascii", - "write in ASCII format instead of binary" + "Write in ASCII format instead of binary" ); argList::addOption ( "scale", "factor", - "geometry scaling factor - default is 1 (none)" + "Geometry scaling factor - default is 1 (none)" ); #include "setRootCase.H" diff --git a/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C b/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C index 642462c124f006091c2108c892edb62510ab2e01..e6fb3311ba2e16d3d535ca2da9ba329bbae5c93f 100644 --- a/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C +++ b/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C @@ -67,7 +67,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "read OpenFOAM mesh and write a STARCD/PROSTAR (v4) bnd/cel/vrt format" + "Read OpenFOAM mesh and write a STARCD/PROSTAR (v4) bnd/cel/vrt format" ); argList::noParallel(); timeSelector::addOptions(); @@ -76,12 +76,12 @@ int main(int argc, char *argv[]) ( "scale", "factor", - "geometry scaling factor - default is 1000 ([m] to [mm])" + "Geometry scaling factor - default is 1000 ([m] to [mm])" ); argList::addBoolOption ( "noBnd", - "suppress writing a boundary (.bnd) file" + "Suppress writing a boundary (.bnd) file" ); #include "setRootCase.H" diff --git a/applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C b/applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C index cebbcda5fdd116467fcddb3992f6ede6d5d99f72..01b72c42e9ff4d2a7ffb23fe3b70d2d686fe02f8 100644 --- a/applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C +++ b/applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C @@ -64,12 +64,12 @@ int main(int argc, char *argv[]) ( "scale", "factor", - "geometry scaling factor - default is 1" + "Geometry scaling factor - default is 1" ); argList::addBoolOption ( "tri", - "triangulate surface" + "Triangulate surface" ); #include "setRootCase.H" diff --git a/applications/utilities/mesh/conversion/gambitToFoam/gambitToFoam.L b/applications/utilities/mesh/conversion/gambitToFoam/gambitToFoam.L index 1b5e769d90707ac8367b65f9983dc0ba8458b11b..74994a7dba902e2e4c11120c5d66f73c413da591 100644 --- a/applications/utilities/mesh/conversion/gambitToFoam/gambitToFoam.L +++ b/applications/utilities/mesh/conversion/gambitToFoam/gambitToFoam.L @@ -631,7 +631,7 @@ int main(int argc, char *argv[]) ( "scale", "factor", - "geometry scaling factor - default is 1" + "Geometry scaling factor - default is 1" ); argList args(argc, argv); diff --git a/applications/utilities/mesh/conversion/gmshToFoam/gmshToFoam.C b/applications/utilities/mesh/conversion/gmshToFoam/gmshToFoam.C index aa936cca0eef71da432a9f5b09ab7fbc4136358e..d0dd7c4a4e490fd26fb0b40159579e4347d9281e 100644 --- a/applications/utilities/mesh/conversion/gmshToFoam/gmshToFoam.C +++ b/applications/utilities/mesh/conversion/gmshToFoam/gmshToFoam.C @@ -773,7 +773,7 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "keepOrientation", - "retain raw orientation for prisms/hexs" + "Retain raw orientation for prisms/hexs" ); #include "addRegionOption.H" diff --git a/applications/utilities/mesh/conversion/ideasUnvToFoam/ideasUnvToFoam.C b/applications/utilities/mesh/conversion/ideasUnvToFoam/ideasUnvToFoam.C index 6f5dad215ade3adc666a164adab53237f983a124..19f1b06d32ae402018c8a305caef6b6c36b606ec 100644 --- a/applications/utilities/mesh/conversion/ideasUnvToFoam/ideasUnvToFoam.C +++ b/applications/utilities/mesh/conversion/ideasUnvToFoam/ideasUnvToFoam.C @@ -671,7 +671,7 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "dump", - "dump boundary faces as boundaryFaces.obj (for debugging)" + "Dump boundary faces as boundaryFaces.obj (for debugging)" ); #include "setRootCase.H" diff --git a/applications/utilities/mesh/conversion/kivaToFoam/kivaToFoam.C b/applications/utilities/mesh/conversion/kivaToFoam/kivaToFoam.C index 2a25cac6f5760e693e1f9c4549c44664911474f5..7dd4c2a6a116cdb94f2575d0803ccdb16b86cdfd 100644 --- a/applications/utilities/mesh/conversion/kivaToFoam/kivaToFoam.C +++ b/applications/utilities/mesh/conversion/kivaToFoam/kivaToFoam.C @@ -63,19 +63,19 @@ int main(int argc, char *argv[]) ( "file", "name", - "specify alternative input file name - default is otape17" + "Specify alternative input file name - default is otape17" ); argList::addOption ( "version", "version", - "specify kiva version [kiva3|kiva3v] - default is '3v'" + "Specify kiva version [kiva3|kiva3v] - default is '3v'" ); argList::addOption ( "zHeadMin", "scalar", - "minimum z-height for transferring liner faces to cylinder-head" + "Minimum z-height for transferring liner faces to cylinder-head" ); #include "setRootCase.H" diff --git a/applications/utilities/mesh/conversion/mshToFoam/mshToFoam.C b/applications/utilities/mesh/conversion/mshToFoam/mshToFoam.C index 63fcf15a74f123dbe15b847ae10f5a49fa555706..ae2973be247c96fed986920ce4cd6c75420302ac 100644 --- a/applications/utilities/mesh/conversion/mshToFoam/mshToFoam.C +++ b/applications/utilities/mesh/conversion/mshToFoam/mshToFoam.C @@ -64,7 +64,7 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "hex", - "treat input as containing hex instead of tet cells" + "Treat input as containing hex instead of tet cells" ); #include "setRootCase.H" diff --git a/applications/utilities/mesh/conversion/plot3dToFoam/plot3dToFoam.C b/applications/utilities/mesh/conversion/plot3dToFoam/plot3dToFoam.C index f222e6cdfb74084fd596796cdc7ba2f9d8f86e09..59eddb7afd2e483af3a2c469c174db151d0abd58 100644 --- a/applications/utilities/mesh/conversion/plot3dToFoam/plot3dToFoam.C +++ b/applications/utilities/mesh/conversion/plot3dToFoam/plot3dToFoam.C @@ -64,23 +64,23 @@ int main(int argc, char *argv[]) ( "scale", "factor", - "geometry scaling factor - default is 1" + "Geometry scaling factor - default is 1" ); argList::addBoolOption ( "noBlank", - "skip blank items" + "Skip blank items" ); argList::addBoolOption ( "singleBlock", - "input is a single block" + "Input is a single block" ); argList::addOption ( "2D", "thickness", - "use when converting a 2-D mesh (applied before scale)" + "Use when converting a 2-D mesh (applied before scale)" ); argList args(argc, argv); diff --git a/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C b/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C index 806ded99fb1c0c8361967c2fe850dc80aa5edfca..be403f76e6245d1d3db7cd9cbe054eedb570987c 100644 --- a/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C +++ b/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C @@ -66,7 +66,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "convert STARCD/PROSTAR (v4) mesh to OpenFOAM" + "Convert STARCD/PROSTAR (v4) mesh to OpenFOAM" ); argList::noParallel(); @@ -74,18 +74,18 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "ascii", - "write in ASCII instead of binary format" + "Write in ASCII instead of binary format" ); argList::addOption ( "scale", "factor", - "geometry scaling factor - default is 0.001 ([mm] to [m])" + "Geometry scaling factor - default is 0.001 ([mm] to [m])" ); argList::addBoolOption ( "solids", - "retain solid cells and treat them like fluid cells" + "Retain solid cells and treat like fluid cells" ); diff --git a/applications/utilities/mesh/conversion/tetgenToFoam/tetgenToFoam.C b/applications/utilities/mesh/conversion/tetgenToFoam/tetgenToFoam.C index 7ff32d9f9ce556981f8f3f4c4b057d25dddc979a..7917e5053dbc588413efd1dcb9638ff83ee2edef 100644 --- a/applications/utilities/mesh/conversion/tetgenToFoam/tetgenToFoam.C +++ b/applications/utilities/mesh/conversion/tetgenToFoam/tetgenToFoam.C @@ -105,7 +105,7 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "noFaceFile", - "skip reading .face file for boundary information" + "Skip reading .face file for boundary information" ); #include "setRootCase.H" diff --git a/applications/utilities/mesh/conversion/writeMeshObj/writeMeshObj.C b/applications/utilities/mesh/conversion/writeMeshObj/writeMeshObj.C index bb34fe5a138a9723904f9588a00ea81fea59ae52..bbc00e9528b25827f80ac273f1e00ed1387476a5 100644 --- a/applications/utilities/mesh/conversion/writeMeshObj/writeMeshObj.C +++ b/applications/utilities/mesh/conversion/writeMeshObj/writeMeshObj.C @@ -376,49 +376,49 @@ int main(int argc, char *argv[]) { argList::addNote ( - "for mesh debugging: write mesh as separate OBJ files" + "For mesh debugging: write mesh as separate OBJ files" ); timeSelector::addOptions(); argList::addBoolOption ( "patchFaces", - "write patch faces edges" + "Write patch faces edges" ); argList::addBoolOption ( "patchEdges", - "write patch boundary edges" + "Write patch boundary edges" ); argList::addOption ( "cell", - "int", - "write points for the specified cell" + "cellId", + "Write points for the specified cell" ); argList::addOption ( "face", - "int", - "write specified face" + "faceId", + "Write specified face" ); argList::addOption ( "point", - "int", - "write specified point" + "pointId", + "Write specified point" ); argList::addOption ( "cellSet", "name", - "write points for specified cellSet" + "Write points for specified cellSet" ); argList::addOption ( "faceSet", "name", - "write points for specified faceSet" + "Write points for specified faceSet" ); #include "addRegionOption.H" diff --git a/applications/utilities/mesh/generation/blockMesh/blockMesh.C b/applications/utilities/mesh/generation/blockMesh/blockMesh.C index 65dfe0d830d3a74b8111f18b1606af0be49ad307..3be403bfb2ed9b810296f1c35e571e04bd4eb6b6 100644 --- a/applications/utilities/mesh/generation/blockMesh/blockMesh.C +++ b/applications/utilities/mesh/generation/blockMesh/blockMesh.C @@ -82,23 +82,23 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "blockTopology", - "write block edges and centres as .obj files" + "Write block edges and centres as .obj files" ); argList::addBoolOption ( "noClean", - "keep the existing files in the polyMesh" + "Keep the existing files in the polyMesh" ); argList::addOption ( "dict", "file", - "specify alternative dictionary for the blockMesh description" + "Specify alternative dictionary for the blockMesh description" ); argList::addBoolOption ( "sets", - "write cellZones as cellSets too (for processing purposes)" + "Write cellZones as cellSets too (for processing purposes)" ); argList::addNote ( diff --git a/applications/utilities/mesh/generation/foamyMesh/foamyHexMesh/foamyHexMesh.C b/applications/utilities/mesh/generation/foamyMesh/foamyHexMesh/foamyHexMesh.C index e9c4f6c8eadf9f5decd222df66c72060ebb9c250..9a4def5171acc61f5e047e3f399bc38d53a47931 100644 --- a/applications/utilities/mesh/generation/foamyMesh/foamyHexMesh/foamyHexMesh.C +++ b/applications/utilities/mesh/generation/foamyMesh/foamyHexMesh/foamyHexMesh.C @@ -45,16 +45,16 @@ using namespace Foam; int main(int argc, char *argv[]) { - Foam::argList::addBoolOption + argList::addBoolOption ( "checkGeometry", - "check all surface geometry for quality" + "Check all surface geometry for quality" ); - Foam::argList::addBoolOption + argList::addBoolOption ( "conformationOnly", - "conform to the initial points without any point motion" + "Conform to the initial points without any point motion" ); #include "setRootCase.H" diff --git a/applications/utilities/mesh/generation/foamyMesh/foamyHexMeshBackgroundMesh/foamyHexMeshBackgroundMesh.C b/applications/utilities/mesh/generation/foamyMesh/foamyHexMeshBackgroundMesh/foamyHexMeshBackgroundMesh.C index dc558b866406fc3106e6f80517e6e49adfa017d7..ce607439b31e8037b485f4949a94c7b8254bcc57 100644 --- a/applications/utilities/mesh/generation/foamyMesh/foamyHexMeshBackgroundMesh/foamyHexMeshBackgroundMesh.C +++ b/applications/utilities/mesh/generation/foamyMesh/foamyHexMeshBackgroundMesh/foamyHexMeshBackgroundMesh.C @@ -387,14 +387,13 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "writeMesh", - "write the resulting mesh and distance fields" + "Write the resulting mesh and distance fields" ); argList::addOption ( "mergeTol", "scalar", - "specify the merge distance relative to the bounding box size " - "(default 1e-6)" + "The merge distance relative to the bounding box size (default 1e-6)" ); #include "setRootCase.H" diff --git a/applications/utilities/mesh/generation/snappyHexMesh/snappyHexMesh.C b/applications/utilities/mesh/generation/snappyHexMesh/snappyHexMesh.C index e4ae058a0d1db375db164b160e53bace5d33570a..a2f4ac6fd7d33a508dfc1f11aaf1b5fa003d1652 100644 --- a/applications/utilities/mesh/generation/snappyHexMesh/snappyHexMesh.C +++ b/applications/utilities/mesh/generation/snappyHexMesh/snappyHexMesh.C @@ -679,28 +679,28 @@ int main(int argc, char *argv[]) { #include "addRegionOption.H" #include "addOverwriteOption.H" - Foam::argList::addBoolOption + argList::addBoolOption ( "checkGeometry", - "check all surface geometry for quality" + "Check all surface geometry for quality" ); - Foam::argList::addOption + argList::addOption ( "surfaceSimplify", "boundBox", - "simplify the surface using snappyHexMesh starting from a boundBox" + "Simplify the surface using snappyHexMesh starting from a boundBox" ); - Foam::argList::addOption + argList::addOption ( "patches", "(patch0 .. patchN)", - "only triangulate selected patches (wildcards supported)" + "Only triangulate selected patches (wildcards supported)" ); - Foam::argList::addOption + argList::addOption ( "outFile", "file", - "name of the file to save the simplified surface to" + "Name of the file to save the simplified surface to" ); #include "addProfilingOption.H" #include "addDictOption.H" diff --git a/applications/utilities/mesh/manipulation/checkMesh/checkMesh.C b/applications/utilities/mesh/manipulation/checkMesh/checkMesh.C index 27df739bfac8593d81e37f87d3e6073c19f65fac..df9e19dd24287ac6dcdbfd427b95dc7415548f03 100644 --- a/applications/utilities/mesh/manipulation/checkMesh/checkMesh.C +++ b/applications/utilities/mesh/manipulation/checkMesh/checkMesh.C @@ -86,39 +86,39 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "noTopology", - "skip checking the mesh topology" + "Skip checking the mesh topology" ); argList::addBoolOption ( "allGeometry", - "include bounding box checks" + "Include bounding box checks" ); argList::addBoolOption ( "allTopology", - "include extra topology checks" + "Include extra topology checks" ); argList::addBoolOption ( "writeAllFields", - "write volFields with mesh quality parameters" + "Write volFields with mesh quality parameters" ); argList::addOption ( "writeFields", "wordList", - "write volFields with selected mesh quality parameters" + "Write volFields with selected mesh quality parameters" ); argList::addBoolOption ( "meshQuality", - "read user-defined mesh quality criterions from system/meshQualityDict" + "Read user-defined mesh quality criterions from system/meshQualityDict" ); argList::addOption ( "writeSets", "surfaceFormat", - "reconstruct and write all faceSets and cellSets in selected format" + "Reconstruct and write all faceSets and cellSets in selected format" ); #include "setRootCase.H" diff --git a/applications/utilities/mesh/manipulation/createPatch/createPatch.C b/applications/utilities/mesh/manipulation/createPatch/createPatch.C index fe3e931612a3d825e5e177ca2402b04f958c05a5..4a0028ff5b678acf8e899baeca17030c64bc0f34 100644 --- a/applications/utilities/mesh/manipulation/createPatch/createPatch.C +++ b/applications/utilities/mesh/manipulation/createPatch/createPatch.C @@ -513,16 +513,16 @@ int main(int argc, char *argv[]) #include "addOverwriteOption.H" #include "addRegionOption.H" #include "addDictOption.H" - Foam::argList::addBoolOption + argList::addBoolOption ( "writeObj", - "write obj files showing the cyclic matching process" + "Write obj files showing the cyclic matching process" ); #include "setRootCase.H" #include "createTime.H" runTime.functionObjects().off(); - Foam::word meshRegionName = polyMesh::defaultRegion; + word meshRegionName = polyMesh::defaultRegion; args.readIfPresent("region", meshRegionName); const bool overwrite = args.found("overwrite"); diff --git a/applications/utilities/mesh/manipulation/mergeMeshes/mergeMeshes.C b/applications/utilities/mesh/manipulation/mergeMeshes/mergeMeshes.C index a6117cf5280a3964023c40ea32d6aae962477e61..40ee2c76c1e9b76f99d59929641b5e908abd81ee 100644 --- a/applications/utilities/mesh/manipulation/mergeMeshes/mergeMeshes.C +++ b/applications/utilities/mesh/manipulation/mergeMeshes/mergeMeshes.C @@ -64,7 +64,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "merge two meshes" + "Merge two meshes" ); #include "addOverwriteOption.H" @@ -74,7 +74,7 @@ int main(int argc, char *argv[]) ( "masterRegion", "name", - "specify alternative mesh region for the master mesh" + "Specify alternative mesh region for the master mesh" ); argList::addArgument("addCase"); @@ -82,13 +82,13 @@ int main(int argc, char *argv[]) ( "addRegion", "name", - "specify alternative mesh region for the additional mesh" + "Specify alternative mesh region for the additional mesh" ); argList::addOption ( "resultTime", "time", - "specify a time for the resulting mesh" + "Specify a time for the resulting mesh" ); argList args(argc, argv); diff --git a/applications/utilities/mesh/manipulation/mergeOrSplitBaffles/mergeOrSplitBaffles.C b/applications/utilities/mesh/manipulation/mergeOrSplitBaffles/mergeOrSplitBaffles.C index f7a9decc53caecbb0f99ec501c47710cea40a6cf..028b72a47b190bc0a541b0adaf757d06acf3717e 100644 --- a/applications/utilities/mesh/manipulation/mergeOrSplitBaffles/mergeOrSplitBaffles.C +++ b/applications/utilities/mesh/manipulation/mergeOrSplitBaffles/mergeOrSplitBaffles.C @@ -287,12 +287,12 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "detectOnly", - "find baffles only, but do not merge or split them" + "Find baffles only, but do not merge or split them" ); argList::addBoolOption ( "split", - "topologically split duplicate surfaces" + "Topologically split duplicate surfaces" ); #include "setRootCase.H" diff --git a/applications/utilities/mesh/manipulation/moveDynamicMesh/moveDynamicMesh.C b/applications/utilities/mesh/manipulation/moveDynamicMesh/moveDynamicMesh.C index aa5403a641565e613e94d2d3ff78282d7c1aec2f..b0a0cc890a31abbf6c023e75a500ddc62253510e 100644 --- a/applications/utilities/mesh/manipulation/moveDynamicMesh/moveDynamicMesh.C +++ b/applications/utilities/mesh/manipulation/moveDynamicMesh/moveDynamicMesh.C @@ -166,7 +166,7 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "checkAMI", - "check AMI weights" + "Check AMI weights" ); #include "setRootCase.H" diff --git a/applications/utilities/mesh/manipulation/polyDualMesh/polyDualMeshApp.C b/applications/utilities/mesh/manipulation/polyDualMesh/polyDualMeshApp.C index 1ce829e03b421170b84f4076bd04b189e5876808..5e28ada61ef76b7a97ead5d53dce0441d6706fb4 100644 --- a/applications/utilities/mesh/manipulation/polyDualMesh/polyDualMeshApp.C +++ b/applications/utilities/mesh/manipulation/polyDualMesh/polyDualMeshApp.C @@ -367,17 +367,17 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "splitAllFaces", - "have multiple faces inbetween cells" + "Have multiple faces inbetween cells" ); argList::addBoolOption ( "concaveMultiCells", - "split cells on concave boundary edges into multiple cells" + "Split cells on concave boundary edges into multiple cells" ); argList::addBoolOption ( "doNotPreserveFaceZones", - "disable the default behaviour of preserving faceZones by having" + "Disable the default behaviour of preserving faceZones by having" " multiple faces inbetween cells" ); diff --git a/applications/utilities/mesh/manipulation/refineMesh/refineMesh.C b/applications/utilities/mesh/manipulation/refineMesh/refineMesh.C index fd06321de17202b777035319b307bcfeb0e651ba..7d7ee1a7eb3bdba09e37e431ca411d9ff11c605d 100644 --- a/applications/utilities/mesh/manipulation/refineMesh/refineMesh.C +++ b/applications/utilities/mesh/manipulation/refineMesh/refineMesh.C @@ -157,14 +157,14 @@ int main(int argc, char *argv[]) { argList::addNote ( - "refine cells in multiple directions" + "Refine cells in multiple directions" ); #include "addOverwriteOption.H" #include "addRegionOption.H" #include "addDictOption.H" - Foam::argList::addBoolOption + argList::addBoolOption ( "all", "Refine all cells" diff --git a/applications/utilities/mesh/manipulation/renumberMesh/renumberMesh.C b/applications/utilities/mesh/manipulation/renumberMesh/renumberMesh.C index 46668812b610f702fe4cb1b29dfc0d208063b199..1e038f51cd362bd3f3a42106c66d3738099f9cce 100644 --- a/applications/utilities/mesh/manipulation/renumberMesh/renumberMesh.C +++ b/applications/utilities/mesh/manipulation/renumberMesh/renumberMesh.C @@ -621,7 +621,7 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "frontWidth", - "calculate the rms of the frontwidth" + "Calculate the rms of the frontwidth" ); diff --git a/applications/utilities/mesh/manipulation/setSet/setSet.C b/applications/utilities/mesh/manipulation/setSet/setSet.C index 8ee08159bee290130a006bebdc0734b01b21923e..7735602a13716f7bc5c662fc3bc25513672a6f6e 100644 --- a/applications/utilities/mesh/manipulation/setSet/setSet.C +++ b/applications/utilities/mesh/manipulation/setSet/setSet.C @@ -736,18 +736,18 @@ int main(int argc, char *argv[]) timeSelector::addOptions(true, false); #include "addRegionOption.H" - argList::addBoolOption("noVTK", "do not write VTK files"); - argList::addBoolOption("loop", "execute batch commands for all timesteps"); + argList::addBoolOption("noVTK", "Do not write VTK files"); + argList::addBoolOption("loop", "Execute batch commands for all timesteps"); argList::addOption ( "batch", "file", - "process in batch mode, using input from specified file" + "Process in batch mode, using input from specified file" ); argList::addBoolOption ( "noSync", - "do not synchronise selection across coupled patches" + "Do not synchronise selection across coupled patches" ); #include "setRootCase.H" diff --git a/applications/utilities/mesh/manipulation/setsToZones/setsToZones.C b/applications/utilities/mesh/manipulation/setsToZones/setsToZones.C index c3f44f961baa802e78c98f726943c6ec289c5d3e..ebf513b2d3512acd587ba535a8654bcdef9d3d1a 100644 --- a/applications/utilities/mesh/manipulation/setsToZones/setsToZones.C +++ b/applications/utilities/mesh/manipulation/setsToZones/setsToZones.C @@ -63,13 +63,13 @@ int main(int argc, char *argv[]) timeSelector::addOptions(true, false); argList::addNote ( - "add point/face/cell Zones from similar named point/face/cell Sets" + "Add point/face/cell Zones from similarly named point/face/cell Sets" ); argList::addBoolOption ( "noFlipMap", - "ignore orientation of faceSet" + "Ignore orientation of faceSet" ); #include "addRegionOption.H" diff --git a/applications/utilities/mesh/manipulation/splitMeshRegions/splitMeshRegions.C b/applications/utilities/mesh/manipulation/splitMeshRegions/splitMeshRegions.C index 7516435ab1af94b10235e45e6b254d11b6ecec4b..06da3f4850c5fb02424a549dcd6c3af024244785 100644 --- a/applications/utilities/mesh/manipulation/splitMeshRegions/splitMeshRegions.C +++ b/applications/utilities/mesh/manipulation/splitMeshRegions/splitMeshRegions.C @@ -1417,67 +1417,67 @@ int main(int argc, char *argv[]) { argList::addNote ( - "splits mesh into multiple regions (detected by walking across faces)" + "Split mesh into multiple regions (detected by walking across faces)" ); #include "addRegionOption.H" #include "addOverwriteOption.H" argList::addBoolOption ( "cellZones", - "additionally split cellZones off into separate regions" + "Additionally split cellZones off into separate regions" ); argList::addBoolOption ( "cellZonesOnly", - "use cellZones only to split mesh into regions; do not use walking" + "Use cellZones only to split mesh into regions; do not use walking" ); argList::addOption ( "cellZonesFileOnly", "file", - "like -cellZonesOnly, but use specified file" + "Like -cellZonesOnly, but use specified file" ); argList::addOption ( "blockedFaces", "faceSet", - "specify additional region boundaries that walking does not cross" + "Specify additional region boundaries that walking does not cross" ); argList::addBoolOption ( "makeCellZones", - "place cells into cellZones instead of splitting mesh" + "Place cells into cellZones instead of splitting mesh" ); argList::addBoolOption ( "largestOnly", - "only write largest region" + "Only write largest region" ); argList::addOption ( "insidePoint", "point", - "only write region containing point" + "Only write region containing point" ); argList::addBoolOption ( "detectOnly", - "do not write mesh" + "Do not write mesh" ); argList::addBoolOption ( "sloppyCellZones", - "try to match heuristically regions to existing cell zones" + "Try to match heuristically regions to existing cell zones" ); argList::addBoolOption ( "useFaceZones", - "use faceZones to patch inter-region faces instead of single patch" + "Use faceZones to patch inter-region faces instead of single patch" ); argList::addBoolOption ( "prefixRegion", - "prefix region name to all patches, not just coupling patches" + "Prefix region name to all patches, not just coupling patches" ); #include "setRootCase.H" diff --git a/applications/utilities/mesh/manipulation/stitchMesh/stitchMesh.C b/applications/utilities/mesh/manipulation/stitchMesh/stitchMesh.C index f834f3b283a75947196fa0dde3c982690db91c5d..201c97e768176aead9d6ba40bd53bf72241c002c 100644 --- a/applications/utilities/mesh/manipulation/stitchMesh/stitchMesh.C +++ b/applications/utilities/mesh/manipulation/stitchMesh/stitchMesh.C @@ -118,28 +118,28 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "integral", - "couple integral master/slave patches (2 argument mode: default)" + "Couple integral master/slave patches (2 argument mode: default)" ); argList::addBoolOption ( "partial", - "couple partially overlapping master/slave patches (2 argument mode)" + "Couple partially overlapping master/slave patches (2 argument mode)" ); argList::addBoolOption ( "perfect", - "couple perfectly aligned master/slave patches (2 argument mode)" + "Couple perfectly aligned master/slave patches (2 argument mode)" ); argList::addBoolOption ( "intermediate", - "write intermediate stages, not just the final result" + "Write intermediate stages, not just the final result" ); argList::addOption ( "toleranceDict", "file", - "dictionary file with tolerances" + "Dictionary file with tolerances" ); // The arguments are non-mandatory when using dictionary mode diff --git a/applications/utilities/mesh/manipulation/subsetMesh/subsetMesh.C b/applications/utilities/mesh/manipulation/subsetMesh/subsetMesh.C index ec87e0b02d8f5d8be09898ce60cbd4cc08be8218..2efe14e52fe58c14c10bbc8888572846972e89a4 100644 --- a/applications/utilities/mesh/manipulation/subsetMesh/subsetMesh.C +++ b/applications/utilities/mesh/manipulation/subsetMesh/subsetMesh.C @@ -340,7 +340,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "select a mesh subset based on a cellSet" + "Select a mesh subset based on a cellSet" ); #include "addOverwriteOption.H" @@ -350,21 +350,21 @@ int main(int argc, char *argv[]) ( "patch", "name", - "add exposed internal faces to specified patch instead of to " + "Add exposed internal faces to specified patch instead of to " "'oldInternalFaces'" ); argList::addOption ( "patches", "names", - "add exposed internal faces to nearest of specified patches" + "Add exposed internal faces to nearest of specified patches" " instead of to 'oldInternalFaces'" ); argList::addOption ( "resultTime", "time", - "specify a time for the resulting mesh" + "Specify a time for the resulting mesh" ); #include "setRootCase.H" #include "createTime.H" diff --git a/applications/utilities/mesh/manipulation/topoSet/topoSet.C b/applications/utilities/mesh/manipulation/topoSet/topoSet.C index 0ceb92b3efb4e6d3dfd28cc3d1091218fce4c7bb..225cd611d4aeae75c56ac1e48f71fcf667307e6e 100644 --- a/applications/utilities/mesh/manipulation/topoSet/topoSet.C +++ b/applications/utilities/mesh/manipulation/topoSet/topoSet.C @@ -210,7 +210,7 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "noSync", - "do not synchronise selection across coupled patches" + "Do not synchronise selection across coupled patches" ); #include "setRootCase.H" diff --git a/applications/utilities/miscellaneous/foamDictionary/foamDictionary.C b/applications/utilities/miscellaneous/foamDictionary/foamDictionary.C index 6169047e385fde7d21836143243e8f4ccbbd258d..dee2956e076d2cfbb4dbae5cbd5f72aacc5b02a3 100644 --- a/applications/utilities/miscellaneous/foamDictionary/foamDictionary.C +++ b/applications/utilities/miscellaneous/foamDictionary/foamDictionary.C @@ -261,13 +261,13 @@ void removeDict(dictionary& dict, const dictionary& dictToRemove) int main(int argc, char *argv[]) { - argList::addNote("manipulates dictionaries"); + argList::addNote("Manipulates dictionaries"); argList::noBanner(); argList::noJobInfo(); argList::addArgument("dictionary"); argList::addBoolOption("keywords", "List keywords"); - argList::addOption("entry", "name", "report/select the named entry"); + argList::addOption("entry", "name", "Report/select the named entry"); argList::addBoolOption ( "value", @@ -288,7 +288,7 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "remove", - "Remove the entry." + "Remove the entry" ); argList::addOption ( diff --git a/applications/utilities/miscellaneous/foamFormatConvert/foamFormatConvert.C b/applications/utilities/miscellaneous/foamFormatConvert/foamFormatConvert.C index e7c5f74ff6afa4c5208b788a08d524b3111032e1..e43bb0710cabadce96f7466df5db27388a568019 100644 --- a/applications/utilities/miscellaneous/foamFormatConvert/foamFormatConvert.C +++ b/applications/utilities/miscellaneous/foamFormatConvert/foamFormatConvert.C @@ -239,12 +239,12 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "noConstant", - "exclude the 'constant/' dir in the times list" + "Exclude the 'constant/' dir in the times list" ); argList::addBoolOption ( "enableFunctionEntries", - "enable expansion of dictionary directives - #include, #codeStream etc" + "Enable expansion of dictionary directives - #include, #codeStream etc" ); #include "addRegionOption.H" diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.C b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.C index 9e12c211779a01fd9e9a1d0b96e819a25962c052..c4d0bc13e1787647349970689e9a81a2c723b34b 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.C +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.C @@ -66,17 +66,17 @@ void Foam::helpTypes::helpBoundary::init() ( "field", "word", - "list available conditions for field" + "List available conditions for field" ); argList::addBoolOption ( "constraint", - "list constraint patches" + "List constraint patches" ); argList::addBoolOption ( "fixedValue", - "list fixed value patches (use with -field option)" + "List fixed value patches (use with -field option)" ); } diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpSolver/helpSolver.C b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpSolver/helpSolver.C index 0c045e872c6bc135d8f7e733653d178dd0e5b4d5..1da7406536e9c653e5ee3c3ffca0e0a063ff1a09 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpSolver/helpSolver.C +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpSolver/helpSolver.C @@ -66,7 +66,7 @@ void Foam::helpTypes::helpSolver::init() argList::addBoolOption ( "read", - "read solver type from the system/controlDict" + "Read solver type from the system/controlDict" ); } diff --git a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.C b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.C index a5b217e87ee3c13b3cf56fb6c6acdb99ed36b755..93c628dafbfc720f799b9657456cc56f98415f8f 100644 --- a/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.C +++ b/applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.C @@ -183,7 +183,7 @@ void Foam::helpType::init() ( "browse", "word", - "display documentation in browser" + "Display documentation in browser" ); } diff --git a/applications/utilities/miscellaneous/foamListTimes/foamListTimes.C b/applications/utilities/miscellaneous/foamListTimes/foamListTimes.C index 513ae9d41a8f35c0ac151ee7836858fa66670e04..c675fc0a4317d63a8a55e391f42c87b46e7e4c4d 100644 --- a/applications/utilities/miscellaneous/foamListTimes/foamListTimes.C +++ b/applications/utilities/miscellaneous/foamListTimes/foamListTimes.C @@ -68,17 +68,17 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "processor", - "list times from processor0/ directory" + "List times from processor0/ directory" ); argList::addBoolOption ( "rm", - "remove selected time directories" + "Remove selected time directories" ); argList::addBoolOption ( "verbose", - "report progress of -rm option" + "Report progress of -rm option" ); profiling::disable(); // Disable profiling (and its output) diff --git a/applications/utilities/parallelProcessing/decomposePar/decomposePar.C b/applications/utilities/parallelProcessing/decomposePar/decomposePar.C index ca235479e30af55c52ff5da011ae39783a374f35..21b2268efc0fba1eda618fd659d2d5d8c550e603 100644 --- a/applications/utilities/parallelProcessing/decomposePar/decomposePar.C +++ b/applications/utilities/parallelProcessing/decomposePar/decomposePar.C @@ -226,7 +226,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "decompose a mesh and fields of a case for parallel execution" + "Decompose a mesh and fields of a case for parallel execution" ); argList::noParallel(); @@ -234,13 +234,13 @@ int main(int argc, char *argv[]) ( "decomposeParDict", "file", - "read decomposePar dictionary from specified location" + "Use specified file for decomposePar dictionary" ); #include "addRegionOption.H" argList::addBoolOption ( "allRegions", - "operate on all regions in regionProperties" + "Operate on all regions in regionProperties" ); argList::addBoolOption ( @@ -262,32 +262,32 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "copyZero", - "Copy a 0 directory to processor* rather than decompose the fields" + "Copy 0/ directory to processor*/ rather than decompose the fields" ); argList::addBoolOption ( "copyUniform", - "copy any uniform/ directories too" + "Copy any uniform/ directories too" ); argList::addBoolOption ( "fields", - "use existing geometry decomposition and convert fields only" + "Use existing geometry decomposition and convert fields only" ); argList::addBoolOption ( "noSets", - "skip decomposing cellSets, faceSets, pointSets" + "Skip decomposing cellSets, faceSets, pointSets" ); argList::addBoolOption ( "force", - "remove existing processor*/ subdirs before decomposing the geometry" + "Remove existing processor*/ subdirs before decomposing the geometry" ); argList::addBoolOption ( "ifRequired", - "only decompose geometry if the number of domains has changed" + "Only decompose geometry if the number of domains has changed" ); // Include explicit constant options, have zero from time range diff --git a/applications/utilities/parallelProcessing/reconstructPar/reconstructPar.C b/applications/utilities/parallelProcessing/reconstructPar/reconstructPar.C index 7a5de58ed4b8172a52fcfc8bc64a6246054a0cf1..7645b9c91f9670c8fb19c06f3fc95d3a5544749a 100644 --- a/applications/utilities/parallelProcessing/reconstructPar/reconstructPar.C +++ b/applications/utilities/parallelProcessing/reconstructPar/reconstructPar.C @@ -90,42 +90,42 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "allRegions", - "operate on all regions in regionProperties" + "Operate on all regions in regionProperties" ); argList::addOption ( "fields", "list", - "specify a list of fields to be reconstructed. Eg, '(U T p)' - " + "Specify a list of fields to be reconstructed. Eg, '(U T p)' - " "regular expressions not currently supported" ); argList::addBoolOption ( "noFields", - "skip reconstructing fields" + "Skip reconstructing fields" ); argList::addOption ( "lagrangianFields", "list", - "specify a list of lagrangian fields to be reconstructed. Eg, '(U d)' -" + "Specify a list of lagrangian fields to be reconstructed. Eg, '(U d)' -" "regular expressions not currently supported, " "positions always included." ); argList::addBoolOption ( "noLagrangian", - "skip reconstructing lagrangian positions and fields" + "Skip reconstructing lagrangian positions and fields" ); argList::addBoolOption ( "noSets", - "skip reconstructing cellSets, faceSets, pointSets" + "Skip reconstructing cellSets, faceSets, pointSets" ); argList::addBoolOption ( "newTimes", - "only reconstruct new times (i.e. that do not exist already)" + "Only reconstruct new times (i.e. that do not exist already)" ); #include "setRootCase.H" diff --git a/applications/utilities/parallelProcessing/reconstructParMesh/reconstructParMesh.C b/applications/utilities/parallelProcessing/reconstructParMesh/reconstructParMesh.C index 6c0c7b96cf095625cee4319da0cd77f7d294cab0..5236940d408259643ee3aa008adae720611f2981 100644 --- a/applications/utilities/parallelProcessing/reconstructParMesh/reconstructParMesh.C +++ b/applications/utilities/parallelProcessing/reconstructParMesh/reconstructParMesh.C @@ -447,7 +447,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "reconstruct a mesh using geometric information only" + "Reconstruct a mesh using geometric information only" ); // Enable -constant ... if someone really wants it @@ -458,18 +458,17 @@ int main(int argc, char *argv[]) ( "mergeTol", "scalar", - "specify the merge distance relative to the bounding box size " - "(default 1e-7)" + "The merge distance relative to the bounding box size (default 1e-7)" ); argList::addBoolOption ( "fullMatch", - "do (slower) geometric matching on all boundary faces" + "Do (slower) geometric matching on all boundary faces" ); argList::addBoolOption ( "cellDist", - "write cell distribution as a labelList - for use with 'manual' " + "Write cell distribution as a labelList - for use with 'manual' " "decomposition method or as a volScalarField for post-processing." ); diff --git a/applications/utilities/parallelProcessing/redistributePar/redistributePar.C b/applications/utilities/parallelProcessing/redistributePar/redistributePar.C index c986ca413c831e6adfc9b49d458731814c08d7db..e012580bfd188eb4a224618721eba2f6bc5c8ab8 100644 --- a/applications/utilities/parallelProcessing/redistributePar/redistributePar.C +++ b/applications/utilities/parallelProcessing/redistributePar/redistributePar.C @@ -2255,25 +2255,24 @@ int main(int argc, char *argv[]) timeSelector::addOptions(true, true); #include "addRegionOption.H" #include "addOverwriteOption.H" - argList::addBoolOption("decompose", "decompose case"); - argList::addBoolOption("reconstruct", "reconstruct case"); + argList::addBoolOption("decompose", "Decompose case"); + argList::addBoolOption("reconstruct", "Reconstruct case"); argList::addOption ( "mergeTol", "scalar", - "specify the merge distance relative to the bounding box size " - "(default 1e-6)" + "The merge distance relative to the bounding box size (default 1e-6)" ); argList::addBoolOption ( "cellDist", - "write cell distribution as a labelList - for use with 'manual' " + "Write cell distribution as a labelList - for use with 'manual' " "decomposition method or as a volScalarField for post-processing." ); argList::addBoolOption ( "newTimes", - "only reconstruct new times (i.e. that do not exist already)" + "Only reconstruct new times (i.e. that do not exist already)" ); diff --git a/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C b/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C index 7c293bd815a11cf54da9ec40d70571d29f31dc78..4905d45646153a0bbc6bd1a175a4765df2281065 100644 --- a/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C +++ b/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C @@ -107,59 +107,59 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "ascii", - "write in ASCII format instead of 'C Binary'" + "Write in ASCII format instead of 'C Binary'" ); argList::addBoolOption ( "nodeValues", - "write values in nodes" + "Write values in nodes" ); argList::addBoolOption ( "noLagrangian", - "suppress writing lagrangian positions and fields" + "Suppress writing lagrangian positions and fields" ); argList::addBoolOption ( "noPatches", - "suppress writing any patches" + "Suppress writing any patches" ); argList::addOption ( "patches", "wordRes", - "specify particular patches to write - eg '(outlet \"inlet.*\")'. " + "Specify particular patches to write - eg '(outlet \"inlet.*\")'. " "An empty list suppresses writing the internalMesh." ); argList::addOption ( "faceZones", "wordRes", - "specify faceZones to write - eg '( slice \"mfp-.*\" )'." + "Specify faceZones to write - eg '( slice \"mfp-.*\" )'." ); argList::addOption ( "fields", "wordRes", - "specify fields to export (all by default) - eg '( \"U.*\" )'." + "Specify fields to export (all by default) - eg '( \"U.*\" )'." ); argList::addOption ( "cellZone", "word", - "specify cellZone to write" + "Specify cellZone to write" ); argList::addOption ( "name", "subdir", - "sub-directory name for ensight output (default: 'EnSight')" + "Sub-directory name for ensight output (default: 'EnSight')" ); argList::addOption ( "width", "n", - "width of ensight data subdir" + "Width of ensight data subdir" ); // The volume field types that we handle diff --git a/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C b/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C index f21a8dc5c72d9ebeecf836c4191a51e11a1a1c9a..13adf3b9fd62ed48b4e7ae7b4dd933e59e621b28 100644 --- a/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C +++ b/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C @@ -100,37 +100,37 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "ascii", - "write in ASCII format instead of 'C Binary'" + "Write in ASCII format instead of 'C Binary'" ); argList::addOption ( "index", "start", - "ignore the time index contained in the uniform/time file " + "Ignore the time index contained in the uniform/time file " "and use simple indexing when creating the files" ); argList::addBoolOption ( "noLagrangian", - "suppress writing lagrangian positions and fields" + "Suppress writing lagrangian positions and fields" ); argList::addBoolOption ( "noMesh", - "suppress writing the geometry. " + "Suppress writing the geometry. " "Can be useful for converting partial results for a static geometry" ); argList::addOption ( "name", "subdir", - "sub-directory name for ensight output (default: 'Ensight')" + "Sub-directory name for ensight output (default: 'Ensight')" ); argList::addOption ( "width", "n", - "width of Ensight data subdir" + "Width of Ensight data subdir" ); // The volume field types that we handle diff --git a/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C b/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C index ec00fff09bf999c297968427b3907da9af0e34d3..faf3c7301f98f2e16b6e84318f0642529bcfd96f 100644 --- a/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C +++ b/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C @@ -333,108 +333,108 @@ int main(int argc, char *argv[]) ( "fields", "wordList", - "only convert the specified fields - eg '(p T U)'" + "Only convert the specified fields - eg '(p T U)'" ); argList::addOption ( "cellSet", "name", - "convert a mesh subset corresponding to the specified cellSet" + "Convert a mesh subset corresponding to the specified cellSet" ); argList::addOption ( "cellZone", "name", - "convert a mesh subset corresponding to the specified cellZone" + "Convert a mesh subset corresponding to the specified cellZone" ); argList::addOption ( "faceSet", "name", - "restrict conversion to the specified faceSet" + "Restrict conversion to the specified faceSet" ); argList::addOption ( "pointSet", "name", - "restrict conversion to the specified pointSet" + "Restrict conversion to the specified pointSet" ); argList::addBoolOption ( "ascii", - "write in ASCII format instead of binary" + "Write in ASCII format instead of binary" ); argList::addBoolOption ( "xml", - "write VTK xml instead of legacy format" + "Write VTK xml instead of legacy format" ); argList::addBoolOption ( "poly", - "write polyhedral cells without tet/pyramid decomposition" + "Write polyhedral cells without tet/pyramid decomposition" ); argList::addBoolOption ( "surfaceFields", - "write surfaceScalarFields (e.g., phi)" + "Write surfaceScalarFields (e.g., phi)" ); argList::addBoolOption ( "finiteAreaFields", - "write finite area fields" + "Write finite area fields" ); argList::addBoolOption ( "nearCellValue", - "use cell value on patches instead of patch value itself" + "Use cell value on patches instead of patch value itself" ); argList::addBoolOption ( "noInternal", - "do not generate file for mesh, only for patches" + "Do not generate file for mesh, only for patches" ); argList::addBoolOption ( "noLagrangian", - "suppress writing lagrangian positions and fields" + "Suppress writing lagrangian positions and fields" ); argList::addBoolOption ( "noPointValues", - "no pointFields" + "No pointFields" ); argList::addBoolOption ( "allPatches", - "combine all patches into a single file" + "Combine all patches into a single file" ); argList::addOption ( "excludePatches", "wordRes", - "a list of patches to exclude - eg '( inlet \".*Wall\" )' " + "A list of patches to exclude - eg '( inlet \".*Wall\" )' " ); argList::addBoolOption ( "noFaceZones", - "no faceZones" + "No faceZones" ); argList::addBoolOption ( "noLinks", - "don't link processor VTK files - parallel only" + "Do not link processor VTK files - parallel only" ); argList::addBoolOption ( "useTimeName", - "use time name instead of the time index when naming files" + "Use time name instead of the time index when naming files" ); argList::addOption ( "name", "subdir", - "sub-directory name for VTK output (default: 'VTK')" + "Sub-directory name for VTK output (default: 'VTK')" ); #include "setRootCase.H" diff --git a/applications/utilities/postProcessing/lumped/lumpedPointForces/lumpedPointForces.C b/applications/utilities/postProcessing/lumped/lumpedPointForces/lumpedPointForces.C index ac36be2058ab3e504bd33f7aefbc6426928c1075..d65a20d8bfd12677737f6418bd41c1bd3749c2ce 100644 --- a/applications/utilities/postProcessing/lumped/lumpedPointForces/lumpedPointForces.C +++ b/applications/utilities/postProcessing/lumped/lumpedPointForces/lumpedPointForces.C @@ -88,7 +88,7 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "vtk", - "create visualization files of the forces" + "Create visualization files of the forces" ); timeSelector::addOptions(true, false); diff --git a/applications/utilities/postProcessing/lumped/lumpedPointMovement/lumpedPointMovement.C b/applications/utilities/postProcessing/lumped/lumpedPointMovement/lumpedPointMovement.C index ef91a760d58935604a5c60601a2724d2f20ee7b4..f15835477746b3e859f380e3aa2461cf8e850ffb 100644 --- a/applications/utilities/postProcessing/lumped/lumpedPointMovement/lumpedPointMovement.C +++ b/applications/utilities/postProcessing/lumped/lumpedPointMovement/lumpedPointMovement.C @@ -62,29 +62,29 @@ int main(int argc, char *argv[]) ( "max", "N", - "maximum number of outputs" + "Maximum number of outputs" ); argList::addOption ( "span", "N", - "increment each input by factor N (default: 1)" + "Increment each input by factor N (default: 1)" ); argList::addOption ( "scale", "factor", - "relaxation/scaling factor for movement (default: 1)" + "Relaxation/scaling factor for movement (default: 1)" ); argList::addBoolOption ( "removeLock", - "remove lock-file on termination of slave" + "Remove lock-file on termination of slave" ); argList::addBoolOption ( "slave", - "invoke as a slave responder for testing" + "Invoke as a slave responder for testing" ); argList::addArgument("responseFile"); diff --git a/applications/utilities/postProcessing/lumped/lumpedPointZones/lumpedPointZones.C b/applications/utilities/postProcessing/lumped/lumpedPointZones/lumpedPointZones.C index 765d1d028f5dc98c3e89252e296f5c4b01cb6035..32932576c685f42637dbc251a37ba236a0f8f268 100644 --- a/applications/utilities/postProcessing/lumped/lumpedPointZones/lumpedPointZones.C +++ b/applications/utilities/postProcessing/lumped/lumpedPointZones/lumpedPointZones.C @@ -55,7 +55,7 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "verbose", - "increased verbosity" + "Additional verbosity" ); #include "addRegionOption.H" diff --git a/applications/utilities/postProcessing/miscellaneous/temporalInterpolate/temporalInterpolate.C b/applications/utilities/postProcessing/miscellaneous/temporalInterpolate/temporalInterpolate.C index 78705ec520fe8eebacb4dbd15dbc8948f0b287ad..15d888742260ded2b5b94e46ba729a827f1eb02f 100644 --- a/applications/utilities/postProcessing/miscellaneous/temporalInterpolate/temporalInterpolate.C +++ b/applications/utilities/postProcessing/miscellaneous/temporalInterpolate/temporalInterpolate.C @@ -194,20 +194,20 @@ int main(int argc, char *argv[]) ( "fields", "wordRes", - "the fields (or field) to be interpolated." + "The fields (or field) to be interpolated." " Eg, '(U T p \"Y.*\")' or a single field 'U'" ); argList::addOption ( "divisions", "integer", - "specify number of temporal sub-divisions to create (default = 1)." + "Specify number of temporal sub-divisions to create (default = 1)." ); argList::addOption ( "interpolationType", "word", - "specify type of interpolation (linear or spline)" + "The type of interpolation (linear or spline)" ); #include "setRootCase.H" diff --git a/applications/utilities/preProcessing/applyBoundaryLayer/applyBoundaryLayer.C b/applications/utilities/preProcessing/applyBoundaryLayer/applyBoundaryLayer.C index 6360dcef272cccee5a4a40af143c1dbeb200136d..ffde5b2b38e8a3f9c7d7a7dee8e89b414931453b 100644 --- a/applications/utilities/preProcessing/applyBoundaryLayer/applyBoundaryLayer.C +++ b/applications/utilities/preProcessing/applyBoundaryLayer/applyBoundaryLayer.C @@ -273,7 +273,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "apply a simplified boundary-layer model to the velocity and\n" + "Apply a simplified boundary-layer model to the velocity and\n" "turbulence fields based on the 1/7th power-law." ); @@ -283,13 +283,13 @@ int main(int argc, char *argv[]) ( "ybl", "scalar", - "specify the boundary-layer thickness" + "Specify the boundary-layer thickness" ); argList::addOption ( "Cbl", "scalar", - "boundary-layer thickness as Cbl * mean distance to wall" + "Boundary-layer thickness as Cbl * mean distance to wall" ); argList::addBoolOption ( diff --git a/applications/utilities/preProcessing/changeDictionary/changeDictionary.C b/applications/utilities/preProcessing/changeDictionary/changeDictionary.C index 1ec0ff1528fec13df55f5a84f6c5dcc740a9c72e..8a39925f4fb0b32c7c15bfa0e318a2686e13077c 100644 --- a/applications/utilities/preProcessing/changeDictionary/changeDictionary.C +++ b/applications/utilities/preProcessing/changeDictionary/changeDictionary.C @@ -399,13 +399,13 @@ int main(int argc, char *argv[]) ( "subDict", "name", - "specify the subDict name of the replacements dictionary" + "Specify the subDict name of the replacements dictionary" ); argList::addOption ( "instance", "name", - "override instance setting (default is the time name)" + "Override instance setting (default is the time name)" ); // Add explicit time option @@ -414,17 +414,17 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "literalRE", - "treat regular expressions literally (i.e., as a keyword)" + "Treat regular expressions literally (i.e., as a keyword)" ); argList::addBoolOption ( "enableFunctionEntries", - "enable expansion of dictionary directives - #include, #codeStream etc" + "Enable expansion of dictionary directives - #include, #codeStream etc" ); argList::addBoolOption ( "disablePatchGroups", - "disable matching keys to patch groups" + "Disable matching keys to patch groups" ); #include "addRegionOption.H" diff --git a/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/addRegionsOption.H b/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/addRegionsOption.H index 9f57e35a40ab441841bdb3dddbd5e2a74dc7bd52..8bafcf5c395cc50d7a4cbea3f49ae8383412609d 100644 --- a/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/addRegionsOption.H +++ b/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/addRegionsOption.H @@ -6,5 +6,5 @@ ( "regions", "(name1 .. nameN)", - "specify alternative mesh regions" + "Specify alternative mesh regions" ); diff --git a/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C b/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C index 13cba2af44cb96bacde7dee03af4e9bbb84d5a05..08c611d7bcb81dd4572c99d4585062abc17a001f 100644 --- a/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C +++ b/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C @@ -75,7 +75,7 @@ int main(int argc, char *argv[]) ( "commsDir", "dir", - "specify alternate communications directory. default is 'comms'" + "Specify alternate communications directory (default is 'comms')" ); #include "setRootCase.H" #include "createTime.H" diff --git a/applications/utilities/preProcessing/createZeroDirectory/createZeroDirectory.C b/applications/utilities/preProcessing/createZeroDirectory/createZeroDirectory.C index ebe09b2219466b8e352bd2c56c1098cb33f077b4..f17ebb902e8867fe7ed756dfbef6ea39aa0f01db 100644 --- a/applications/utilities/preProcessing/createZeroDirectory/createZeroDirectory.C +++ b/applications/utilities/preProcessing/createZeroDirectory/createZeroDirectory.C @@ -208,11 +208,11 @@ void createFieldFiles // Main program: int main(int argc, char *argv[]) { - Foam::argList::addOption + argList::addOption ( "templateDir", "file", - "read case set-up templates from specified location" + "Read case set-up templates from specified location" ); #include "setRootCase.H" diff --git a/applications/utilities/preProcessing/foamUpgradeCyclics/foamUpgradeCyclics.C b/applications/utilities/preProcessing/foamUpgradeCyclics/foamUpgradeCyclics.C index 08a31d88de0bf53cd81d749a7ba8c430bd5baa5d..7bd8e9d1d3461216ee25b04eca412c8a6e8d48a8 100644 --- a/applications/utilities/preProcessing/foamUpgradeCyclics/foamUpgradeCyclics.C +++ b/applications/utilities/preProcessing/foamUpgradeCyclics/foamUpgradeCyclics.C @@ -399,12 +399,12 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "dry-run", - "test only do not change any files" + "Test only do not change any files" ); argList::addBoolOption ( "enableFunctionEntries", - "enable expansion of dictionary directives - #include, #codeStream etc" + "Enable expansion of dictionary directives - #include, #codeStream etc" ); #include "addRegionOption.H" diff --git a/applications/utilities/preProcessing/mapFields/mapFields.C b/applications/utilities/preProcessing/mapFields/mapFields.C index e359381f15e2aa7f440c02bc35e6a233be93fd7d..6a7d887347c50775fe94557048966e855ecbaa33 100644 --- a/applications/utilities/preProcessing/mapFields/mapFields.C +++ b/applications/utilities/preProcessing/mapFields/mapFields.C @@ -217,7 +217,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "map volume fields from one mesh to another" + "Map volume fields from one mesh to another" ); argList::noParallel(); argList::addArgument("sourceCase"); @@ -226,57 +226,57 @@ int main(int argc, char *argv[]) ( "sourceTime", "scalar|'latestTime'", - "specify the source time" + "Specify the source time" ); argList::addOption ( "sourceRegion", "word", - "specify the source region" + "Specify the source region" ); argList::addOption ( "targetRegion", "word", - "specify the target region" + "Specify the target region" ); argList::addBoolOption ( "parallelSource", - "the source is decomposed" + "The source is decomposed" ); argList::addBoolOption ( "parallelTarget", - "the target is decomposed" + "The target is decomposed" ); argList::addBoolOption ( "consistent", - "source and target geometry and boundary conditions identical" + "Source and target geometry and boundary conditions identical" ); argList::addOption ( "mapMethod", "word", - "specify the mapping method" + "Specify the mapping method" ); argList::addBoolOption ( "subtract", - "subtract mapped source from target" + "Subtract mapped source from target" ); argList::addOption ( "sourceDecomposeParDict", "file", - "read decomposePar dictionary from specified location" + "Read decomposePar dictionary from specified location" ); argList::addOption ( "targetDecomposeParDict", "file", - "read decomposePar dictionary from specified location" + "Read decomposePar dictionary from specified location" ); diff --git a/applications/utilities/preProcessing/mapFieldsPar/mapFieldsPar.C b/applications/utilities/preProcessing/mapFieldsPar/mapFieldsPar.C index 194b08242c70a2379cc0f673d5690f041504c192..0d30bacc7827bfaf2cedc413ba5851ec778b829a 100644 --- a/applications/utilities/preProcessing/mapFieldsPar/mapFieldsPar.C +++ b/applications/utilities/preProcessing/mapFieldsPar/mapFieldsPar.C @@ -140,7 +140,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "map volume fields from one mesh to another" + "Map volume fields from one mesh to another" ); argList::addArgument("sourceCase"); @@ -149,60 +149,60 @@ int main(int argc, char *argv[]) ( "sourceTime", "scalar|'latestTime'", - "specify the source time" + "Specify the source time" ); argList::addOption ( "sourceRegion", "word", - "specify the source region" + "Specify the source region" ); argList::addOption ( "targetRegion", "word", - "specify the target region" + "Specify the target region" ); argList::addBoolOption ( "consistent", - "source and target geometry and boundary conditions identical" + "Source and target geometry and boundary conditions identical" ); argList::addOption ( "mapMethod", "word", - "specify the mapping method " + "Specify the mapping method " "(direct|mapNearest|cellVolumeWeight|correctedCellVolumeWeight)" ); argList::addOption ( "patchMapMethod", "word", - "specify the patch mapping method (direct|mapNearest|faceAreaWeight)" + "Specify the patch mapping method (direct|mapNearest|faceAreaWeight)" ); argList::addOption ( "procMapMethod", "word", - "specify the processor distribution map method (AABB|LOD)" + "Specify the processor distribution map method (AABB|LOD)" ); argList::addBoolOption ( "subtract", - "subtract mapped source from target" + "Subtract mapped source from target" ); argList::addOption ( "fields", "list", - "specify a list of fields to be mapped. Eg, '(U T p)' - " + "Specify a list of fields to be mapped. Eg, '(U T p)' - " "regular expressions not currently supported" ); argList::addBoolOption ( "noLagrangian", - "skip mapping lagrangian positions and fields" + "Skip mapping lagrangian positions and fields" ); argList args(argc, argv); diff --git a/applications/utilities/surface/surfaceAdd/surfaceAdd.C b/applications/utilities/surface/surfaceAdd/surfaceAdd.C index f3bd2b956c1a44ce68900eea912ff2d8a45f3300..48bb9abcfe2eb8708be781318316da3b5942054f 100644 --- a/applications/utilities/surface/surfaceAdd/surfaceAdd.C +++ b/applications/utilities/surface/surfaceAdd/surfaceAdd.C @@ -51,7 +51,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "add two surfaces via a geometric merge on points." + "Add two surfaces via a geometric merge on points." ); argList::noParallel(); @@ -63,18 +63,18 @@ int main(int argc, char *argv[]) ( "points", "file", - "provide additional points" + "Provide additional points" ); argList::addBoolOption ( "mergeRegions", - "combine regions from both surfaces" + "Combine regions from both surfaces" ); argList::addOption ( "scale", "factor", - "geometry scaling factor on input surfaces" + "Geometry scaling factor on input surfaces" ); argList args(argc, argv); diff --git a/applications/utilities/surface/surfaceBooleanFeatures/surfaceBooleanFeatures.C b/applications/utilities/surface/surfaceBooleanFeatures/surfaceBooleanFeatures.C index 4449929a20c8112bf88931f39566db6dc54d0834..e36e54a249cf7cea50edc84e6a1ee463c73a48df 100644 --- a/applications/utilities/surface/surfaceBooleanFeatures/surfaceBooleanFeatures.C +++ b/applications/utilities/surface/surfaceBooleanFeatures/surfaceBooleanFeatures.C @@ -1541,7 +1541,7 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "invertedSpace", - "do the surfaces have inverted space orientation, " + "Do the surfaces have inverted space orientation, " "i.e. a point at infinity is considered inside. " "This is only sensible for union and intersection." ); diff --git a/applications/utilities/surface/surfaceCheck/surfaceCheck.C b/applications/utilities/surface/surfaceCheck/surfaceCheck.C index ec0125bd96c4e138e44e13cbb69be84ea5057cd1..71993246e83c7f642f8da454e6fbe5115891a223 100644 --- a/applications/utilities/surface/surfaceCheck/surfaceCheck.C +++ b/applications/utilities/surface/surfaceCheck/surfaceCheck.C @@ -322,36 +322,36 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "checkSelfIntersection", - "also check for self-intersection" + "Also check for self-intersection" ); argList::addBoolOption ( "splitNonManifold", - "split surface along non-manifold edges" - " (default split is fully disconnected)" + "Split surface along non-manifold edges " + "(default split is fully disconnected)" ); argList::addBoolOption ( "verbose", - "verbose operation" + "Additional verbosity" ); argList::addBoolOption ( "blockMesh", - "write vertices/blocks for blockMeshDict" + "Write vertices/blocks for blockMeshDict" ); argList::addOption ( "outputThreshold", "number", - "upper limit on the number of files written." - " Default is 10, using 0 suppresses file writing." + "Upper limit on the number of files written. " + "Default is 10, using 0 suppresses file writing." ); argList::addOption ( "writeSets", "surfaceFormat", - "reconstruct and write problem triangles/edges in selected format" + "Reconstruct and write problem triangles/edges in selected format" ); diff --git a/applications/utilities/surface/surfaceCoarsen/surfaceCoarsen.C b/applications/utilities/surface/surfaceCoarsen/surfaceCoarsen.C index 2ac97d8791ebd5c4e4321588668065e0ae609387..4d180bcc2eecf5ac4dfb07077fcc3c75b39f8444 100644 --- a/applications/utilities/surface/surfaceCoarsen/surfaceCoarsen.C +++ b/applications/utilities/surface/surfaceCoarsen/surfaceCoarsen.C @@ -79,7 +79,7 @@ int main(int argc, char *argv[]) ( "scale", "factor", - "input geometry scaling factor" + "Input geometry scaling factor" ); argList args(argc, argv); diff --git a/applications/utilities/surface/surfaceConvert/surfaceConvert.C b/applications/utilities/surface/surfaceConvert/surfaceConvert.C index a56a7ac507803a3849405df1838e12b45572ea21..a9f6a4c6b958795d91a25188236f4a7faaa38b28 100644 --- a/applications/utilities/surface/surfaceConvert/surfaceConvert.C +++ b/applications/utilities/surface/surfaceConvert/surfaceConvert.C @@ -64,7 +64,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "convert between surface formats, using triSurface library components" + "Convert between surface formats, using triSurface library components" ); argList::noParallel(); @@ -98,12 +98,11 @@ int main(int argc, char *argv[]) if (args.found("writePrecision")) { - const label writePrecision = args.opt<label>("writePrecision"); + const label prec = args.opt<label>("writePrecision"); + Info<< "Output write precision set to " << prec << endl; - IOstream::defaultPrecision(writePrecision); - Sout.precision(writePrecision); - - Info<< "Output write precision set to " << writePrecision << endl; + IOstream::defaultPrecision(prec); + Sout.precision(prec); } const fileName importName = args[1]; diff --git a/applications/utilities/surface/surfaceFeatureConvert/surfaceFeatureConvert.C b/applications/utilities/surface/surfaceFeatureConvert/surfaceFeatureConvert.C index b2665694dcbdfdda04a99bd2de267a026a490463..66ed0564bd0184dbddeb91a53added81cbd13abe 100644 --- a/applications/utilities/surface/surfaceFeatureConvert/surfaceFeatureConvert.C +++ b/applications/utilities/surface/surfaceFeatureConvert/surfaceFeatureConvert.C @@ -55,7 +55,7 @@ int main(int argc, char *argv[]) ( "scale", "factor", - "geometry scaling factor - default is 1" + "Geometry scaling factor - default is 1" ); argList args(argc, argv); diff --git a/applications/utilities/surface/surfaceFeatureExtract/surfaceFeatureExtract.C b/applications/utilities/surface/surfaceFeatureExtract/surfaceFeatureExtract.C index 1ec795a2313f78b31fe401a73ba62428424119e0..6d097114cc505546a38e797f10d1a8b9fabce4e4 100644 --- a/applications/utilities/surface/surfaceFeatureExtract/surfaceFeatureExtract.C +++ b/applications/utilities/surface/surfaceFeatureExtract/surfaceFeatureExtract.C @@ -216,7 +216,7 @@ int main(int argc, char *argv[]) ( "dict", "file", - "read surfaceFeatureExtractDict from specified location" + "Read surfaceFeatureExtractDict from specified location" ); #include "setRootCase.H" diff --git a/applications/utilities/surface/surfaceHookUp/surfaceHookUp.C b/applications/utilities/surface/surfaceHookUp/surfaceHookUp.C index a45bb8ffa35607338e697e24c489a1a7c4c2db27..736352f5ecf2a968c1bdc287e99fed425cd19a12 100644 --- a/applications/utilities/surface/surfaceHookUp/surfaceHookUp.C +++ b/applications/utilities/surface/surfaceHookUp/surfaceHookUp.C @@ -271,7 +271,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "hook surfaces to other surfaces by moving and retriangulating their" + "Hook surfaces to other surfaces by moving and retriangulating their" "boundary edges to match other surface boundary edges" ); argList::noParallel(); diff --git a/applications/utilities/surface/surfaceInertia/surfaceInertia.C b/applications/utilities/surface/surfaceInertia/surfaceInertia.C index b46dd4f9e6513573a5f6b057caf8f0f268e361f4..ad9f659b8235d3f871b8605db023570ea292f7b2 100644 --- a/applications/utilities/surface/surfaceInertia/surfaceInertia.C +++ b/applications/utilities/surface/surfaceInertia/surfaceInertia.C @@ -64,7 +64,7 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "shellProperties", - "inertia of a thin shell" + "Inertia of a thin shell" ); argList::addOption diff --git a/applications/utilities/surface/surfaceInflate/surfaceInflate.C b/applications/utilities/surface/surfaceInflate/surfaceInflate.C index f945a65fadc77d05e36c981bb6206ae01eefe255..c226a592ceaa95b46537c0cc650c15a804338553 100644 --- a/applications/utilities/surface/surfaceInflate/surfaceInflate.C +++ b/applications/utilities/surface/surfaceInflate/surfaceInflate.C @@ -571,30 +571,30 @@ int main(int argc, char *argv[]) argList::noParallel(); argList::addNote ( - "Creates inflated version of surface using point normals." - " Takes surface, distance to inflate and additional safety factor" + "Creates inflated version of surface using point normals. " + "Takes surface, distance to inflate and additional safety factor" ); argList::addBoolOption ( "checkSelfIntersection", - "also check for self-intersection" + "Also check for self-intersection" ); argList::addOption ( "nSmooth", "integer", - "number of smoothing iterations (default 20)" + "Number of smoothing iterations (default 20)" ); argList::addOption ( "featureAngle", "scalar", - "feature angle" + "Feature angle" ); argList::addBoolOption ( "debug", - "switch on additional debug information" + "Switch on additional debug information" ); argList::addArgument("inputFile"); diff --git a/applications/utilities/surface/surfaceLambdaMuSmooth/surfaceLambdaMuSmooth.C b/applications/utilities/surface/surfaceLambdaMuSmooth/surfaceLambdaMuSmooth.C index ef6e5c33466f91335301ea155f0e0a3edd17b445..caab9dc86fba4145a7f276cd8901e249d8554ec9 100644 --- a/applications/utilities/surface/surfaceLambdaMuSmooth/surfaceLambdaMuSmooth.C +++ b/applications/utilities/surface/surfaceLambdaMuSmooth/surfaceLambdaMuSmooth.C @@ -141,7 +141,7 @@ int main(int argc, char *argv[]) argList::addOption ( "featureFile", - "fix points from a file containing feature points and edges" + "Fix points from a file containing feature points and edges" ); argList args(argc, argv); diff --git a/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C b/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C index 7fe05e83187f1d9447f2474dfbd7b3ef1eaa9b1d..7fa8af95e71ca1f85aae26072fd4442c17021f5a 100644 --- a/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C +++ b/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C @@ -85,37 +85,39 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "clean", - "perform some surface checking/cleanup on the input surface" + "Perform some surface checking/cleanup on the input surface" ); argList::addOption ( "scaleIn", "factor", - "geometry scaling factor on input" + "Geometry scaling factor on input" ); argList::addOption ( "scaleOut", "factor", - "geometry scaling factor on output" + "Geometry scaling factor on output" ); #include "addDictOption.H" argList::addOption ( "from", "system", - "specify the source coordinate system, applied after '-scaleIn'" + "Specify the source coordinate system, applied after '-scaleIn'", + true // advanced ); argList::addOption ( "to", "system", - "specify the target coordinate system, applied before '-scaleOut'" + "Specify the target coordinate system, applied before '-scaleOut'", + true // advanced ); argList::addBoolOption ( "tri", - "triangulate surface" + "Triangulate surface" ); diff --git a/applications/utilities/surface/surfaceMeshExport/surfaceMeshExport.C b/applications/utilities/surface/surfaceMeshExport/surfaceMeshExport.C index 127b6e75f234a132c5251367bd9d12fd0a25ffa6..ffb717dfec094f6b2427670dc8dc03f1d62e0b27 100644 --- a/applications/utilities/surface/surfaceMeshExport/surfaceMeshExport.C +++ b/applications/utilities/surface/surfaceMeshExport/surfaceMeshExport.C @@ -76,7 +76,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "export from surfMesh to various third-party surface formats" + "Export from surfMesh to various third-party surface formats" ); argList::noParallel(); @@ -85,39 +85,41 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "clean", - "perform some surface checking/cleanup on the input surface" + "Perform some surface checking/cleanup on the input surface" ); argList::addOption ( "name", "name", - "specify an alternative surface name when reading - " + "Specify an alternative surface name when reading - " "default is 'default'" ); argList::addOption ( "scaleIn", "factor", - "geometry scaling factor on input - default is 1" + "Geometry scaling factor on input - default is 1" ); argList::addOption ( "scaleOut", "factor", - "geometry scaling factor on output - default is 1" + "Geometry scaling factor on output - default is 1" ); #include "addDictOption.H" argList::addOption ( "from", "coordinateSystem", - "specify the source coordinate system, applied after '-scaleIn'" + "Specify the source coordinate system, applied after '-scaleIn'", + true // advanced ); argList::addOption ( "to", "coordinateSystem", - "specify the target coordinate system, applied before '-scaleOut'" + "Specify the target coordinate system, applied before '-scaleOut'", + true // advanced ); argList args(argc, argv); diff --git a/applications/utilities/surface/surfaceMeshImport/surfaceMeshImport.C b/applications/utilities/surface/surfaceMeshImport/surfaceMeshImport.C index 69637b46e5be49ec12a8b00f41dac7a2be4d3b6b..453a04b1f3f8dedd7ed02d558ae8e8b1f4445bac 100644 --- a/applications/utilities/surface/surfaceMeshImport/surfaceMeshImport.C +++ b/applications/utilities/surface/surfaceMeshImport/surfaceMeshImport.C @@ -76,7 +76,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "import from various third-party surface formats into surfMesh" + "Import from various third-party surface formats into surfMesh" ); argList::noParallel(); @@ -85,39 +85,41 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "clean", - "perform some surface checking/cleanup on the input surface" + "Perform some surface checking/cleanup on the input surface" ); argList::addOption ( "name", "name", - "specify an alternative surface name when writing - " + "Specify an alternative surface name when writing - " "default is 'default'" ); argList::addOption ( "scaleIn", "factor", - "geometry scaling factor on input - default is 1" + "Geometry scaling factor on input - default is 1" ); argList::addOption ( "scaleOut", "factor", - "geometry scaling factor on output - default is 1" + "Geometry scaling factor on output - default is 1" ); #include "addDictOption.H" argList::addOption ( "from", "coordinateSystem", - "specify a local coordinate system when reading files." + "Specify a local coordinate system when reading files.", + true // advanced ); argList::addOption ( "to", "coordinateSystem", - "specify a local coordinate system when writing files." + "Specify a local coordinate system when writing files.", + true // advanced ); #include "setRootCase.H" diff --git a/applications/utilities/surface/surfaceMeshInfo/surfaceMeshInfo.C b/applications/utilities/surface/surfaceMeshInfo/surfaceMeshInfo.C index f800109ec0bb55e95e674d73b5ab3de61584a81d..6d6d0fc8d186b5a4ee1e362660e0356267163f97 100644 --- a/applications/utilities/surface/surfaceMeshInfo/surfaceMeshInfo.C +++ b/applications/utilities/surface/surfaceMeshInfo/surfaceMeshInfo.C @@ -76,7 +76,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "information about surface meshes" + "Information about surface meshes" ); argList::noBanner(); @@ -87,17 +87,17 @@ int main(int argc, char *argv[]) ( "scale", "factor", - "input geometry scaling factor" + "Input geometry scaling factor" ); argList::addBoolOption ( "areas", - "display area of each face" + "Display area of each face" ); argList::addBoolOption ( "xml", - "write output in XML format" + "Write output in XML format" ); profiling::disable(); // Disable profiling (and its output) diff --git a/applications/utilities/surface/surfaceMeshTriangulate/surfaceMeshTriangulate.C b/applications/utilities/surface/surfaceMeshTriangulate/surfaceMeshTriangulate.C index 936a90a2dfeb2613e898024d71fb8b7e28e5a7a9..6e8c7041730021497a2ae457162bf143d74d3adf 100644 --- a/applications/utilities/surface/surfaceMeshTriangulate/surfaceMeshTriangulate.C +++ b/applications/utilities/surface/surfaceMeshTriangulate/surfaceMeshTriangulate.C @@ -62,7 +62,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "extract surface from a polyMesh" + "Extract surface from a polyMesh" ); timeSelector::addOptions(); @@ -71,19 +71,19 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "excludeProcPatches", - "exclude processor patches" + "Exclude processor patches" ); argList::addOption ( "patches", "(patch0 .. patchN)", - "only triangulate selected patches (wildcards supported)" + "Only triangulate selected patches (wildcards supported)" ); argList::addOption ( "faceZones", "(fz0 .. fzN)", - "triangulate selected faceZones (wildcards supported)" + "Triangulate selected faceZones (wildcards supported)" ); #include "setRootCase.H" diff --git a/applications/utilities/surface/surfaceOrient/surfaceOrient.C b/applications/utilities/surface/surfaceOrient/surfaceOrient.C index 8253f4d234ecfd73d295487099d988a71d2ea8a0..f15993785893a7e8695e355d17095d292bb66f93 100644 --- a/applications/utilities/surface/surfaceOrient/surfaceOrient.C +++ b/applications/utilities/surface/surfaceOrient/surfaceOrient.C @@ -46,7 +46,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "set face normals consistent with a user-provided 'outside' point" + "Set face normals consistent with a user-provided 'outside' point" ); argList::noParallel(); @@ -56,18 +56,18 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "inside", - "treat provided point as being inside" + "Treat provided point as being inside" ); argList::addBoolOption ( "usePierceTest", - "determine orientation by counting number of intersections" + "Determine orientation by counting number of intersections" ); argList::addOption ( "scale", "factor", - "input geometry scaling factor" + "Input geometry scaling factor" ); argList args(argc, argv); diff --git a/applications/utilities/surface/surfacePointMerge/surfacePointMerge.C b/applications/utilities/surface/surfacePointMerge/surfacePointMerge.C index b1e69bc0a15d03709f0ed437d1a249edce3e4dea..641445475691e1738efb6eccd0b37af31188e47b 100644 --- a/applications/utilities/surface/surfacePointMerge/surfacePointMerge.C +++ b/applications/utilities/surface/surfacePointMerge/surfacePointMerge.C @@ -59,7 +59,7 @@ int main(int argc, char *argv[]) ( "scale", "factor", - "input geometry scaling factor" + "Input geometry scaling factor" ); argList args(argc, argv); diff --git a/applications/utilities/surface/surfaceRedistributePar/surfaceRedistributePar.C b/applications/utilities/surface/surfaceRedistributePar/surfaceRedistributePar.C index e52fe2aab7f8b6d20092e0c2dc910f5ec0139b3e..b24db921fbd12f2b555a57aab31f28549cc12743 100644 --- a/applications/utilities/surface/surfaceRedistributePar/surfaceRedistributePar.C +++ b/applications/utilities/surface/surfaceRedistributePar/surfaceRedistributePar.C @@ -114,7 +114,7 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "keepNonMapped", - "preserve surface outside of mesh bounds" + "Preserve surface outside of mesh bounds" ); #include "setRootCase.H" diff --git a/applications/utilities/surface/surfaceSplitByPatch/surfaceSplitByPatch.C b/applications/utilities/surface/surfaceSplitByPatch/surfaceSplitByPatch.C index f1035532da0ef44d25d3137eb556cbd04992ad70..ca8612626341020f530c1a8d9fe16c9a59ae38e7 100644 --- a/applications/utilities/surface/surfaceSplitByPatch/surfaceSplitByPatch.C +++ b/applications/utilities/surface/surfaceSplitByPatch/surfaceSplitByPatch.C @@ -43,7 +43,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "write surface mesh regions to separate files" + "Write surface mesh regions to separate files" ); argList::noParallel(); diff --git a/applications/utilities/surface/surfaceSplitNonManifolds/surfaceSplitNonManifolds.C b/applications/utilities/surface/surfaceSplitNonManifolds/surfaceSplitNonManifolds.C index b799f65629606a40e1c0972e65bbd8152ec7f313..f46781c39e646f2eb8ad5b5ed6069dcf5c117e7e 100644 --- a/applications/utilities/surface/surfaceSplitNonManifolds/surfaceSplitNonManifolds.C +++ b/applications/utilities/surface/surfaceSplitNonManifolds/surfaceSplitNonManifolds.C @@ -672,7 +672,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "split multiply connected surface edges by duplicating points" + "Split multiply connected surface edges by duplicating points" ); argList::noParallel(); argList::addArgument("surfaceFile"); @@ -680,7 +680,7 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "debug", - "add debugging output" + "Add debugging output" ); argList args(argc, argv); diff --git a/applications/utilities/surface/surfaceToPatch/surfaceToPatch.C b/applications/utilities/surface/surfaceToPatch/surfaceToPatch.C index 2150671ca98ad693bdfc6023adf4e279424f58ea..fb9ca82c0199754a1d657ad3e039aacb8b4eb3bb 100644 --- a/applications/utilities/surface/surfaceToPatch/surfaceToPatch.C +++ b/applications/utilities/surface/surfaceToPatch/surfaceToPatch.C @@ -171,7 +171,7 @@ int main(int argc, char *argv[]) { argList::addNote ( - "reads surface and applies surface regioning to a mesh" + "Reads surface and applies surface regioning to a mesh" ); argList::noParallel(); @@ -180,13 +180,13 @@ int main(int argc, char *argv[]) ( "faceSet", "name", - "only repatch the faces in specified faceSet" + "Only repatch the faces in specified faceSet" ); argList::addOption ( "tol", "scalar", - "search tolerance as fraction of mesh size (default 1e-3)" + "Search tolerance as fraction of mesh size (default 1e-3)" ); #include "setRootCase.H" diff --git a/applications/utilities/thermophysical/chemkinToFoam/chemkinToFoam.C b/applications/utilities/thermophysical/chemkinToFoam/chemkinToFoam.C index c60026ed1a244ed882aeeca2bb691bd4307eef42..bb73c7273d1793d3a713754eab40dc7def313cd2 100644 --- a/applications/utilities/thermophysical/chemkinToFoam/chemkinToFoam.C +++ b/applications/utilities/thermophysical/chemkinToFoam/chemkinToFoam.C @@ -63,7 +63,7 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "newFormat", - "read Chemkin thermo file in new format" + "Read Chemkin thermo file in new format" ); argList args(argc, argv); diff --git a/etc/config.sh/completion_cache b/etc/config.sh/completion_cache index b0dd6e8562265b39609e8d42c6c2db0176872df7..3497798e94fcb6b9225f60bdb6108f8f42e7cb5a 100644 --- a/etc/config.sh/completion_cache +++ b/etc/config.sh/completion_cache @@ -81,7 +81,7 @@ _of_complete_cache_[fluentMeshToFoam]="-case -fileHandler -scale | -noFunctionOb _of_complete_cache_[FMSToSurface]="-case -fileHandler | -exportFeatureEdges -exportSubsets -noFunctionObjects -doc -doc-source -help -help-full" _of_complete_cache_[FMSToVTK]="-case -fileHandler | -noFunctionObjects -doc -doc-source -help -help-full" _of_complete_cache_[foamDataToFluent]="-case -fileHandler -listScalarBCs -listVectorBCs -time | -latestTime -listFunctionObjects -listRegisteredSwitches -listSwitches -listUnsetSwitches -newTimes -noFunctionObjects -noZero -doc -doc-source -help -help-full" -_of_complete_cache_[foamDictionary]="-add -case -decomposeParDict -diff -diff-etc -entry -fileHandler -hostRoots -roots -set | -disableFunctionEntries -expand -includes -keywords -noFunctionObjects -parallel -remove -value -doc -doc-source -help -help-full" +_of_complete_cache_[foamDictionary]="-add -case -decomposeParDict -diff -diff-etc -entry -fileHandler -hostRoots -roots -set | -disableFunctionEntries -expand -includes -keywords -noFunctionObjects -parallel -remove -value -doc -doc-source -help-compat -help -help-full" _of_complete_cache_[foamFormatConvert]="-case -decomposeParDict -fileHandler -hostRoots -listScalarBCs -listVectorBCs -region -roots -time | -constant -enableFunctionEntries -latestTime -listFunctionObjects -listRegisteredSwitches -listSwitches -listUnsetSwitches -newTimes -noConstant -noFunctionObjects -noZero -parallel -doc -doc-source -help -help-full" _of_complete_cache_[foamListRegions]="-case -fileHandler | -listFunctionObjects -listRegisteredSwitches -listSwitches -listUnsetSwitches -doc -doc-source -help -help-full" _of_complete_cache_[foamListTimes]="-case -fileHandler -time | -constant -latestTime -listFunctionObjects -listRegisteredSwitches -listSwitches -listUnsetSwitches -newTimes -noZero -processor -rm -verbose -withZero -doc -doc-source -help -help-full" @@ -95,7 +95,7 @@ _of_complete_cache_[foamToStarMesh]="-case -fileHandler -scale -time | -constant _of_complete_cache_[foamToSurface]="-case -fileHandler -scale -time | -constant -latestTime -listFunctionObjects -listRegisteredSwitches -listSwitches -listUnsetSwitches -newTimes -noFunctionObjects -noZero -tri -doc -doc-source -help -help-full" _of_complete_cache_[foamToTetDualMesh]="-case -decomposeParDict -fileHandler -hostRoots -listScalarBCs -listVectorBCs -roots -time | -constant -latestTime -listFunctionObjects -listRegisteredSwitches -listSwitches -listUnsetSwitches -noFunctionObjects -noZero -overwrite -parallel -doc -doc-source -help -help-full" _of_complete_cache_[foamToVTK]="-case -cellSet -cellZone -decomposeParDict -excludePatches -faceSet -fields -fileHandler -hostRoots -listScalarBCs -listVectorBCs -name -pointSet -region -roots -time | -allPatches -ascii -constant -finiteAreaFields -latestTime -listFunctionObjects -listRegisteredSwitches -listSwitches -listUnsetSwitches -nearCellValue -newTimes -noFaceZones -noFunctionObjects -noInternal -noLagrangian -noLinks -noPointValues -noZero -parallel -poly -surfaceFields -useTimeName -xml -doc -doc-source -help -help-full" -_of_complete_cache_[foamUpgradeCyclics]="-case -decomposeParDict -fileHandler -hostRoots -listScalarBCs -listVectorBCs -region -roots -time | -constant -dry-run -enableFunctionEntries -latestTime -listFunctionObjects -listRegisteredSwitches -listSwitches -listUnsetSwitches -newTimes -noFunctionObjects -noZero -parallel -doc -doc-source -help -help-full" +_of_complete_cache_[foamUpgradeCyclics]="-case -decomposeParDict -fileHandler -hostRoots -listScalarBCs -listVectorBCs -region -roots -time | -constant -dry-run -enableFunctionEntries -latestTime -listFunctionObjects -listRegisteredSwitches -listSwitches -listUnsetSwitches -newTimes -noFunctionObjects -noZero -parallel -doc -doc-source -help-compat -help -help-full" _of_complete_cache_[foamyHexMesh]="-case -decomposeParDict -fileHandler -hostRoots -listScalarBCs -listVectorBCs -roots | -checkGeometry -conformationOnly -listFunctionObjects -listRegisteredSwitches -listSwitches -listUnsetSwitches -noFunctionObjects -parallel -doc -doc-source -help -help-full" _of_complete_cache_[foamyQuadMesh]="-case -fileHandler -pointsFile | -listFunctionObjects -listRegisteredSwitches -listSwitches -listUnsetSwitches -noFunctionObjects -overwrite -doc -doc-source -help -help-full" _of_complete_cache_[gambitToFoam]="-case -fileHandler -scale | -noFunctionObjects -doc -doc-source -help -help-full" diff --git a/src/OpenFOAM/db/Time/timeSelector.C b/src/OpenFOAM/db/Time/timeSelector.C index 6366a5fc12a951078a99e21b7ee9131390c31cc7..7400619b9987de0ca92ac0fc89d99c6e39e1a798 100644 --- a/src/OpenFOAM/db/Time/timeSelector.C +++ b/src/OpenFOAM/db/Time/timeSelector.C @@ -116,7 +116,7 @@ void Foam::timeSelector::addOptions argList::addBoolOption ( "constant", - "include the 'constant/' dir in the times list" + "Include the 'constant/' dir in the times list" ); } if (withZero) @@ -124,13 +124,13 @@ void Foam::timeSelector::addOptions argList::addBoolOption ( "withZero", - "include the '0/' dir in the times list" + "Include the '0/' dir in the times list" ); } argList::addBoolOption ( "noZero", - string("exclude the '0/' dir from the times list") + string("Exclude the '0/' dir from the times list") + ( withZero ? ", has precedence over the -withZero option" @@ -140,18 +140,18 @@ void Foam::timeSelector::addOptions argList::addBoolOption ( "latestTime", - "select the latest time" + "Select the latest time" ); argList::addBoolOption ( "newTimes", - "select the new times" + "Select the new times" ); argList::addOption ( "time", "ranges", - "comma-separated time ranges - eg, ':10,20,40:70,1000:'" + "Comma-separated time ranges - eg, ':10,20,40:70,1000:'" ); } diff --git a/src/OpenFOAM/global/argList/argList.C b/src/OpenFOAM/global/argList/argList.C index 81efd8fe460cd8e410287c1bbeacd60aa98974fe..8c05b0c84e91eac438c315b9ed66bb543909f5d3 100644 --- a/src/OpenFOAM/global/argList/argList.C +++ b/src/OpenFOAM/global/argList/argList.C @@ -68,41 +68,43 @@ Foam::argList::initValidTables::initValidTables() argList::addOption ( "case", "dir", - "specify alternate case directory, default is the cwd" + "Specify case directory to use (instead of the cwd)" ); - argList::addBoolOption("parallel", "run in parallel"); + argList::addBoolOption("parallel", "Run in parallel"); validParOptions.set("parallel", ""); argList::addOption ( "roots", "(dir1 .. dirN)", - "slave root directories for distributed running" + "Slave root directories for distributed running", + true // advanced option ); validParOptions.set("roots", "(dir1 .. dirN)"); argList::addOption ( "decomposeParDict", "file", - "read decomposePar dictionary from specified location" + "Use specified file for decomposePar dictionary" ); argList::addOption ( "hostRoots", "(((host1 dir1) .. (hostN dirN))", "slave root directories (per host) for distributed running. " - "The host specification can use a regex." + "The host specification can use a regex.", + true // advanced option ); validParOptions.set("hostRoots", "((host1 dir1) .. (hostN dirN))"); argList::addBoolOption ( "noFunctionObjects", - "do not execute function objects" + "Do not execute function objects" ); argList::addOption ( - "fileHandler", - "handler", - "override the file handler type" + "fileHandler", "handler", + "Override the file handler type", + true // advanced option ); // Some standard option aliases (with or without version warnings) @@ -369,7 +371,7 @@ void Foam::argList::noLibs() addBoolOption ( "no-libs", - "disable use of the controlDict libs entry", + "Disable use of the controlDict libs entry", true // advanced ); } @@ -894,27 +896,15 @@ void Foam::argList::parse ) { // Help/documentation options: - // -help print the usage - // -help-full print the full usage - // -doc display application documentation in browser - // -doc-source display source code in browser - // -list-compat print compatibility information + // -doc Display documentation in browser + // -doc-source Display source code in browser + // -help Display short help and exit + // -help-compat Display compatibility options + // -help-full Display full help and exit { bool quickExit = false; - // Only display one or the other - if (options_.found("help-full")) - { - printUsage(true); - quickExit = true; - } - else if (options_.found("help")) - { - printUsage(false); - quickExit = true; - } - - // Only display one or the other + // Display either application or source documentation, not both if (options_.found("doc")) { displayDoc(false); @@ -930,7 +920,20 @@ void Foam::argList::parse quickExit = true; } - if (options_.found("list-compat")) + // Display either short or full help, not both + if (options_.found("help-full")) + { + printUsage(true); + quickExit = true; + } + else if (options_.found("help")) + { + printUsage(false); + quickExit = true; + } + + // Allow independent display of compatibility information + if (options_.found("help-compat")) { printCompat(); quickExit = true; @@ -1613,16 +1616,28 @@ void Foam::argList::printUsage(bool full) const } // Place documentation/help options at the end + Info<< " -doc"; - printOptionUsage(6, "display application documentation in browser"); + printOptionUsage(6, "Display documentation in browser"); Info<< " -doc-source"; - printOptionUsage(13, "display source code in browser" ); + printOptionUsage(13, "Display source code in browser" ); Info<< " -help"; - printOptionUsage(7, "print usage information and exit"); + printOptionUsage(7, "Display short help and exit"); + + if + ( + argList::validOptionsCompat.size() + + argList::ignoreOptionsCompat.size() + ) + { + Info<< " -help-compat"; + printOptionUsage(14, "Display compatibility options and exit"); + } + Info<< " -help-full"; - printOptionUsage(12, "print full usage information and exit"); + printOptionUsage(12, "Display full help and exit"); printNotes(); diff --git a/src/OpenFOAM/include/addDictOption.H b/src/OpenFOAM/include/addDictOption.H index 055983396acddd01ca4b78d28982527d62969922..ea1cf08c67f0a9c9e8d30c90eba31a23970940a3 100644 --- a/src/OpenFOAM/include/addDictOption.H +++ b/src/OpenFOAM/include/addDictOption.H @@ -2,5 +2,5 @@ Foam::argList::addOption ( "dict", "file", - "read control dictionary from specified location" + "Read control dictionary from specified location" ); diff --git a/src/OpenFOAM/include/addOverwriteOption.H b/src/OpenFOAM/include/addOverwriteOption.H index a1ac66992898c3be1a5e418c4689bd844c0c88ba..a3a551f64ed53c4edce4397a736639ee2022ec15 100644 --- a/src/OpenFOAM/include/addOverwriteOption.H +++ b/src/OpenFOAM/include/addOverwriteOption.H @@ -1,5 +1,5 @@ Foam::argList::addBoolOption ( "overwrite", - "overwrite existing mesh/results files" + "Overwrite existing mesh/results files" ); diff --git a/src/OpenFOAM/include/addProfilingOption.H b/src/OpenFOAM/include/addProfilingOption.H index 6c2374802dc0d8c320153d65ef8c8f2c714bf072..31945f5c86f38230e7823172341af2b10b478612 100644 --- a/src/OpenFOAM/include/addProfilingOption.H +++ b/src/OpenFOAM/include/addProfilingOption.H @@ -1,5 +1,5 @@ Foam::argList::addBoolOption ( "profiling", - "activate application-level profiling" + "Activate application-level profiling" ); diff --git a/src/OpenFOAM/include/addRegionOption.H b/src/OpenFOAM/include/addRegionOption.H index 8aaca18e98107a6ef635e6912d69f8d641c543cd..b1946812da37d414f9db0b1c4290116ff81daab9 100644 --- a/src/OpenFOAM/include/addRegionOption.H +++ b/src/OpenFOAM/include/addRegionOption.H @@ -2,5 +2,5 @@ Foam::argList::addOption ( "region", "name", - "specify alternative mesh region" + "Specify alternative mesh region" );