Commit cb919a6c authored by Mark Olesen's avatar Mark Olesen
Browse files

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
parent d40103a8
......@@ -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"
......
......@@ -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"
......
......@@ -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)"
);
......
......@@ -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"
);
......
......@@ -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"
......
......@@ -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"
......
......@@ -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);
......
......@@ -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);
......
......@@ -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"
......
......@@ -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);
......
......@@ -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)"
);
......
......@@ -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);
......
......@@ -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);
......
......@@ -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"
......
......@@ -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"
......
......@@ -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"
......
......@@ -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);
......
......@@ -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"
......
......@@ -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"
......
......@@ -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"
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment