mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
ENH: support usage descriptions for command arguments
This commit is contained in:
@ -83,7 +83,7 @@ int main(int argc, char *argv[])
|
||||
argList::noParallel();
|
||||
argList::noFunctionObjects(); // Never use function objects
|
||||
|
||||
argList::addArgument("feature angle[0-180]");
|
||||
argList::addArgument("featureAngle", "in degrees [0-180]");
|
||||
|
||||
#include "setRootCase.H"
|
||||
#include "createTime.H"
|
||||
|
||||
@ -50,7 +50,7 @@ int main(int argc, char *argv[])
|
||||
" supplied as an argument"
|
||||
);
|
||||
|
||||
argList::addArgument("scaling factor");
|
||||
argList::addArgument("factor", "The deformation scaling factor");
|
||||
|
||||
#include "setRootCase.H"
|
||||
|
||||
|
||||
@ -116,8 +116,8 @@ int main(int argc, char *argv[])
|
||||
);
|
||||
|
||||
argList::noParallel();
|
||||
argList::addArgument("OBJ file");
|
||||
argList::addArgument("output VTK file");
|
||||
argList::addArgument("obj-file", "The input obj line file");
|
||||
argList::addArgument("vtk-file", "The output vtk file");
|
||||
argList args(argc, argv);
|
||||
|
||||
const fileName objName = args[1];
|
||||
|
||||
@ -28,7 +28,7 @@ Group
|
||||
grpMeshManipulationUtilities
|
||||
|
||||
Description
|
||||
Corrects teh orientation of faceZone.
|
||||
Corrects the orientation of faceZone.
|
||||
|
||||
- correct in parallel - excludes coupled faceZones from walk
|
||||
- correct for non-manifold faceZones - restarts walk
|
||||
@ -55,7 +55,7 @@ int main(int argc, char *argv[])
|
||||
);
|
||||
#include "addRegionOption.H"
|
||||
argList::addArgument("faceZone");
|
||||
argList::addArgument("outsidePoint");
|
||||
argList::addArgument("point", "A point outside of the mesh");
|
||||
|
||||
#include "setRootCase.H"
|
||||
#include "createTime.H"
|
||||
|
||||
@ -368,7 +368,12 @@ int main(int argc, char *argv[])
|
||||
#include "addOverwriteOption.H"
|
||||
argList::noParallel();
|
||||
|
||||
argList::addArgument("featureAngle [0-180]");
|
||||
argList::addArgument
|
||||
(
|
||||
"featureAngle",
|
||||
"in degrees [0-180]"
|
||||
);
|
||||
|
||||
argList::addBoolOption
|
||||
(
|
||||
"splitAllFaces",
|
||||
|
||||
@ -72,13 +72,13 @@ int main(int argc, char *argv[])
|
||||
argList::addNote
|
||||
(
|
||||
"Rotate mesh points and vector/tensor fields\n"
|
||||
"Rotation from the <n1> vector to the <n2> vector"
|
||||
"Rotation from the <from> vector to the <to> vector"
|
||||
);
|
||||
|
||||
timeSelector::addOptions();
|
||||
|
||||
argList::addArgument("n1");
|
||||
argList::addArgument("n2");
|
||||
argList::addArgument("from", "The vector to rotate from");
|
||||
argList::addArgument("to", "The vector to rotate to");
|
||||
|
||||
#include "setRootCase.H"
|
||||
#include "createTime.H"
|
||||
|
||||
@ -123,9 +123,9 @@ int main(int argc, char *argv[])
|
||||
|
||||
#include "addOverwriteOption.H"
|
||||
|
||||
argList::addArgument("faceSet");
|
||||
argList::addArgument("masterPatch");
|
||||
argList::addArgument("slavePatch");
|
||||
argList::addArgument("faceSet", "The faces used for splitting");
|
||||
argList::addArgument("master", "The master patch name");
|
||||
argList::addArgument("slave", "The slave patch name");
|
||||
|
||||
#include "setRootCase.H"
|
||||
#include "createTime.H"
|
||||
|
||||
@ -145,8 +145,16 @@ int main(int argc, char *argv[])
|
||||
);
|
||||
|
||||
// The arguments are non-mandatory when using dictionary mode
|
||||
argList::addArgument("masterPatch");
|
||||
argList::addArgument("slavePatch");
|
||||
argList::addArgument
|
||||
(
|
||||
"master",
|
||||
"The master patch name (non-dictionary mode)"
|
||||
);
|
||||
argList::addArgument
|
||||
(
|
||||
"slave",
|
||||
"The slave patch name (non-dictionary mode)"
|
||||
);
|
||||
|
||||
#include "setRootCaseNonMandatoryArgs.H"
|
||||
|
||||
|
||||
Reference in New Issue
Block a user