zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

ENH: tag some options as 'advanced' (only shown with -help-full)

Browse Source 
General:
    * -roots, -hostRoots, -fileHandler

Specific:
    * -to <coordinateSystem> -from <coordinateSystem>

- Display -help-compat when compatibility or ignored options are available

STYLE: capitalization of options text
This commit is contained in:
Mark Olesen
2018-07-31 11:54:15 +02:00
parent d40103a86f
commit cb919a6c41
98 changed files with 403 additions and 385 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
applications/solvers/electromagnetics/magneticFoam/magneticFoam.C
View File

@ -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"

4
applications/utilities/mesh/advanced/combinePatchFaces/combinePatchFaces.C
View File

@ -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"

2
applications/utilities/mesh/advanced/refineHexMesh/refineHexMesh.C
View File

@ -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)"
);

2
applications/utilities/mesh/advanced/refineWallLayer/refineWallLayer.C
View File

@ -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"
);

2
applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C
View File

@ -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"

9
applications/utilities/mesh/advanced/splitCells/splitCells.C
View File

@ -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"

2
applications/utilities/mesh/conversion/ansysToFoam/ansysToFoam.L
View File

@ -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);

22
applications/utilities/mesh/conversion/ccm/ccmToFoam/ccmToFoam.C
View File

@ -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);

10
applications/utilities/mesh/conversion/ccm/foamToCcm/foamToCcm.C
View File

@ -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"

2
applications/utilities/mesh/conversion/cfx4ToFoam/cfx4ToFoam.C
View File

@ -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);

6
applications/utilities/mesh/conversion/fireToFoam/fireToFoam.C
View File

@ -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)"
);

8
applications/utilities/mesh/conversion/fluent3DMeshToFoam/fluent3DMeshToFoam.L
View File

@ -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);

8
applications/utilities/mesh/conversion/fluentMeshToFoam/fluentMeshToFoam.L
View File

@ -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);

6
applications/utilities/mesh/conversion/foamToFireMesh/foamToFireMesh.C
View File

@ -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"

6
applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C
View File

@ -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"

4
applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C
View File

@ -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"

2
applications/utilities/mesh/conversion/gambitToFoam/gambitToFoam.L
View File

@ -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);

2
applications/utilities/mesh/conversion/gmshToFoam/gmshToFoam.C
View File

@ -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"

2
applications/utilities/mesh/conversion/ideasUnvToFoam/ideasUnvToFoam.C
View File

@ -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"

6
applications/utilities/mesh/conversion/kivaToFoam/kivaToFoam.C
View File

@ -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"

2
applications/utilities/mesh/conversion/mshToFoam/mshToFoam.C
View File

@ -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"

8
applications/utilities/mesh/conversion/plot3dToFoam/plot3dToFoam.C
View File

@ -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);

8
applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C
View File

@ -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"
);

2
applications/utilities/mesh/conversion/tetgenToFoam/tetgenToFoam.C
View File

@ -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"

22
applications/utilities/mesh/conversion/writeMeshObj/writeMeshObj.C
View File

@ -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"

8
applications/utilities/mesh/generation/blockMesh/blockMesh.C
View File

@ -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
(

8
applications/utilities/mesh/generation/foamyMesh/foamyHexMesh/foamyHexMesh.C
View File

@ -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"

5
applications/utilities/mesh/generation/foamyMesh/foamyHexMeshBackgroundMesh/foamyHexMeshBackgroundMesh.C
View File

@ -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"

16
applications/utilities/mesh/generation/snappyHexMesh/snappyHexMesh.C
View File

@ -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"

14
applications/utilities/mesh/manipulation/checkMesh/checkMesh.C
View File

@ -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"

6
applications/utilities/mesh/manipulation/createPatch/createPatch.C
View File

@ -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");

8
applications/utilities/mesh/manipulation/mergeMeshes/mergeMeshes.C
View File

@ -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);

4
applications/utilities/mesh/manipulation/mergeOrSplitBaffles/mergeOrSplitBaffles.C
View File

@ -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"

2
applications/utilities/mesh/manipulation/moveDynamicMesh/moveDynamicMesh.C
View File

@ -166,7 +166,7 @@ int main(int argc, char *argv[])
argList::addBoolOption
(
"checkAMI",
"check AMI weights"
"Check AMI weights"
);
#include "setRootCase.H"

6
applications/utilities/mesh/manipulation/polyDualMesh/polyDualMeshApp.C
View File

@ -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"
);

4
applications/utilities/mesh/manipulation/refineMesh/refineMesh.C
View File

@ -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"

2
applications/utilities/mesh/manipulation/renumberMesh/renumberMesh.C
View File

@ -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"
);

8
applications/utilities/mesh/manipulation/setSet/setSet.C
View File

@ -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"

4
applications/utilities/mesh/manipulation/setsToZones/setsToZones.C
View File

@ -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"

24
applications/utilities/mesh/manipulation/splitMeshRegions/splitMeshRegions.C
View File

@ -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"

10
applications/utilities/mesh/manipulation/stitchMesh/stitchMesh.C
View File

@ -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

8
applications/utilities/mesh/manipulation/subsetMesh/subsetMesh.C
View File

@ -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"

2
applications/utilities/mesh/manipulation/topoSet/topoSet.C
View File

@ -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"

6
applications/utilities/miscellaneous/foamDictionary/foamDictionary.C
View File

@ -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
(

4
applications/utilities/miscellaneous/foamFormatConvert/foamFormatConvert.C
View File

@ -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"

6
applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.C
View File

@ -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)"
);
}

2
applications/utilities/miscellaneous/foamHelp/helpTypes/helpSolver/helpSolver.C
View File

@ -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"
);
}

2
applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.C
View File

@ -183,7 +183,7 @@ void Foam::helpType::init()
(
"browse",
"word",
"display documentation in browser"
"Display documentation in browser"
);
}

6
applications/utilities/miscellaneous/foamListTimes/foamListTimes.C
View File

@ -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)

18
applications/utilities/parallelProcessing/decomposePar/decomposePar.C
View File

@ -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

14
applications/utilities/parallelProcessing/reconstructPar/reconstructPar.C
View File

@ -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"

9
applications/utilities/parallelProcessing/reconstructParMesh/reconstructParMesh.C
View File

@ -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."
);

11
applications/utilities/parallelProcessing/redistributePar/redistributePar.C
View File

@ -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)"
);

20
applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C
View File

@ -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

12
applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C
View File

@ -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

40
applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C
View File

@ -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"

2
applications/utilities/postProcessing/lumped/lumpedPointForces/lumpedPointForces.C
View File

@ -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);

10
applications/utilities/postProcessing/lumped/lumpedPointMovement/lumpedPointMovement.C
View File

@ -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");

2
applications/utilities/postProcessing/lumped/lumpedPointZones/lumpedPointZones.C
View File

@ -55,7 +55,7 @@ int main(int argc, char *argv[])
argList::addBoolOption
(
"verbose",
"increased verbosity"
"Additional verbosity"
);
#include "addRegionOption.H"

6
applications/utilities/postProcessing/miscellaneous/temporalInterpolate/temporalInterpolate.C
View File

@ -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"

6
applications/utilities/preProcessing/applyBoundaryLayer/applyBoundaryLayer.C
View File

@ -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
(

10
applications/utilities/preProcessing/changeDictionary/changeDictionary.C
View File

@ -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"

2
applications/utilities/preProcessing/createExternalCoupledPatchGeometry/addRegionsOption.H
View File

@ -6,5 +6,5 @@
(
"regions",
"(name1 .. nameN)",
"specify alternative mesh regions"
"Specify alternative mesh regions"
);

2
applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C
View File

@ -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"

4
applications/utilities/preProcessing/createZeroDirectory/createZeroDirectory.C
View File

@ -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"

4
applications/utilities/preProcessing/foamUpgradeCyclics/foamUpgradeCyclics.C
View File

@ -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"

22
applications/utilities/preProcessing/mapFields/mapFields.C
View File

@ -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"
);

22
applications/utilities/preProcessing/mapFieldsPar/mapFieldsPar.C
View File

@ -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);

8
applications/utilities/surface/surfaceAdd/surfaceAdd.C
View File

@ -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);

2
applications/utilities/surface/surfaceBooleanFeatures/surfaceBooleanFeatures.C
View File

@ -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."
);

16
applications/utilities/surface/surfaceCheck/surfaceCheck.C
View File

@ -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"
);

2
applications/utilities/surface/surfaceCoarsen/surfaceCoarsen.C
View File

@ -79,7 +79,7 @@ int main(int argc, char *argv[])
(
"scale",
"factor",
"input geometry scaling factor"
"Input geometry scaling factor"
);
argList args(argc, argv);

11
applications/utilities/surface/surfaceConvert/surfaceConvert.C
View File

@ -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];

2
applications/utilities/surface/surfaceFeatureConvert/surfaceFeatureConvert.C
View File

@ -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);

2
applications/utilities/surface/surfaceFeatureExtract/surfaceFeatureExtract.C
View File

@ -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"

2
applications/utilities/surface/surfaceHookUp/surfaceHookUp.C
View File

@ -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();

2
applications/utilities/surface/surfaceInertia/surfaceInertia.C
View File

@ -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

12
applications/utilities/surface/surfaceInflate/surfaceInflate.C
View File

@ -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");

2
applications/utilities/surface/surfaceLambdaMuSmooth/surfaceLambdaMuSmooth.C
View File

@ -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);

14
applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C
View File

@ -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"
);

16
applications/utilities/surface/surfaceMeshExport/surfaceMeshExport.C
View File

@ -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);

16
applications/utilities/surface/surfaceMeshImport/surfaceMeshImport.C
View File

@ -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"

8
applications/utilities/surface/surfaceMeshInfo/surfaceMeshInfo.C
View File

@ -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)

8
applications/utilities/surface/surfaceMeshTriangulate/surfaceMeshTriangulate.C
View File

@ -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"

8
applications/utilities/surface/surfaceOrient/surfaceOrient.C
View File

@ -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);

2
applications/utilities/surface/surfacePointMerge/surfacePointMerge.C
View File

@ -59,7 +59,7 @@ int main(int argc, char *argv[])
(
"scale",
"factor",
"input geometry scaling factor"
"Input geometry scaling factor"
);
argList args(argc, argv);

2
applications/utilities/surface/surfaceRedistributePar/surfaceRedistributePar.C
View File

@ -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"

2
applications/utilities/surface/surfaceSplitByPatch/surfaceSplitByPatch.C
View File

@ -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();

4
applications/utilities/surface/surfaceSplitNonManifolds/surfaceSplitNonManifolds.C
View File

@ -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);

6
applications/utilities/surface/surfaceToPatch/surfaceToPatch.C
View File

@ -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"

2
applications/utilities/thermophysical/chemkinToFoam/chemkinToFoam.C
View File

@ -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);

4
etc/config.sh/completion_cache
View File

@ -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"

12
src/OpenFOAM/db/Time/timeSelector.C
View File

@ -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:'"
);
}

81
src/OpenFOAM/global/argList/argList.C
View File

@ -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();

2
src/OpenFOAM/include/addDictOption.H
View File

@ -2,5 +2,5 @@ Foam::argList::addOption
(
"dict",
"file",
"read control dictionary from specified location"
"Read control dictionary from specified location"
);

2
src/OpenFOAM/include/addOverwriteOption.H
View File

@ -1,5 +1,5 @@
Foam::argList::addBoolOption
(
"overwrite",
"overwrite existing mesh/results files"
"Overwrite existing mesh/results files"
);

2
src/OpenFOAM/include/addProfilingOption.H
View File

@ -1,5 +1,5 @@
Foam::argList::addBoolOption
(
"profiling",
"activate application-level profiling"
"Activate application-level profiling"
);

2
src/OpenFOAM/include/addRegionOption.H
View File

@ -2,5 +2,5 @@ Foam::argList::addOption
(
"region",
"name",
"specify alternative mesh region"
"Specify alternative mesh region"
);