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

@ -273,7 +273,7 @@ int main(int argc, char *argv[])
{
argList::addNote
(
"apply a simplified boundary-layer model to the velocity and\n"
"Apply a simplified boundary-layer model to the velocity and\n"
"turbulence fields based on the 1/7th power-law."
);
@ -283,13 +283,13 @@ int main(int argc, char *argv[])
(
"ybl",
"scalar",
"specify the boundary-layer thickness"
"Specify the boundary-layer thickness"
);
argList::addOption
(
"Cbl",
"scalar",
"boundary-layer thickness as Cbl * mean distance to wall"
"Boundary-layer thickness as Cbl * mean distance to wall"
);
argList::addBoolOption
(

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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