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

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

View File

@ -50,19 +50,19 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"noH", "noH",
"do not write the magnetic field intensity field" "Do not write the magnetic field intensity field"
); );
argList::addBoolOption argList::addBoolOption
( (
"noB", "noB",
"do not write the magnetic flux density field" "Do not write the magnetic flux density field"
); );
argList::addBoolOption argList::addBoolOption
( (
"HdotGradH", "HdotGradH",
"write the paramagnetic particle force field" "Write the paramagnetic particle force field"
); );
#include "addCheckCaseOptions.H" #include "addCheckCaseOptions.H"

View File

@ -350,12 +350,12 @@ int main(int argc, char *argv[])
( (
"concaveAngle", "concaveAngle",
"degrees", "degrees",
"specify concave angle [0..180] (default: 30 degrees)" "Specify concave angle [0..180] (default: 30 degrees)"
); );
argList::addBoolOption argList::addBoolOption
( (
"meshQuality", "meshQuality",
"read user-defined mesh quality criterions from system/meshQualityDict" "Read user-defined mesh quality criterions from system/meshQualityDict"
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

@ -62,7 +62,7 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"minSet", "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)" " (default is to extend set)"
); );

View File

@ -69,7 +69,7 @@ int main(int argc, char *argv[])
( (
"useSet", "useSet",
"name", "name",
"restrict cells to refine based on specified cellSet name" "Restrict cells to refine based on specified cellSet name"
); );

View File

@ -104,7 +104,7 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"readLevel", "readLevel",
"read level from refinementLevel file" "Read level from refinementLevel file"
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

@ -524,7 +524,7 @@ int main(int argc, char *argv[])
{ {
argList::addNote argList::addNote
( (
"split cells with flat faces" "Split cells with flat faces"
); );
#include "addOverwriteOption.H" #include "addOverwriteOption.H"
argList::noParallel(); argList::noParallel();
@ -534,17 +534,18 @@ int main(int argc, char *argv[])
( (
"set", "set",
"name", "name",
"split cells from specified cellSet only" "Split cells from specified cellSet only"
); );
argList::addBoolOption argList::addBoolOption
( (
"geometry", "geometry",
"use geometric cut for hexes as well" "Use geometric cut for hexes as well"
); );
argList::addOption argList::addOption
( (
"tol", "tol",
"scalar", "edge snap tolerance (default 0.2)" "scalar",
"Edge snap tolerance (default 0.2)"
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

@ -304,7 +304,7 @@ int main(int argc, char *argv[])
( (
"scale", "scale",
"factor", "factor",
"geometry scaling factor - default is 1" "Geometry scaling factor - default is 1"
); );
argList args(argc, argv); argList args(argc, argv);

View File

@ -103,57 +103,57 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"ascii", "ascii",
"write in ASCII format instead of binary" "Write in ASCII format instead of binary"
); );
argList::addBoolOption argList::addBoolOption
( (
"export", "export",
"re-export mesh in CCM format for post-processing" "Re-export mesh in CCM format for post-processing"
); );
argList::addBoolOption argList::addBoolOption
( (
"list", "list",
"list some information about the geometry" "List some information about the geometry"
); );
argList::addOption argList::addOption
( (
"remap", "remap",
"name", "name",
"use specified remapping dictionary instead of <constant/remapping>" "Use specified remapping dictionary instead of <constant/remapping>"
); );
argList::addOption argList::addOption
( (
"name", "name",
"name", "name",
"provide alternative base name when re-exporting (implies -export). " "Provide alternative base name when re-exporting (implies -export). "
"Default is <meshExport>." "Default is <meshExport>."
); );
argList::addBoolOption argList::addBoolOption
( (
"noBaffles", "noBaffles",
"remove any baffles by merging the faces" "Remove any baffles by merging the faces"
); );
argList::addBoolOption argList::addBoolOption
( (
"merge", "merge",
"merge in-place interfaces" "Merge in-place interfaces"
); );
argList::addBoolOption argList::addBoolOption
( (
"numbered", "numbered",
"use numbered names (eg, patch_0, zone_0) only" "Use numbered names (eg, patch_0, zone_0) only"
); );
argList::addOption argList::addOption
( (
"scale", "scale",
"scale", "scale",
"geometry scaling factor - default is 1 (ie, no scaling)" "Geometry scaling factor - default is 1 (ie, no scaling)"
); );
argList::addBoolOption argList::addBoolOption
( (
"solids", "solids",
"treat any solid cells present just like fluid cells. " "Treat any solid cells present just like fluid cells. "
"the default is to remove them." "The default is to remove them."
); );
argList args(argc, argv); argList args(argc, argv);

View File

@ -91,29 +91,29 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"mesh", "mesh",
"convert mesh only" "Convert mesh only"
); );
argList::addOption argList::addOption
( (
"name", "name",
"name", "name",
"provide alternative base name. Default is <meshExport>." "Provide alternative base name. Default is <meshExport>."
); );
argList::addBoolOption argList::addBoolOption
( (
"overwrite", "overwrite",
"no backup of existing output files" "No backup of existing output files"
); );
argList::addOption argList::addOption
( (
"remap", "remap",
"name", "name",
"use specified remapping dictionary instead of <constant/remapping>" "Use specified remapping dictionary instead of <constant/remapping>"
); );
argList::addBoolOption argList::addBoolOption
( (
"results", "results",
"convert results only" "Convert results only"
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

@ -54,7 +54,7 @@ int main(int argc, char *argv[])
( (
"scale", "scale",
"factor", "factor",
"geometry scaling factor - default is 1" "Geometry scaling factor - default is 1"
); );
argList args(argc, argv); argList args(argc, argv);

View File

@ -68,18 +68,18 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"ascii", "ascii",
"write in ASCII format instead of binary" "Write in ASCII format instead of binary"
); );
argList::addBoolOption argList::addBoolOption
( (
"check", "check",
"perform edge checking as well" "Perform edge checking as well"
); );
argList::addOption argList::addOption
( (
"scale", "scale",
"scale", "scale",
"geometry scaling factor - default is 1 (no scaling)" "Geometry scaling factor - default is 1 (no scaling)"
); );

View File

@ -779,25 +779,25 @@ int main(int argc, char *argv[])
( (
"scale", "scale",
"factor", "factor",
"geometry scaling factor - default is 1" "Geometry scaling factor - default is 1"
); );
argList::addOption argList::addOption
( (
"ignoreCellGroups", "ignoreCellGroups",
"names", "names",
"specify cell groups to ignore" "Specify cell groups to ignore"
); );
argList::addOption argList::addOption
( (
"ignoreFaceGroups", "ignoreFaceGroups",
"names", "names",
"specify face groups to ignore" "Specify face groups to ignore"
); );
argList::addBoolOption argList::addBoolOption
( (
"cubit", "cubit",
"special parsing of (incorrect) cubit files" "Special parsing of (incorrect) cubit files"
); );
argList args(argc, argv); argList args(argc, argv);

View File

@ -871,23 +871,23 @@ int main(int argc, char *argv[])
( (
"scale", "scale",
"factor", "factor",
"geometry scaling factor - default is 1" "Geometry scaling factor - default is 1"
); );
argList::addOption argList::addOption
( (
"2D", "2D",
"thickness", "thickness",
"use when converting a 2-D mesh (applied before scale)" "Use when converting a 2-D mesh (applied before scale)"
); );
argList::addBoolOption argList::addBoolOption
( (
"writeSets", "writeSets",
"write cell zones and patches as sets" "Write cell zones and patches as sets"
); );
argList::addBoolOption argList::addBoolOption
( (
"writeZones", "writeZones",
"write cell zones as zones" "Write cell zones as zones"
); );
argList args(argc, argv); argList args(argc, argv);

View File

@ -58,7 +58,7 @@ int main(int argc, char *argv[])
{ {
argList::addNote argList::addNote
( (
"read OpenFOAM mesh and write an AVL/FIRE fpma format" "Read OpenFOAM mesh and write an AVL/FIRE fpma format"
); );
argList::noParallel(); argList::noParallel();
timeSelector::addOptions(); timeSelector::addOptions();
@ -66,13 +66,13 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"ascii", "ascii",
"write in ASCII format instead of binary" "Write in ASCII format instead of binary"
); );
argList::addOption argList::addOption
( (
"scale", "scale",
"factor", "factor",
"geometry scaling factor - default is 1 (none)" "Geometry scaling factor - default is 1 (none)"
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

@ -67,7 +67,7 @@ int main(int argc, char *argv[])
{ {
argList::addNote 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(); argList::noParallel();
timeSelector::addOptions(); timeSelector::addOptions();
@ -76,12 +76,12 @@ int main(int argc, char *argv[])
( (
"scale", "scale",
"factor", "factor",
"geometry scaling factor - default is 1000 ([m] to [mm])" "Geometry scaling factor - default is 1000 ([m] to [mm])"
); );
argList::addBoolOption argList::addBoolOption
( (
"noBnd", "noBnd",
"suppress writing a boundary (.bnd) file" "Suppress writing a boundary (.bnd) file"
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

@ -64,12 +64,12 @@ int main(int argc, char *argv[])
( (
"scale", "scale",
"factor", "factor",
"geometry scaling factor - default is 1" "Geometry scaling factor - default is 1"
); );
argList::addBoolOption argList::addBoolOption
( (
"tri", "tri",
"triangulate surface" "Triangulate surface"
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

@ -631,7 +631,7 @@ int main(int argc, char *argv[])
( (
"scale", "scale",
"factor", "factor",
"geometry scaling factor - default is 1" "Geometry scaling factor - default is 1"
); );
argList args(argc, argv); argList args(argc, argv);

View File

@ -773,7 +773,7 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"keepOrientation", "keepOrientation",
"retain raw orientation for prisms/hexs" "Retain raw orientation for prisms/hexs"
); );
#include "addRegionOption.H" #include "addRegionOption.H"

View File

@ -671,7 +671,7 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"dump", "dump",
"dump boundary faces as boundaryFaces.obj (for debugging)" "Dump boundary faces as boundaryFaces.obj (for debugging)"
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

@ -63,19 +63,19 @@ int main(int argc, char *argv[])
( (
"file", "file",
"name", "name",
"specify alternative input file name - default is otape17" "Specify alternative input file name - default is otape17"
); );
argList::addOption argList::addOption
( (
"version", "version",
"version", "version",
"specify kiva version [kiva3|kiva3v] - default is '3v'" "Specify kiva version [kiva3|kiva3v] - default is '3v'"
); );
argList::addOption argList::addOption
( (
"zHeadMin", "zHeadMin",
"scalar", "scalar",
"minimum z-height for transferring liner faces to cylinder-head" "Minimum z-height for transferring liner faces to cylinder-head"
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

@ -64,7 +64,7 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"hex", "hex",
"treat input as containing hex instead of tet cells" "Treat input as containing hex instead of tet cells"
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

@ -64,23 +64,23 @@ int main(int argc, char *argv[])
( (
"scale", "scale",
"factor", "factor",
"geometry scaling factor - default is 1" "Geometry scaling factor - default is 1"
); );
argList::addBoolOption argList::addBoolOption
( (
"noBlank", "noBlank",
"skip blank items" "Skip blank items"
); );
argList::addBoolOption argList::addBoolOption
( (
"singleBlock", "singleBlock",
"input is a single block" "Input is a single block"
); );
argList::addOption argList::addOption
( (
"2D", "2D",
"thickness", "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); argList args(argc, argv);

View File

@ -66,7 +66,7 @@ int main(int argc, char *argv[])
{ {
argList::addNote argList::addNote
( (
"convert STARCD/PROSTAR (v4) mesh to OpenFOAM" "Convert STARCD/PROSTAR (v4) mesh to OpenFOAM"
); );
argList::noParallel(); argList::noParallel();
@ -74,18 +74,18 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"ascii", "ascii",
"write in ASCII instead of binary format" "Write in ASCII instead of binary format"
); );
argList::addOption argList::addOption
( (
"scale", "scale",
"factor", "factor",
"geometry scaling factor - default is 0.001 ([mm] to [m])" "Geometry scaling factor - default is 0.001 ([mm] to [m])"
); );
argList::addBoolOption argList::addBoolOption
( (
"solids", "solids",
"retain solid cells and treat them like fluid cells" "Retain solid cells and treat like fluid cells"
); );

View File

@ -105,7 +105,7 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"noFaceFile", "noFaceFile",
"skip reading .face file for boundary information" "Skip reading .face file for boundary information"
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

@ -376,49 +376,49 @@ int main(int argc, char *argv[])
{ {
argList::addNote argList::addNote
( (
"for mesh debugging: write mesh as separate OBJ files" "For mesh debugging: write mesh as separate OBJ files"
); );
timeSelector::addOptions(); timeSelector::addOptions();
argList::addBoolOption argList::addBoolOption
( (
"patchFaces", "patchFaces",
"write patch faces edges" "Write patch faces edges"
); );
argList::addBoolOption argList::addBoolOption
( (
"patchEdges", "patchEdges",
"write patch boundary edges" "Write patch boundary edges"
); );
argList::addOption argList::addOption
( (
"cell", "cell",
"int", "cellId",
"write points for the specified cell" "Write points for the specified cell"
); );
argList::addOption argList::addOption
( (
"face", "face",
"int", "faceId",
"write specified face" "Write specified face"
); );
argList::addOption argList::addOption
( (
"point", "point",
"int", "pointId",
"write specified point" "Write specified point"
); );
argList::addOption argList::addOption
( (
"cellSet", "cellSet",
"name", "name",
"write points for specified cellSet" "Write points for specified cellSet"
); );
argList::addOption argList::addOption
( (
"faceSet", "faceSet",
"name", "name",
"write points for specified faceSet" "Write points for specified faceSet"
); );
#include "addRegionOption.H" #include "addRegionOption.H"

View File

@ -82,23 +82,23 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"blockTopology", "blockTopology",
"write block edges and centres as .obj files" "Write block edges and centres as .obj files"
); );
argList::addBoolOption argList::addBoolOption
( (
"noClean", "noClean",
"keep the existing files in the polyMesh" "Keep the existing files in the polyMesh"
); );
argList::addOption argList::addOption
( (
"dict", "dict",
"file", "file",
"specify alternative dictionary for the blockMesh description" "Specify alternative dictionary for the blockMesh description"
); );
argList::addBoolOption argList::addBoolOption
( (
"sets", "sets",
"write cellZones as cellSets too (for processing purposes)" "Write cellZones as cellSets too (for processing purposes)"
); );
argList::addNote argList::addNote
( (

View File

@ -45,16 +45,16 @@ using namespace Foam;
int main(int argc, char *argv[]) int main(int argc, char *argv[])
{ {
Foam::argList::addBoolOption argList::addBoolOption
( (
"checkGeometry", "checkGeometry",
"check all surface geometry for quality" "Check all surface geometry for quality"
); );
Foam::argList::addBoolOption argList::addBoolOption
( (
"conformationOnly", "conformationOnly",
"conform to the initial points without any point motion" "Conform to the initial points without any point motion"
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

@ -387,14 +387,13 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"writeMesh", "writeMesh",
"write the resulting mesh and distance fields" "Write the resulting mesh and distance fields"
); );
argList::addOption argList::addOption
( (
"mergeTol", "mergeTol",
"scalar", "scalar",
"specify the merge distance relative to the bounding box size " "The merge distance relative to the bounding box size (default 1e-6)"
"(default 1e-6)"
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

@ -679,28 +679,28 @@ int main(int argc, char *argv[])
{ {
#include "addRegionOption.H" #include "addRegionOption.H"
#include "addOverwriteOption.H" #include "addOverwriteOption.H"
Foam::argList::addBoolOption argList::addBoolOption
( (
"checkGeometry", "checkGeometry",
"check all surface geometry for quality" "Check all surface geometry for quality"
); );
Foam::argList::addOption argList::addOption
( (
"surfaceSimplify", "surfaceSimplify",
"boundBox", "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", "patches",
"(patch0 .. patchN)", "(patch0 .. patchN)",
"only triangulate selected patches (wildcards supported)" "Only triangulate selected patches (wildcards supported)"
); );
Foam::argList::addOption argList::addOption
( (
"outFile", "outFile",
"file", "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 "addProfilingOption.H"
#include "addDictOption.H" #include "addDictOption.H"

View File

@ -86,39 +86,39 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"noTopology", "noTopology",
"skip checking the mesh topology" "Skip checking the mesh topology"
); );
argList::addBoolOption argList::addBoolOption
( (
"allGeometry", "allGeometry",
"include bounding box checks" "Include bounding box checks"
); );
argList::addBoolOption argList::addBoolOption
( (
"allTopology", "allTopology",
"include extra topology checks" "Include extra topology checks"
); );
argList::addBoolOption argList::addBoolOption
( (
"writeAllFields", "writeAllFields",
"write volFields with mesh quality parameters" "Write volFields with mesh quality parameters"
); );
argList::addOption argList::addOption
( (
"writeFields", "writeFields",
"wordList", "wordList",
"write volFields with selected mesh quality parameters" "Write volFields with selected mesh quality parameters"
); );
argList::addBoolOption argList::addBoolOption
( (
"meshQuality", "meshQuality",
"read user-defined mesh quality criterions from system/meshQualityDict" "Read user-defined mesh quality criterions from system/meshQualityDict"
); );
argList::addOption argList::addOption
( (
"writeSets", "writeSets",
"surfaceFormat", "surfaceFormat",
"reconstruct and write all faceSets and cellSets in selected format" "Reconstruct and write all faceSets and cellSets in selected format"
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

@ -513,16 +513,16 @@ int main(int argc, char *argv[])
#include "addOverwriteOption.H" #include "addOverwriteOption.H"
#include "addRegionOption.H" #include "addRegionOption.H"
#include "addDictOption.H" #include "addDictOption.H"
Foam::argList::addBoolOption argList::addBoolOption
( (
"writeObj", "writeObj",
"write obj files showing the cyclic matching process" "Write obj files showing the cyclic matching process"
); );
#include "setRootCase.H" #include "setRootCase.H"
#include "createTime.H" #include "createTime.H"
runTime.functionObjects().off(); runTime.functionObjects().off();
Foam::word meshRegionName = polyMesh::defaultRegion; word meshRegionName = polyMesh::defaultRegion;
args.readIfPresent("region", meshRegionName); args.readIfPresent("region", meshRegionName);
const bool overwrite = args.found("overwrite"); const bool overwrite = args.found("overwrite");

View File

@ -64,7 +64,7 @@ int main(int argc, char *argv[])
{ {
argList::addNote argList::addNote
( (
"merge two meshes" "Merge two meshes"
); );
#include "addOverwriteOption.H" #include "addOverwriteOption.H"
@ -74,7 +74,7 @@ int main(int argc, char *argv[])
( (
"masterRegion", "masterRegion",
"name", "name",
"specify alternative mesh region for the master mesh" "Specify alternative mesh region for the master mesh"
); );
argList::addArgument("addCase"); argList::addArgument("addCase");
@ -82,13 +82,13 @@ int main(int argc, char *argv[])
( (
"addRegion", "addRegion",
"name", "name",
"specify alternative mesh region for the additional mesh" "Specify alternative mesh region for the additional mesh"
); );
argList::addOption argList::addOption
( (
"resultTime", "resultTime",
"time", "time",
"specify a time for the resulting mesh" "Specify a time for the resulting mesh"
); );
argList args(argc, argv); argList args(argc, argv);

View File

@ -287,12 +287,12 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"detectOnly", "detectOnly",
"find baffles only, but do not merge or split them" "Find baffles only, but do not merge or split them"
); );
argList::addBoolOption argList::addBoolOption
( (
"split", "split",
"topologically split duplicate surfaces" "Topologically split duplicate surfaces"
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

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

View File

@ -367,17 +367,17 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"splitAllFaces", "splitAllFaces",
"have multiple faces inbetween cells" "Have multiple faces inbetween cells"
); );
argList::addBoolOption argList::addBoolOption
( (
"concaveMultiCells", "concaveMultiCells",
"split cells on concave boundary edges into multiple cells" "Split cells on concave boundary edges into multiple cells"
); );
argList::addBoolOption argList::addBoolOption
( (
"doNotPreserveFaceZones", "doNotPreserveFaceZones",
"disable the default behaviour of preserving faceZones by having" "Disable the default behaviour of preserving faceZones by having"
" multiple faces inbetween cells" " multiple faces inbetween cells"
); );

View File

@ -157,14 +157,14 @@ int main(int argc, char *argv[])
{ {
argList::addNote argList::addNote
( (
"refine cells in multiple directions" "Refine cells in multiple directions"
); );
#include "addOverwriteOption.H" #include "addOverwriteOption.H"
#include "addRegionOption.H" #include "addRegionOption.H"
#include "addDictOption.H" #include "addDictOption.H"
Foam::argList::addBoolOption argList::addBoolOption
( (
"all", "all",
"Refine all cells" "Refine all cells"

View File

@ -621,7 +621,7 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"frontWidth", "frontWidth",
"calculate the rms of the frontwidth" "Calculate the rms of the frontwidth"
); );

View File

@ -736,18 +736,18 @@ int main(int argc, char *argv[])
timeSelector::addOptions(true, false); timeSelector::addOptions(true, false);
#include "addRegionOption.H" #include "addRegionOption.H"
argList::addBoolOption("noVTK", "do not write VTK files"); argList::addBoolOption("noVTK", "Do not write VTK files");
argList::addBoolOption("loop", "execute batch commands for all timesteps"); argList::addBoolOption("loop", "Execute batch commands for all timesteps");
argList::addOption argList::addOption
( (
"batch", "batch",
"file", "file",
"process in batch mode, using input from specified file" "Process in batch mode, using input from specified file"
); );
argList::addBoolOption argList::addBoolOption
( (
"noSync", "noSync",
"do not synchronise selection across coupled patches" "Do not synchronise selection across coupled patches"
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

@ -63,13 +63,13 @@ int main(int argc, char *argv[])
timeSelector::addOptions(true, false); timeSelector::addOptions(true, false);
argList::addNote 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 argList::addBoolOption
( (
"noFlipMap", "noFlipMap",
"ignore orientation of faceSet" "Ignore orientation of faceSet"
); );
#include "addRegionOption.H" #include "addRegionOption.H"

View File

@ -1417,67 +1417,67 @@ int main(int argc, char *argv[])
{ {
argList::addNote 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 "addRegionOption.H"
#include "addOverwriteOption.H" #include "addOverwriteOption.H"
argList::addBoolOption argList::addBoolOption
( (
"cellZones", "cellZones",
"additionally split cellZones off into separate regions" "Additionally split cellZones off into separate regions"
); );
argList::addBoolOption argList::addBoolOption
( (
"cellZonesOnly", "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 argList::addOption
( (
"cellZonesFileOnly", "cellZonesFileOnly",
"file", "file",
"like -cellZonesOnly, but use specified file" "Like -cellZonesOnly, but use specified file"
); );
argList::addOption argList::addOption
( (
"blockedFaces", "blockedFaces",
"faceSet", "faceSet",
"specify additional region boundaries that walking does not cross" "Specify additional region boundaries that walking does not cross"
); );
argList::addBoolOption argList::addBoolOption
( (
"makeCellZones", "makeCellZones",
"place cells into cellZones instead of splitting mesh" "Place cells into cellZones instead of splitting mesh"
); );
argList::addBoolOption argList::addBoolOption
( (
"largestOnly", "largestOnly",
"only write largest region" "Only write largest region"
); );
argList::addOption argList::addOption
( (
"insidePoint", "insidePoint",
"point", "point",
"only write region containing point" "Only write region containing point"
); );
argList::addBoolOption argList::addBoolOption
( (
"detectOnly", "detectOnly",
"do not write mesh" "Do not write mesh"
); );
argList::addBoolOption argList::addBoolOption
( (
"sloppyCellZones", "sloppyCellZones",
"try to match heuristically regions to existing cell zones" "Try to match heuristically regions to existing cell zones"
); );
argList::addBoolOption argList::addBoolOption
( (
"useFaceZones", "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 argList::addBoolOption
( (
"prefixRegion", "prefixRegion",
"prefix region name to all patches, not just coupling patches" "Prefix region name to all patches, not just coupling patches"
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

@ -118,28 +118,28 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"integral", "integral",
"couple integral master/slave patches (2 argument mode: default)" "Couple integral master/slave patches (2 argument mode: default)"
); );
argList::addBoolOption argList::addBoolOption
( (
"partial", "partial",
"couple partially overlapping master/slave patches (2 argument mode)" "Couple partially overlapping master/slave patches (2 argument mode)"
); );
argList::addBoolOption argList::addBoolOption
( (
"perfect", "perfect",
"couple perfectly aligned master/slave patches (2 argument mode)" "Couple perfectly aligned master/slave patches (2 argument mode)"
); );
argList::addBoolOption argList::addBoolOption
( (
"intermediate", "intermediate",
"write intermediate stages, not just the final result" "Write intermediate stages, not just the final result"
); );
argList::addOption argList::addOption
( (
"toleranceDict", "toleranceDict",
"file", "file",
"dictionary file with tolerances" "Dictionary file with tolerances"
); );
// The arguments are non-mandatory when using dictionary mode // The arguments are non-mandatory when using dictionary mode

View File

@ -340,7 +340,7 @@ int main(int argc, char *argv[])
{ {
argList::addNote argList::addNote
( (
"select a mesh subset based on a cellSet" "Select a mesh subset based on a cellSet"
); );
#include "addOverwriteOption.H" #include "addOverwriteOption.H"
@ -350,21 +350,21 @@ int main(int argc, char *argv[])
( (
"patch", "patch",
"name", "name",
"add exposed internal faces to specified patch instead of to " "Add exposed internal faces to specified patch instead of to "
"'oldInternalFaces'" "'oldInternalFaces'"
); );
argList::addOption argList::addOption
( (
"patches", "patches",
"names", "names",
"add exposed internal faces to nearest of specified patches" "Add exposed internal faces to nearest of specified patches"
" instead of to 'oldInternalFaces'" " instead of to 'oldInternalFaces'"
); );
argList::addOption argList::addOption
( (
"resultTime", "resultTime",
"time", "time",
"specify a time for the resulting mesh" "Specify a time for the resulting mesh"
); );
#include "setRootCase.H" #include "setRootCase.H"
#include "createTime.H" #include "createTime.H"

View File

@ -210,7 +210,7 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"noSync", "noSync",
"do not synchronise selection across coupled patches" "Do not synchronise selection across coupled patches"
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

@ -261,13 +261,13 @@ void removeDict(dictionary& dict, const dictionary& dictToRemove)
int main(int argc, char *argv[]) int main(int argc, char *argv[])
{ {
argList::addNote("manipulates dictionaries"); argList::addNote("Manipulates dictionaries");
argList::noBanner(); argList::noBanner();
argList::noJobInfo(); argList::noJobInfo();
argList::addArgument("dictionary"); argList::addArgument("dictionary");
argList::addBoolOption("keywords", "List keywords"); 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 argList::addBoolOption
( (
"value", "value",
@ -288,7 +288,7 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"remove", "remove",
"Remove the entry." "Remove the entry"
); );
argList::addOption argList::addOption
( (

View File

@ -239,12 +239,12 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"noConstant", "noConstant",
"exclude the 'constant/' dir in the times list" "Exclude the 'constant/' dir in the times list"
); );
argList::addBoolOption argList::addBoolOption
( (
"enableFunctionEntries", "enableFunctionEntries",
"enable expansion of dictionary directives - #include, #codeStream etc" "Enable expansion of dictionary directives - #include, #codeStream etc"
); );
#include "addRegionOption.H" #include "addRegionOption.H"

View File

@ -66,17 +66,17 @@ void Foam::helpTypes::helpBoundary::init()
( (
"field", "field",
"word", "word",
"list available conditions for field" "List available conditions for field"
); );
argList::addBoolOption argList::addBoolOption
( (
"constraint", "constraint",
"list constraint patches" "List constraint patches"
); );
argList::addBoolOption argList::addBoolOption
( (
"fixedValue", "fixedValue",
"list fixed value patches (use with -field option)" "List fixed value patches (use with -field option)"
); );
} }

View File

@ -66,7 +66,7 @@ void Foam::helpTypes::helpSolver::init()
argList::addBoolOption argList::addBoolOption
( (
"read", "read",
"read solver type from the system/controlDict" "Read solver type from the system/controlDict"
); );
} }

View File

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

View File

@ -68,17 +68,17 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"processor", "processor",
"list times from processor0/ directory" "List times from processor0/ directory"
); );
argList::addBoolOption argList::addBoolOption
( (
"rm", "rm",
"remove selected time directories" "Remove selected time directories"
); );
argList::addBoolOption argList::addBoolOption
( (
"verbose", "verbose",
"report progress of -rm option" "Report progress of -rm option"
); );
profiling::disable(); // Disable profiling (and its output) profiling::disable(); // Disable profiling (and its output)

View File

@ -226,7 +226,7 @@ int main(int argc, char *argv[])
{ {
argList::addNote 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(); argList::noParallel();
@ -234,13 +234,13 @@ int main(int argc, char *argv[])
( (
"decomposeParDict", "decomposeParDict",
"file", "file",
"read decomposePar dictionary from specified location" "Use specified file for decomposePar dictionary"
); );
#include "addRegionOption.H" #include "addRegionOption.H"
argList::addBoolOption argList::addBoolOption
( (
"allRegions", "allRegions",
"operate on all regions in regionProperties" "Operate on all regions in regionProperties"
); );
argList::addBoolOption argList::addBoolOption
( (
@ -262,32 +262,32 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"copyZero", "copyZero",
"Copy a 0 directory to processor* rather than decompose the fields" "Copy 0/ directory to processor*/ rather than decompose the fields"
); );
argList::addBoolOption argList::addBoolOption
( (
"copyUniform", "copyUniform",
"copy any uniform/ directories too" "Copy any uniform/ directories too"
); );
argList::addBoolOption argList::addBoolOption
( (
"fields", "fields",
"use existing geometry decomposition and convert fields only" "Use existing geometry decomposition and convert fields only"
); );
argList::addBoolOption argList::addBoolOption
( (
"noSets", "noSets",
"skip decomposing cellSets, faceSets, pointSets" "Skip decomposing cellSets, faceSets, pointSets"
); );
argList::addBoolOption argList::addBoolOption
( (
"force", "force",
"remove existing processor*/ subdirs before decomposing the geometry" "Remove existing processor*/ subdirs before decomposing the geometry"
); );
argList::addBoolOption argList::addBoolOption
( (
"ifRequired", "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 // Include explicit constant options, have zero from time range

View File

@ -90,42 +90,42 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"allRegions", "allRegions",
"operate on all regions in regionProperties" "Operate on all regions in regionProperties"
); );
argList::addOption argList::addOption
( (
"fields", "fields",
"list", "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" "regular expressions not currently supported"
); );
argList::addBoolOption argList::addBoolOption
( (
"noFields", "noFields",
"skip reconstructing fields" "Skip reconstructing fields"
); );
argList::addOption argList::addOption
( (
"lagrangianFields", "lagrangianFields",
"list", "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, " "regular expressions not currently supported, "
"positions always included." "positions always included."
); );
argList::addBoolOption argList::addBoolOption
( (
"noLagrangian", "noLagrangian",
"skip reconstructing lagrangian positions and fields" "Skip reconstructing lagrangian positions and fields"
); );
argList::addBoolOption argList::addBoolOption
( (
"noSets", "noSets",
"skip reconstructing cellSets, faceSets, pointSets" "Skip reconstructing cellSets, faceSets, pointSets"
); );
argList::addBoolOption argList::addBoolOption
( (
"newTimes", "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" #include "setRootCase.H"

View File

@ -447,7 +447,7 @@ int main(int argc, char *argv[])
{ {
argList::addNote argList::addNote
( (
"reconstruct a mesh using geometric information only" "Reconstruct a mesh using geometric information only"
); );
// Enable -constant ... if someone really wants it // Enable -constant ... if someone really wants it
@ -458,18 +458,17 @@ int main(int argc, char *argv[])
( (
"mergeTol", "mergeTol",
"scalar", "scalar",
"specify the merge distance relative to the bounding box size " "The merge distance relative to the bounding box size (default 1e-7)"
"(default 1e-7)"
); );
argList::addBoolOption argList::addBoolOption
( (
"fullMatch", "fullMatch",
"do (slower) geometric matching on all boundary faces" "Do (slower) geometric matching on all boundary faces"
); );
argList::addBoolOption argList::addBoolOption
( (
"cellDist", "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." "decomposition method or as a volScalarField for post-processing."
); );

View File

@ -2255,25 +2255,24 @@ int main(int argc, char *argv[])
timeSelector::addOptions(true, true); timeSelector::addOptions(true, true);
#include "addRegionOption.H" #include "addRegionOption.H"
#include "addOverwriteOption.H" #include "addOverwriteOption.H"
argList::addBoolOption("decompose", "decompose case"); argList::addBoolOption("decompose", "Decompose case");
argList::addBoolOption("reconstruct", "reconstruct case"); argList::addBoolOption("reconstruct", "Reconstruct case");
argList::addOption argList::addOption
( (
"mergeTol", "mergeTol",
"scalar", "scalar",
"specify the merge distance relative to the bounding box size " "The merge distance relative to the bounding box size (default 1e-6)"
"(default 1e-6)"
); );
argList::addBoolOption argList::addBoolOption
( (
"cellDist", "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." "decomposition method or as a volScalarField for post-processing."
); );
argList::addBoolOption argList::addBoolOption
( (
"newTimes", "newTimes",
"only reconstruct new times (i.e. that do not exist already)" "Only reconstruct new times (i.e. that do not exist already)"
); );

View File

@ -107,59 +107,59 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"ascii", "ascii",
"write in ASCII format instead of 'C Binary'" "Write in ASCII format instead of 'C Binary'"
); );
argList::addBoolOption argList::addBoolOption
( (
"nodeValues", "nodeValues",
"write values in nodes" "Write values in nodes"
); );
argList::addBoolOption argList::addBoolOption
( (
"noLagrangian", "noLagrangian",
"suppress writing lagrangian positions and fields" "Suppress writing lagrangian positions and fields"
); );
argList::addBoolOption argList::addBoolOption
( (
"noPatches", "noPatches",
"suppress writing any patches" "Suppress writing any patches"
); );
argList::addOption argList::addOption
( (
"patches", "patches",
"wordRes", "wordRes",
"specify particular patches to write - eg '(outlet \"inlet.*\")'. " "Specify particular patches to write - eg '(outlet \"inlet.*\")'. "
"An empty list suppresses writing the internalMesh." "An empty list suppresses writing the internalMesh."
); );
argList::addOption argList::addOption
( (
"faceZones", "faceZones",
"wordRes", "wordRes",
"specify faceZones to write - eg '( slice \"mfp-.*\" )'." "Specify faceZones to write - eg '( slice \"mfp-.*\" )'."
); );
argList::addOption argList::addOption
( (
"fields", "fields",
"wordRes", "wordRes",
"specify fields to export (all by default) - eg '( \"U.*\" )'." "Specify fields to export (all by default) - eg '( \"U.*\" )'."
); );
argList::addOption argList::addOption
( (
"cellZone", "cellZone",
"word", "word",
"specify cellZone to write" "Specify cellZone to write"
); );
argList::addOption argList::addOption
( (
"name", "name",
"subdir", "subdir",
"sub-directory name for ensight output (default: 'EnSight')" "Sub-directory name for ensight output (default: 'EnSight')"
); );
argList::addOption argList::addOption
( (
"width", "width",
"n", "n",
"width of ensight data subdir" "Width of ensight data subdir"
); );
// The volume field types that we handle // The volume field types that we handle

View File

@ -100,37 +100,37 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"ascii", "ascii",
"write in ASCII format instead of 'C Binary'" "Write in ASCII format instead of 'C Binary'"
); );
argList::addOption argList::addOption
( (
"index", "index",
"start", "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" "and use simple indexing when creating the files"
); );
argList::addBoolOption argList::addBoolOption
( (
"noLagrangian", "noLagrangian",
"suppress writing lagrangian positions and fields" "Suppress writing lagrangian positions and fields"
); );
argList::addBoolOption argList::addBoolOption
( (
"noMesh", "noMesh",
"suppress writing the geometry. " "Suppress writing the geometry. "
"Can be useful for converting partial results for a static geometry" "Can be useful for converting partial results for a static geometry"
); );
argList::addOption argList::addOption
( (
"name", "name",
"subdir", "subdir",
"sub-directory name for ensight output (default: 'Ensight')" "Sub-directory name for ensight output (default: 'Ensight')"
); );
argList::addOption argList::addOption
( (
"width", "width",
"n", "n",
"width of Ensight data subdir" "Width of Ensight data subdir"
); );
// The volume field types that we handle // The volume field types that we handle

View File

@ -333,108 +333,108 @@ int main(int argc, char *argv[])
( (
"fields", "fields",
"wordList", "wordList",
"only convert the specified fields - eg '(p T U)'" "Only convert the specified fields - eg '(p T U)'"
); );
argList::addOption argList::addOption
( (
"cellSet", "cellSet",
"name", "name",
"convert a mesh subset corresponding to the specified cellSet" "Convert a mesh subset corresponding to the specified cellSet"
); );
argList::addOption argList::addOption
( (
"cellZone", "cellZone",
"name", "name",
"convert a mesh subset corresponding to the specified cellZone" "Convert a mesh subset corresponding to the specified cellZone"
); );
argList::addOption argList::addOption
( (
"faceSet", "faceSet",
"name", "name",
"restrict conversion to the specified faceSet" "Restrict conversion to the specified faceSet"
); );
argList::addOption argList::addOption
( (
"pointSet", "pointSet",
"name", "name",
"restrict conversion to the specified pointSet" "Restrict conversion to the specified pointSet"
); );
argList::addBoolOption argList::addBoolOption
( (
"ascii", "ascii",
"write in ASCII format instead of binary" "Write in ASCII format instead of binary"
); );
argList::addBoolOption argList::addBoolOption
( (
"xml", "xml",
"write VTK xml instead of legacy format" "Write VTK xml instead of legacy format"
); );
argList::addBoolOption argList::addBoolOption
( (
"poly", "poly",
"write polyhedral cells without tet/pyramid decomposition" "Write polyhedral cells without tet/pyramid decomposition"
); );
argList::addBoolOption argList::addBoolOption
( (
"surfaceFields", "surfaceFields",
"write surfaceScalarFields (e.g., phi)" "Write surfaceScalarFields (e.g., phi)"
); );
argList::addBoolOption argList::addBoolOption
( (
"finiteAreaFields", "finiteAreaFields",
"write finite area fields" "Write finite area fields"
); );
argList::addBoolOption argList::addBoolOption
( (
"nearCellValue", "nearCellValue",
"use cell value on patches instead of patch value itself" "Use cell value on patches instead of patch value itself"
); );
argList::addBoolOption argList::addBoolOption
( (
"noInternal", "noInternal",
"do not generate file for mesh, only for patches" "Do not generate file for mesh, only for patches"
); );
argList::addBoolOption argList::addBoolOption
( (
"noLagrangian", "noLagrangian",
"suppress writing lagrangian positions and fields" "Suppress writing lagrangian positions and fields"
); );
argList::addBoolOption argList::addBoolOption
( (
"noPointValues", "noPointValues",
"no pointFields" "No pointFields"
); );
argList::addBoolOption argList::addBoolOption
( (
"allPatches", "allPatches",
"combine all patches into a single file" "Combine all patches into a single file"
); );
argList::addOption argList::addOption
( (
"excludePatches", "excludePatches",
"wordRes", "wordRes",
"a list of patches to exclude - eg '( inlet \".*Wall\" )' " "A list of patches to exclude - eg '( inlet \".*Wall\" )' "
); );
argList::addBoolOption argList::addBoolOption
( (
"noFaceZones", "noFaceZones",
"no faceZones" "No faceZones"
); );
argList::addBoolOption argList::addBoolOption
( (
"noLinks", "noLinks",
"don't link processor VTK files - parallel only" "Do not link processor VTK files - parallel only"
); );
argList::addBoolOption argList::addBoolOption
( (
"useTimeName", "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 argList::addOption
( (
"name", "name",
"subdir", "subdir",
"sub-directory name for VTK output (default: 'VTK')" "Sub-directory name for VTK output (default: 'VTK')"
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

@ -88,7 +88,7 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"vtk", "vtk",
"create visualization files of the forces" "Create visualization files of the forces"
); );
timeSelector::addOptions(true, false); timeSelector::addOptions(true, false);

View File

@ -62,29 +62,29 @@ int main(int argc, char *argv[])
( (
"max", "max",
"N", "N",
"maximum number of outputs" "Maximum number of outputs"
); );
argList::addOption argList::addOption
( (
"span", "span",
"N", "N",
"increment each input by factor N (default: 1)" "Increment each input by factor N (default: 1)"
); );
argList::addOption argList::addOption
( (
"scale", "scale",
"factor", "factor",
"relaxation/scaling factor for movement (default: 1)" "Relaxation/scaling factor for movement (default: 1)"
); );
argList::addBoolOption argList::addBoolOption
( (
"removeLock", "removeLock",
"remove lock-file on termination of slave" "Remove lock-file on termination of slave"
); );
argList::addBoolOption argList::addBoolOption
( (
"slave", "slave",
"invoke as a slave responder for testing" "Invoke as a slave responder for testing"
); );
argList::addArgument("responseFile"); argList::addArgument("responseFile");

View File

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

View File

@ -194,20 +194,20 @@ int main(int argc, char *argv[])
( (
"fields", "fields",
"wordRes", "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'" " Eg, '(U T p \"Y.*\")' or a single field 'U'"
); );
argList::addOption argList::addOption
( (
"divisions", "divisions",
"integer", "integer",
"specify number of temporal sub-divisions to create (default = 1)." "Specify number of temporal sub-divisions to create (default = 1)."
); );
argList::addOption argList::addOption
( (
"interpolationType", "interpolationType",
"word", "word",
"specify type of interpolation (linear or spline)" "The type of interpolation (linear or spline)"
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

@ -273,7 +273,7 @@ int main(int argc, char *argv[])
{ {
argList::addNote 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." "turbulence fields based on the 1/7th power-law."
); );
@ -283,13 +283,13 @@ int main(int argc, char *argv[])
( (
"ybl", "ybl",
"scalar", "scalar",
"specify the boundary-layer thickness" "Specify the boundary-layer thickness"
); );
argList::addOption argList::addOption
( (
"Cbl", "Cbl",
"scalar", "scalar",
"boundary-layer thickness as Cbl * mean distance to wall" "Boundary-layer thickness as Cbl * mean distance to wall"
); );
argList::addBoolOption argList::addBoolOption
( (

View File

@ -399,13 +399,13 @@ int main(int argc, char *argv[])
( (
"subDict", "subDict",
"name", "name",
"specify the subDict name of the replacements dictionary" "Specify the subDict name of the replacements dictionary"
); );
argList::addOption argList::addOption
( (
"instance", "instance",
"name", "name",
"override instance setting (default is the time name)" "Override instance setting (default is the time name)"
); );
// Add explicit time option // Add explicit time option
@ -414,17 +414,17 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"literalRE", "literalRE",
"treat regular expressions literally (i.e., as a keyword)" "Treat regular expressions literally (i.e., as a keyword)"
); );
argList::addBoolOption argList::addBoolOption
( (
"enableFunctionEntries", "enableFunctionEntries",
"enable expansion of dictionary directives - #include, #codeStream etc" "Enable expansion of dictionary directives - #include, #codeStream etc"
); );
argList::addBoolOption argList::addBoolOption
( (
"disablePatchGroups", "disablePatchGroups",
"disable matching keys to patch groups" "Disable matching keys to patch groups"
); );
#include "addRegionOption.H" #include "addRegionOption.H"

View File

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

View File

@ -75,7 +75,7 @@ int main(int argc, char *argv[])
( (
"commsDir", "commsDir",
"dir", "dir",
"specify alternate communications directory. default is 'comms'" "Specify alternate communications directory (default is 'comms')"
); );
#include "setRootCase.H" #include "setRootCase.H"
#include "createTime.H" #include "createTime.H"

View File

@ -208,11 +208,11 @@ void createFieldFiles
// Main program: // Main program:
int main(int argc, char *argv[]) int main(int argc, char *argv[])
{ {
Foam::argList::addOption argList::addOption
( (
"templateDir", "templateDir",
"file", "file",
"read case set-up templates from specified location" "Read case set-up templates from specified location"
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

@ -399,12 +399,12 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"dry-run", "dry-run",
"test only do not change any files" "Test only do not change any files"
); );
argList::addBoolOption argList::addBoolOption
( (
"enableFunctionEntries", "enableFunctionEntries",
"enable expansion of dictionary directives - #include, #codeStream etc" "Enable expansion of dictionary directives - #include, #codeStream etc"
); );
#include "addRegionOption.H" #include "addRegionOption.H"

View File

@ -217,7 +217,7 @@ int main(int argc, char *argv[])
{ {
argList::addNote argList::addNote
( (
"map volume fields from one mesh to another" "Map volume fields from one mesh to another"
); );
argList::noParallel(); argList::noParallel();
argList::addArgument("sourceCase"); argList::addArgument("sourceCase");
@ -226,57 +226,57 @@ int main(int argc, char *argv[])
( (
"sourceTime", "sourceTime",
"scalar|'latestTime'", "scalar|'latestTime'",
"specify the source time" "Specify the source time"
); );
argList::addOption argList::addOption
( (
"sourceRegion", "sourceRegion",
"word", "word",
"specify the source region" "Specify the source region"
); );
argList::addOption argList::addOption
( (
"targetRegion", "targetRegion",
"word", "word",
"specify the target region" "Specify the target region"
); );
argList::addBoolOption argList::addBoolOption
( (
"parallelSource", "parallelSource",
"the source is decomposed" "The source is decomposed"
); );
argList::addBoolOption argList::addBoolOption
( (
"parallelTarget", "parallelTarget",
"the target is decomposed" "The target is decomposed"
); );
argList::addBoolOption argList::addBoolOption
( (
"consistent", "consistent",
"source and target geometry and boundary conditions identical" "Source and target geometry and boundary conditions identical"
); );
argList::addOption argList::addOption
( (
"mapMethod", "mapMethod",
"word", "word",
"specify the mapping method" "Specify the mapping method"
); );
argList::addBoolOption argList::addBoolOption
( (
"subtract", "subtract",
"subtract mapped source from target" "Subtract mapped source from target"
); );
argList::addOption argList::addOption
( (
"sourceDecomposeParDict", "sourceDecomposeParDict",
"file", "file",
"read decomposePar dictionary from specified location" "Read decomposePar dictionary from specified location"
); );
argList::addOption argList::addOption
( (
"targetDecomposeParDict", "targetDecomposeParDict",
"file", "file",
"read decomposePar dictionary from specified location" "Read decomposePar dictionary from specified location"
); );

View File

@ -140,7 +140,7 @@ int main(int argc, char *argv[])
{ {
argList::addNote argList::addNote
( (
"map volume fields from one mesh to another" "Map volume fields from one mesh to another"
); );
argList::addArgument("sourceCase"); argList::addArgument("sourceCase");
@ -149,60 +149,60 @@ int main(int argc, char *argv[])
( (
"sourceTime", "sourceTime",
"scalar|'latestTime'", "scalar|'latestTime'",
"specify the source time" "Specify the source time"
); );
argList::addOption argList::addOption
( (
"sourceRegion", "sourceRegion",
"word", "word",
"specify the source region" "Specify the source region"
); );
argList::addOption argList::addOption
( (
"targetRegion", "targetRegion",
"word", "word",
"specify the target region" "Specify the target region"
); );
argList::addBoolOption argList::addBoolOption
( (
"consistent", "consistent",
"source and target geometry and boundary conditions identical" "Source and target geometry and boundary conditions identical"
); );
argList::addOption argList::addOption
( (
"mapMethod", "mapMethod",
"word", "word",
"specify the mapping method " "Specify the mapping method "
"(direct|mapNearest|cellVolumeWeight|correctedCellVolumeWeight)" "(direct|mapNearest|cellVolumeWeight|correctedCellVolumeWeight)"
); );
argList::addOption argList::addOption
( (
"patchMapMethod", "patchMapMethod",
"word", "word",
"specify the patch mapping method (direct|mapNearest|faceAreaWeight)" "Specify the patch mapping method (direct|mapNearest|faceAreaWeight)"
); );
argList::addOption argList::addOption
( (
"procMapMethod", "procMapMethod",
"word", "word",
"specify the processor distribution map method (AABB|LOD)" "Specify the processor distribution map method (AABB|LOD)"
); );
argList::addBoolOption argList::addBoolOption
( (
"subtract", "subtract",
"subtract mapped source from target" "Subtract mapped source from target"
); );
argList::addOption argList::addOption
( (
"fields", "fields",
"list", "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" "regular expressions not currently supported"
); );
argList::addBoolOption argList::addBoolOption
( (
"noLagrangian", "noLagrangian",
"skip mapping lagrangian positions and fields" "Skip mapping lagrangian positions and fields"
); );
argList args(argc, argv); argList args(argc, argv);

View File

@ -51,7 +51,7 @@ int main(int argc, char *argv[])
{ {
argList::addNote argList::addNote
( (
"add two surfaces via a geometric merge on points." "Add two surfaces via a geometric merge on points."
); );
argList::noParallel(); argList::noParallel();
@ -63,18 +63,18 @@ int main(int argc, char *argv[])
( (
"points", "points",
"file", "file",
"provide additional points" "Provide additional points"
); );
argList::addBoolOption argList::addBoolOption
( (
"mergeRegions", "mergeRegions",
"combine regions from both surfaces" "Combine regions from both surfaces"
); );
argList::addOption argList::addOption
( (
"scale", "scale",
"factor", "factor",
"geometry scaling factor on input surfaces" "Geometry scaling factor on input surfaces"
); );
argList args(argc, argv); argList args(argc, argv);

View File

@ -1541,7 +1541,7 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"invertedSpace", "invertedSpace",
"do the surfaces have inverted space orientation, " "Do the surfaces have inverted space orientation, "
"i.e. a point at infinity is considered inside. " "i.e. a point at infinity is considered inside. "
"This is only sensible for union and intersection." "This is only sensible for union and intersection."
); );

View File

@ -322,36 +322,36 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"checkSelfIntersection", "checkSelfIntersection",
"also check for self-intersection" "Also check for self-intersection"
); );
argList::addBoolOption argList::addBoolOption
( (
"splitNonManifold", "splitNonManifold",
"split surface along non-manifold edges" "Split surface along non-manifold edges "
" (default split is fully disconnected)" "(default split is fully disconnected)"
); );
argList::addBoolOption argList::addBoolOption
( (
"verbose", "verbose",
"verbose operation" "Additional verbosity"
); );
argList::addBoolOption argList::addBoolOption
( (
"blockMesh", "blockMesh",
"write vertices/blocks for blockMeshDict" "Write vertices/blocks for blockMeshDict"
); );
argList::addOption argList::addOption
( (
"outputThreshold", "outputThreshold",
"number", "number",
"upper limit on the number of files written." "Upper limit on the number of files written. "
" Default is 10, using 0 suppresses file writing." "Default is 10, using 0 suppresses file writing."
); );
argList::addOption argList::addOption
( (
"writeSets", "writeSets",
"surfaceFormat", "surfaceFormat",
"reconstruct and write problem triangles/edges in selected format" "Reconstruct and write problem triangles/edges in selected format"
); );

View File

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

View File

@ -64,7 +64,7 @@ int main(int argc, char *argv[])
{ {
argList::addNote argList::addNote
( (
"convert between surface formats, using triSurface library components" "Convert between surface formats, using triSurface library components"
); );
argList::noParallel(); argList::noParallel();
@ -98,12 +98,11 @@ int main(int argc, char *argv[])
if (args.found("writePrecision")) 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); IOstream::defaultPrecision(prec);
Sout.precision(writePrecision); Sout.precision(prec);
Info<< "Output write precision set to " << writePrecision << endl;
} }
const fileName importName = args[1]; const fileName importName = args[1];

View File

@ -55,7 +55,7 @@ int main(int argc, char *argv[])
( (
"scale", "scale",
"factor", "factor",
"geometry scaling factor - default is 1" "Geometry scaling factor - default is 1"
); );
argList args(argc, argv); argList args(argc, argv);

View File

@ -216,7 +216,7 @@ int main(int argc, char *argv[])
( (
"dict", "dict",
"file", "file",
"read surfaceFeatureExtractDict from specified location" "Read surfaceFeatureExtractDict from specified location"
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

@ -271,7 +271,7 @@ int main(int argc, char *argv[])
{ {
argList::addNote 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" "boundary edges to match other surface boundary edges"
); );
argList::noParallel(); argList::noParallel();

View File

@ -64,7 +64,7 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"shellProperties", "shellProperties",
"inertia of a thin shell" "Inertia of a thin shell"
); );
argList::addOption argList::addOption

View File

@ -571,30 +571,30 @@ int main(int argc, char *argv[])
argList::noParallel(); argList::noParallel();
argList::addNote argList::addNote
( (
"Creates inflated version of surface using point normals." "Creates inflated version of surface using point normals. "
" Takes surface, distance to inflate and additional safety factor" "Takes surface, distance to inflate and additional safety factor"
); );
argList::addBoolOption argList::addBoolOption
( (
"checkSelfIntersection", "checkSelfIntersection",
"also check for self-intersection" "Also check for self-intersection"
); );
argList::addOption argList::addOption
( (
"nSmooth", "nSmooth",
"integer", "integer",
"number of smoothing iterations (default 20)" "Number of smoothing iterations (default 20)"
); );
argList::addOption argList::addOption
( (
"featureAngle", "featureAngle",
"scalar", "scalar",
"feature angle" "Feature angle"
); );
argList::addBoolOption argList::addBoolOption
( (
"debug", "debug",
"switch on additional debug information" "Switch on additional debug information"
); );
argList::addArgument("inputFile"); argList::addArgument("inputFile");

View File

@ -141,7 +141,7 @@ int main(int argc, char *argv[])
argList::addOption argList::addOption
( (
"featureFile", "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); argList args(argc, argv);

View File

@ -85,37 +85,39 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"clean", "clean",
"perform some surface checking/cleanup on the input surface" "Perform some surface checking/cleanup on the input surface"
); );
argList::addOption argList::addOption
( (
"scaleIn", "scaleIn",
"factor", "factor",
"geometry scaling factor on input" "Geometry scaling factor on input"
); );
argList::addOption argList::addOption
( (
"scaleOut", "scaleOut",
"factor", "factor",
"geometry scaling factor on output" "Geometry scaling factor on output"
); );
#include "addDictOption.H" #include "addDictOption.H"
argList::addOption argList::addOption
( (
"from", "from",
"system", "system",
"specify the source coordinate system, applied after '-scaleIn'" "Specify the source coordinate system, applied after '-scaleIn'",
true // advanced
); );
argList::addOption argList::addOption
( (
"to", "to",
"system", "system",
"specify the target coordinate system, applied before '-scaleOut'" "Specify the target coordinate system, applied before '-scaleOut'",
true // advanced
); );
argList::addBoolOption argList::addBoolOption
( (
"tri", "tri",
"triangulate surface" "Triangulate surface"
); );

View File

@ -76,7 +76,7 @@ int main(int argc, char *argv[])
{ {
argList::addNote argList::addNote
( (
"export from surfMesh to various third-party surface formats" "Export from surfMesh to various third-party surface formats"
); );
argList::noParallel(); argList::noParallel();
@ -85,39 +85,41 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"clean", "clean",
"perform some surface checking/cleanup on the input surface" "Perform some surface checking/cleanup on the input surface"
); );
argList::addOption argList::addOption
( (
"name", "name",
"name", "name",
"specify an alternative surface name when reading - " "Specify an alternative surface name when reading - "
"default is 'default'" "default is 'default'"
); );
argList::addOption argList::addOption
( (
"scaleIn", "scaleIn",
"factor", "factor",
"geometry scaling factor on input - default is 1" "Geometry scaling factor on input - default is 1"
); );
argList::addOption argList::addOption
( (
"scaleOut", "scaleOut",
"factor", "factor",
"geometry scaling factor on output - default is 1" "Geometry scaling factor on output - default is 1"
); );
#include "addDictOption.H" #include "addDictOption.H"
argList::addOption argList::addOption
( (
"from", "from",
"coordinateSystem", "coordinateSystem",
"specify the source coordinate system, applied after '-scaleIn'" "Specify the source coordinate system, applied after '-scaleIn'",
true // advanced
); );
argList::addOption argList::addOption
( (
"to", "to",
"coordinateSystem", "coordinateSystem",
"specify the target coordinate system, applied before '-scaleOut'" "Specify the target coordinate system, applied before '-scaleOut'",
true // advanced
); );
argList args(argc, argv); argList args(argc, argv);

View File

@ -76,7 +76,7 @@ int main(int argc, char *argv[])
{ {
argList::addNote argList::addNote
( (
"import from various third-party surface formats into surfMesh" "Import from various third-party surface formats into surfMesh"
); );
argList::noParallel(); argList::noParallel();
@ -85,39 +85,41 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"clean", "clean",
"perform some surface checking/cleanup on the input surface" "Perform some surface checking/cleanup on the input surface"
); );
argList::addOption argList::addOption
( (
"name", "name",
"name", "name",
"specify an alternative surface name when writing - " "Specify an alternative surface name when writing - "
"default is 'default'" "default is 'default'"
); );
argList::addOption argList::addOption
( (
"scaleIn", "scaleIn",
"factor", "factor",
"geometry scaling factor on input - default is 1" "Geometry scaling factor on input - default is 1"
); );
argList::addOption argList::addOption
( (
"scaleOut", "scaleOut",
"factor", "factor",
"geometry scaling factor on output - default is 1" "Geometry scaling factor on output - default is 1"
); );
#include "addDictOption.H" #include "addDictOption.H"
argList::addOption argList::addOption
( (
"from", "from",
"coordinateSystem", "coordinateSystem",
"specify a local coordinate system when reading files." "Specify a local coordinate system when reading files.",
true // advanced
); );
argList::addOption argList::addOption
( (
"to", "to",
"coordinateSystem", "coordinateSystem",
"specify a local coordinate system when writing files." "Specify a local coordinate system when writing files.",
true // advanced
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

@ -76,7 +76,7 @@ int main(int argc, char *argv[])
{ {
argList::addNote argList::addNote
( (
"information about surface meshes" "Information about surface meshes"
); );
argList::noBanner(); argList::noBanner();
@ -87,17 +87,17 @@ int main(int argc, char *argv[])
( (
"scale", "scale",
"factor", "factor",
"input geometry scaling factor" "Input geometry scaling factor"
); );
argList::addBoolOption argList::addBoolOption
( (
"areas", "areas",
"display area of each face" "Display area of each face"
); );
argList::addBoolOption argList::addBoolOption
( (
"xml", "xml",
"write output in XML format" "Write output in XML format"
); );
profiling::disable(); // Disable profiling (and its output) profiling::disable(); // Disable profiling (and its output)

View File

@ -62,7 +62,7 @@ int main(int argc, char *argv[])
{ {
argList::addNote argList::addNote
( (
"extract surface from a polyMesh" "Extract surface from a polyMesh"
); );
timeSelector::addOptions(); timeSelector::addOptions();
@ -71,19 +71,19 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"excludeProcPatches", "excludeProcPatches",
"exclude processor patches" "Exclude processor patches"
); );
argList::addOption argList::addOption
( (
"patches", "patches",
"(patch0 .. patchN)", "(patch0 .. patchN)",
"only triangulate selected patches (wildcards supported)" "Only triangulate selected patches (wildcards supported)"
); );
argList::addOption argList::addOption
( (
"faceZones", "faceZones",
"(fz0 .. fzN)", "(fz0 .. fzN)",
"triangulate selected faceZones (wildcards supported)" "Triangulate selected faceZones (wildcards supported)"
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

@ -46,7 +46,7 @@ int main(int argc, char *argv[])
{ {
argList::addNote argList::addNote
( (
"set face normals consistent with a user-provided 'outside' point" "Set face normals consistent with a user-provided 'outside' point"
); );
argList::noParallel(); argList::noParallel();
@ -56,18 +56,18 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"inside", "inside",
"treat provided point as being inside" "Treat provided point as being inside"
); );
argList::addBoolOption argList::addBoolOption
( (
"usePierceTest", "usePierceTest",
"determine orientation by counting number of intersections" "Determine orientation by counting number of intersections"
); );
argList::addOption argList::addOption
( (
"scale", "scale",
"factor", "factor",
"input geometry scaling factor" "Input geometry scaling factor"
); );
argList args(argc, argv); argList args(argc, argv);

View File

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

View File

@ -114,7 +114,7 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"keepNonMapped", "keepNonMapped",
"preserve surface outside of mesh bounds" "Preserve surface outside of mesh bounds"
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

@ -43,7 +43,7 @@ int main(int argc, char *argv[])
{ {
argList::addNote argList::addNote
( (
"write surface mesh regions to separate files" "Write surface mesh regions to separate files"
); );
argList::noParallel(); argList::noParallel();

View File

@ -672,7 +672,7 @@ int main(int argc, char *argv[])
{ {
argList::addNote argList::addNote
( (
"split multiply connected surface edges by duplicating points" "Split multiply connected surface edges by duplicating points"
); );
argList::noParallel(); argList::noParallel();
argList::addArgument("surfaceFile"); argList::addArgument("surfaceFile");
@ -680,7 +680,7 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"debug", "debug",
"add debugging output" "Add debugging output"
); );
argList args(argc, argv); argList args(argc, argv);

View File

@ -171,7 +171,7 @@ int main(int argc, char *argv[])
{ {
argList::addNote argList::addNote
( (
"reads surface and applies surface regioning to a mesh" "Reads surface and applies surface regioning to a mesh"
); );
argList::noParallel(); argList::noParallel();
@ -180,13 +180,13 @@ int main(int argc, char *argv[])
( (
"faceSet", "faceSet",
"name", "name",
"only repatch the faces in specified faceSet" "Only repatch the faces in specified faceSet"
); );
argList::addOption argList::addOption
( (
"tol", "tol",
"scalar", "scalar",
"search tolerance as fraction of mesh size (default 1e-3)" "Search tolerance as fraction of mesh size (default 1e-3)"
); );
#include "setRootCase.H" #include "setRootCase.H"

View File

@ -63,7 +63,7 @@ int main(int argc, char *argv[])
argList::addBoolOption argList::addBoolOption
( (
"newFormat", "newFormat",
"read Chemkin thermo file in new format" "Read Chemkin thermo file in new format"
); );
argList args(argc, argv); argList args(argc, argv);

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_[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_[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_[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_[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_[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" _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_[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_[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_[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_[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_[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" _of_complete_cache_[gambitToFoam]="-case -fileHandler -scale | -noFunctionObjects -doc -doc-source -help -help-full"

View File

@ -116,7 +116,7 @@ void Foam::timeSelector::addOptions
argList::addBoolOption argList::addBoolOption
( (
"constant", "constant",
"include the 'constant/' dir in the times list" "Include the 'constant/' dir in the times list"
); );
} }
if (withZero) if (withZero)
@ -124,13 +124,13 @@ void Foam::timeSelector::addOptions
argList::addBoolOption argList::addBoolOption
( (
"withZero", "withZero",
"include the '0/' dir in the times list" "Include the '0/' dir in the times list"
); );
} }
argList::addBoolOption argList::addBoolOption
( (
"noZero", "noZero",
string("exclude the '0/' dir from the times list") string("Exclude the '0/' dir from the times list")
+ ( + (
withZero withZero
? ", has precedence over the -withZero option" ? ", has precedence over the -withZero option"
@ -140,18 +140,18 @@ void Foam::timeSelector::addOptions
argList::addBoolOption argList::addBoolOption
( (
"latestTime", "latestTime",
"select the latest time" "Select the latest time"
); );
argList::addBoolOption argList::addBoolOption
( (
"newTimes", "newTimes",
"select the new times" "Select the new times"
); );
argList::addOption argList::addOption
( (
"time", "time",
"ranges", "ranges",
"comma-separated time ranges - eg, ':10,20,40:70,1000:'" "Comma-separated time ranges - eg, ':10,20,40:70,1000:'"
); );
} }

View File

@ -68,41 +68,43 @@ Foam::argList::initValidTables::initValidTables()
argList::addOption argList::addOption
( (
"case", "dir", "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", ""); validParOptions.set("parallel", "");
argList::addOption argList::addOption
( (
"roots", "(dir1 .. dirN)", "roots", "(dir1 .. dirN)",
"slave root directories for distributed running" "Slave root directories for distributed running",
true // advanced option
); );
validParOptions.set("roots", "(dir1 .. dirN)"); validParOptions.set("roots", "(dir1 .. dirN)");
argList::addOption argList::addOption
( (
"decomposeParDict", "file", "decomposeParDict", "file",
"read decomposePar dictionary from specified location" "Use specified file for decomposePar dictionary"
); );
argList::addOption argList::addOption
( (
"hostRoots", "(((host1 dir1) .. (hostN dirN))", "hostRoots", "(((host1 dir1) .. (hostN dirN))",
"slave root directories (per host) for distributed running. " "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))"); validParOptions.set("hostRoots", "((host1 dir1) .. (hostN dirN))");
argList::addBoolOption argList::addBoolOption
( (
"noFunctionObjects", "noFunctionObjects",
"do not execute function objects" "Do not execute function objects"
); );
argList::addOption argList::addOption
( (
"fileHandler", "fileHandler", "handler",
"handler", "Override the file handler type",
"override the file handler type" true // advanced option
); );
// Some standard option aliases (with or without version warnings) // Some standard option aliases (with or without version warnings)
@ -369,7 +371,7 @@ void Foam::argList::noLibs()
addBoolOption addBoolOption
( (
"no-libs", "no-libs",
"disable use of the controlDict libs entry", "Disable use of the controlDict libs entry",
true // advanced true // advanced
); );
} }
@ -894,27 +896,15 @@ void Foam::argList::parse
) )
{ {
// Help/documentation options: // Help/documentation options:
// -help print the usage // -doc Display documentation in browser
// -help-full print the full usage // -doc-source Display source code in browser
// -doc display application documentation in browser // -help Display short help and exit
// -doc-source display source code in browser // -help-compat Display compatibility options
// -list-compat print compatibility information // -help-full Display full help and exit
{ {
bool quickExit = false; bool quickExit = false;
// Only display one or the other // Display either application or source documentation, not both
if (options_.found("help-full"))
{
printUsage(true);
quickExit = true;
}
else if (options_.found("help"))
{
printUsage(false);
quickExit = true;
}
// Only display one or the other
if (options_.found("doc")) if (options_.found("doc"))
{ {
displayDoc(false); displayDoc(false);
@ -930,7 +920,20 @@ void Foam::argList::parse
quickExit = true; 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(); printCompat();
quickExit = true; quickExit = true;
@ -1613,16 +1616,28 @@ void Foam::argList::printUsage(bool full) const
} }
// Place documentation/help options at the end // Place documentation/help options at the end
Info<< " -doc"; Info<< " -doc";
printOptionUsage(6, "display application documentation in browser"); printOptionUsage(6, "Display documentation in browser");
Info<< " -doc-source"; Info<< " -doc-source";
printOptionUsage(13, "display source code in browser" ); printOptionUsage(13, "Display source code in browser" );
Info<< " -help"; 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"; Info<< " -help-full";
printOptionUsage(12, "print full usage information and exit"); printOptionUsage(12, "Display full help and exit");
printNotes(); printNotes();

View File

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

View File

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

View File

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

View File

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