Use argList::addOption, argList::addBoolOption (almost) everywhere

- ensure that the standard options (eg, from timeSelector) also have
  some usage information
This commit is contained in:
Mark Olesen
2009-12-03 13:32:12 +01:00
parent ca7acea5f4
commit 58b7e64185
93 changed files with 369 additions and 287 deletions

View File

@ -454,7 +454,7 @@ label simplifyFaces
int main(int argc, char *argv[])
{
argList::noParallel();
argList::validOptions.insert("overwrite", "");
argList::addBoolOption("overwrite");
argList::validArgs.append("edge length [m]");
argList::validArgs.append("merge angle (degrees)");

View File

@ -429,9 +429,9 @@ label mergeEdges(const scalar minCos, polyMesh& mesh)
int main(int argc, char *argv[])
{
argList::validArgs.append("feature angle [0..180]");
argList::validOptions.insert("concaveAngle", "[0..180]");
argList::validOptions.insert("snapMesh", "");
argList::validOptions.insert("overwrite", "");
argList::addOption("concaveAngle", "[0..180]");
argList::addBoolOption("snapMesh");
argList::addBoolOption("overwrite");
# include "setRootCase.H"
# include "createTime.H"

View File

@ -328,7 +328,7 @@ label findCell(const primitiveMesh& mesh, const point& nearPoint)
int main(int argc, char *argv[])
{
argList::validOptions.insert("overwrite", "");
argList::addBoolOption("overwrite");
# include "setRootCase.H"
# include "createTime.H"

View File

@ -52,7 +52,7 @@ using namespace Foam;
// Main program:
int main(int argc, char *argv[])
{
argList::validOptions.insert("overwrite", "");
argList::addBoolOption("overwrite");
argList::validArgs.append("cellSet");
# include "setRootCase.H"
# include "createTime.H"

View File

@ -47,11 +47,12 @@ using namespace Foam;
int main(int argc, char *argv[])
{
Foam::argList::noParallel();
Foam::argList::validArgs.append("patchName");
Foam::argList::validArgs.append("edgeWeight");
Foam::argList::validOptions.insert("useSet", "cellSet");
Foam::argList::validOptions.insert("overwrite", "");
argList::noParallel();
argList::validArgs.append("patchName");
argList::validArgs.append("edgeWeight");
argList::addOption("useSet", "cellSet");
argList::addBoolOption("overwrite");
# include "setRootCase.H"
# include "createTime.H"

View File

@ -97,7 +97,7 @@ bool limitRefinementLevel
int main(int argc, char *argv[])
{
argList::validOptions.insert("readLevel", "");
argList::addBoolOption("readLevel");
# include "setRootCase.H"
# include "createTime.H"

View File

@ -48,8 +48,8 @@ using namespace Foam;
int main(int argc, char *argv[])
{
Foam::argList::validOptions.insert("overwrite", "");
Foam::argList::validArgs.append("faceSet");
argList::addBoolOption("overwrite");
argList::validArgs.append("faceSet");
# include "setRootCase.H"
# include "createTime.H"

View File

@ -525,10 +525,10 @@ void collectCuts
int main(int argc, char *argv[])
{
argList::noParallel();
argList::validOptions.insert("set", "cellSet name");
argList::validOptions.insert("geometry", "");
argList::validOptions.insert("tol", "edge snap tolerance");
argList::validOptions.insert("overwrite", "");
argList::addOption("set", "cellSet name");
argList::addBoolOption("geometry");
argList::addOption("tol", "edge snap tolerance");
argList::addBoolOption("overwrite");
argList::validArgs.append("edge angle [0..360]");
# include "setRootCase.H"

View File

@ -238,7 +238,7 @@ int main(int argc, char *argv[])
{
argList::noParallel();
argList::validArgs.append("ANSYS input file");
argList::validOptions.insert("scale", "scale factor");
argList::addOption("scale", "scale factor");
argList args(argc, argv);

View File

@ -50,7 +50,7 @@ int main(int argc, char *argv[])
{
argList::noParallel();
argList::validArgs.append("CFX geom file");
argList::validOptions.insert("scale", "scale factor");
argList::addOption("scale", "scale factor");
argList args(argc, argv);

View File

@ -762,10 +762,10 @@ int main(int argc, char *argv[])
{
argList::noParallel();
argList::validArgs.append("Fluent mesh file");
argList::validOptions.insert("scale", "scale factor");
argList::validOptions.insert("ignoreCellGroups", "cell group names");
argList::validOptions.insert("ignoreFaceGroups", "face group names");
argList::validOptions.insert("cubit", "");
argList::addOption("scale", "scale factor");
argList::addOption("ignoreCellGroups", "cell group names");
argList::addOption("ignoreFaceGroups", "face group names");
argList::addBoolOption("cubit");
argList args(argc, argv);

View File

@ -867,9 +867,9 @@ int main(int argc, char *argv[])
{
argList::noParallel();
argList::validArgs.append("Fluent mesh file");
argList::validOptions.insert("scale", "scale factor");
argList::validOptions.insert("writeSets", "");
argList::validOptions.insert("writeZones", "");
argList::addOption("scale", "scale factor");
argList::addBoolOption("writeSets");
argList::addBoolOption("writeZones");
argList args(argc, argv);

View File

@ -76,10 +76,10 @@ int main(int argc, char *argv[])
argList::noParallel();
timeSelector::addOptions();
argList::validOptions.insert("scale", "scale");
argList::validOptions.insert("noBnd", "");
argList::validOptions.insert("tri", "");
argList::validOptions.insert("surface", "");
argList::addOption("scale", "scale");
argList::addBoolOption("noBnd");
argList::addBoolOption("tri");
argList::addBoolOption("surface");
# include "setRootCase.H"
# include "createTime.H"

View File

@ -639,7 +639,7 @@ int main(int argc, char *argv[])
{
argList::noParallel();
argList::validArgs.append("GAMBIT file");
argList::validOptions.insert("scale", "scale factor");
argList::addOption("scale", "scale factor");
argList args(argc, argv);

View File

@ -717,7 +717,7 @@ int main(int argc, char *argv[])
{
argList::noParallel();
argList::validArgs.append(".msh file");
argList::validOptions.insert("keepOrientation", "");
argList::addBoolOption("keepOrientation");
# include "setRootCase.H"
# include "createTime.H"

View File

@ -579,7 +579,7 @@ int main(int argc, char *argv[])
{
argList::noParallel();
argList::validArgs.append(".unv file");
argList::validOptions.insert("dump", "");
argList::addBoolOption("dump");
# include "setRootCase.H"
# include "createTime.H"

View File

@ -60,9 +60,9 @@ enum kivaVersions
int main(int argc, char *argv[])
{
argList::noParallel();
argList::validOptions.insert("file", "fileName");
argList::validOptions.insert("version", "[kiva3|kiva3v]");
argList::validOptions.insert("zHeadMin", "scalar");
argList::addOption("file", "fileName");
argList::addOption("version", "[kiva3|kiva3v]");
argList::addOption("zHeadMin", "scalar");
# include "setRootCase.H"
# include "createTime.H"

View File

@ -57,7 +57,7 @@ int main(int argc, char *argv[])
{
argList::noParallel();
argList::validArgs.append(".msh file");
argList::validOptions.insert("hex", "");
argList::addBoolOption("hex");
# include "setRootCase.H"
# include "createTime.H"

View File

@ -58,10 +58,10 @@ int main(int argc, char *argv[])
{
argList::noParallel();
argList::validArgs.append("PLOT3D geom file");
argList::validOptions.insert("scale", "scale factor");
argList::validOptions.insert("noBlank", "");
argList::validOptions.insert("singleBlock", "");
argList::validOptions.insert("2D", "thickness");
argList::addOption("scale", "scale factor");
argList::addBoolOption("noBlank");
argList::addBoolOption("singleBlock");
argList::addOption("2D", "thickness");
argList args(argc, argv);

View File

@ -357,10 +357,10 @@ int main(int argc, char *argv[])
timeSelector::addOptions(true, false);
argList::validArgs.append("feature angle[0-180]");
argList::validOptions.insert("splitAllFaces", "");
argList::validOptions.insert("concaveMultiCells", "");
argList::validOptions.insert("doNotPreserveFaceZones", "");
argList::validOptions.insert("overwrite", "");
argList::addBoolOption("splitAllFaces");
argList::addBoolOption("concaveMultiCells");
argList::addBoolOption("doNotPreserveFaceZones");
argList::addBoolOption("overwrite");
# include "setRootCase.H"
# include "createTime.H"

View File

@ -41,7 +41,7 @@ int main(int argc, char *argv[])
{
argList::noParallel();
argList::validArgs.append("SAMM mesh file prefix");
argList::validOptions.insert("scale", "scale factor");
argList::addOption("scale", "scale factor");
argList args(argc, argv);

View File

@ -62,9 +62,9 @@ int main(int argc, char *argv[])
{
argList::noParallel();
argList::validArgs.append("pro-STAR prefix");
argList::validOptions.insert("ascii", "");
argList::validOptions.insert("scale", "scale");
argList::validOptions.insert("solids", "");
argList::addBoolOption("ascii");
argList::addOption("scale", "scale");
argList::addBoolOption("solids");
argList args(argc, argv);
Time runTime(args.rootPath(), args.caseName());

View File

@ -41,7 +41,7 @@ int main(int argc, char *argv[])
{
argList::noParallel();
argList::validArgs.append("STAR mesh file prefix");
argList::validOptions.insert("scale", "scale factor");
argList::addOption("scale", "scale factor");
argList args(argc, argv);

View File

@ -98,7 +98,7 @@ label findFace(const primitiveMesh& mesh, const face& f)
int main(int argc, char *argv[])
{
argList::validArgs.append("file prefix");
argList::validOptions.insert("noFaceFile", "");
argList::addBoolOption("noFaceFile");
# include "setRootCase.H"
# include "createTime.H"

View File

@ -378,13 +378,13 @@ void writePointCells
int main(int argc, char *argv[])
{
timeSelector::addOptions();
argList::validOptions.insert("patchFaces", "");
argList::validOptions.insert("patchEdges", "");
argList::validOptions.insert("cell", "cellI");
argList::validOptions.insert("face", "faceI");
argList::validOptions.insert("point", "pointI");
argList::validOptions.insert("cellSet", "setName");
argList::validOptions.insert("faceSet", "setName");
argList::addBoolOption("patchFaces");
argList::addBoolOption("patchEdges");
argList::addOption("cell", "cellI");
argList::addOption("face", "faceI");
argList::addOption("point", "pointI");
argList::addOption("cellSet", "setName");
argList::addOption("faceSet", "setName");
# include "addRegionOption.H"
# include "setRootCase.H"

View File

@ -72,8 +72,8 @@ using namespace Foam;
int main(int argc, char *argv[])
{
argList::noParallel();
argList::validOptions.insert("blockTopology", "");
argList::validOptions.insert("dict", "dictionary");
argList::addBoolOption("blockTopology");
argList::addOption("dict", "dictionary");
# include "addRegionOption.H"
# include "setRootCase.H"
# include "createTime.H"

View File

@ -58,7 +58,7 @@ using namespace Foam;
int main(int argc, char *argv[])
{
argList::validArgs.append("thickness");
argList::validOptions.insert("overwrite", "");
argList::addBoolOption("overwrite");
# include "setRootCase.H"
# include "createTime.H"
runTime.functionObjects().off();

View File

@ -115,7 +115,7 @@ void writeMesh
int main(int argc, char *argv[])
{
argList::validOptions.insert("overwrite", "");
argList::addBoolOption("overwrite");
# include "setRootCase.H"
# include "createTime.H"
runTime.functionObjects().off();

View File

@ -42,7 +42,7 @@ using namespace Foam;
int main(int argc, char *argv[])
{
argList::noParallel();
argList::validOptions.insert("overwrite", "");
argList::addBoolOption("overwrite");
# include "setRootCase.H"
# include "createTime.H"

View File

@ -71,7 +71,7 @@ int main(int argc, char *argv[])
{
argList::noParallel();
argList::validArgs.append("feature angle[0-180]");
argList::validOptions.insert("overwrite", "");
argList::addBoolOption("overwrite");
# include "setRootCase.H"
# include "createTime.H"

View File

@ -49,9 +49,9 @@ int main(int argc, char *argv[])
{
timeSelector::addOptions();
# include "addRegionOption.H"
argList::validOptions.insert("noTopology", "");
argList::validOptions.insert("allGeometry", "");
argList::validOptions.insert("allTopology", "");
argList::addBoolOption("noTopology");
argList::addBoolOption("allGeometry");
argList::addBoolOption("allTopology");
# include "setRootCase.H"
# include "createTime.H"

View File

@ -128,9 +128,9 @@ int main(int argc, char *argv[])
# include "addRegionOption.H"
argList::validArgs.append("faceZone");
argList::validArgs.append("patch");
argList::validOptions.insert("additionalPatches", "(patch2 .. patchN)");
argList::validOptions.insert("internalFacesOnly", "");
argList::validOptions.insert("overwrite", "");
argList::addOption("additionalPatches", "(patch2 .. patchN)");
argList::addBoolOption("internalFacesOnly");
argList::addBoolOption("overwrite");
# include "setRootCase.H"
# include "createTime.H"

View File

@ -517,7 +517,7 @@ void syncPoints
int main(int argc, char *argv[])
{
# include "addRegionOption.H"
argList::validOptions.insert("overwrite", "");
argList::addBoolOption("overwrite");
# include "setRootCase.H"
# include "createTime.H"

View File

@ -43,16 +43,15 @@ using namespace Foam;
int main(int argc, char *argv[])
{
Foam::argList::noParallel();
Foam::argList::validArgs.append("surface file");
Foam::argList::validArgs.append("destination cellSet");
argList::noParallel();
argList::validArgs.append("surface file");
argList::validArgs.append("destination cellSet");
# include "setRootCase.H"
# include "createTime.H"
# include "createPolyMesh.H"
fileName surfName(args.additionalArgs()[0]);
fileName setName(args.additionalArgs()[1]);

View File

@ -2,11 +2,11 @@
argList::validArgs.append("master root");
argList::validArgs.append("master case");
argList::validOptions.insert("masterRegion", "name");
argList::addOption("masterRegion", "name");
argList::validArgs.append("root to add");
argList::validArgs.append("case to add");
argList::validOptions.insert("addRegion", "name");
argList::addOption("addRegion", "name");
argList args(argc, argv);

View File

@ -223,9 +223,9 @@ labelList findBaffles(const polyMesh& mesh, const labelList& boundaryFaces)
int main(int argc, char *argv[])
{
# include "addRegionOption.H"
argList::validOptions.insert("split", "");
argList::validOptions.insert("overwrite", "");
argList::validOptions.insert("detectOnly", "");
argList::addBoolOption("split");
argList::addBoolOption("overwrite");
argList::addBoolOption("detectOnly");
# include "setRootCase.H"
# include "createTime.H"
runTime.functionObjects().off();

View File

@ -291,8 +291,8 @@ label twoDNess(const polyMesh& mesh)
int main(int argc, char *argv[])
{
Foam::argList::validOptions.insert("dict", "");
Foam::argList::validOptions.insert("overwrite", "");
argList::addBoolOption("dict");
argList::addBoolOption("overwrite");
# include "setRootCase.H"
# include "createTime.H"
@ -320,18 +320,17 @@ int main(int argc, char *argv[])
{
Info<< "Refining according to refineMeshDict" << nl << endl;
refineDict =
IOdictionary
refineDict = IOdictionary
(
IOobject
(
IOobject
(
"refineMeshDict",
runTime.system(),
mesh,
IOobject::MUST_READ,
IOobject::NO_WRITE
)
);
"refineMeshDict",
runTime.system(),
mesh,
IOobject::MUST_READ,
IOobject::NO_WRITE
)
);
word setName(refineDict.lookup("set"));

View File

@ -364,10 +364,10 @@ autoPtr<mapPolyMesh> reorderMesh
int main(int argc, char *argv[])
{
argList::validOptions.insert("blockOrder", "");
argList::validOptions.insert("orderPoints", "");
argList::validOptions.insert("writeMaps", "");
argList::validOptions.insert("overwrite", "");
argList::addBoolOption("blockOrder");
argList::addBoolOption("orderPoints");
argList::addBoolOption("writeMaps");
argList::addBoolOption("overwrite");
# include "addTimeOptions.H"

View File

@ -843,8 +843,8 @@ int main(int argc, char *argv[])
# include "addRegionOption.H"
# include "addTimeOptions.H"
argList::validOptions.insert("noVTK", "");
argList::validOptions.insert("batch", "file");
argList::addBoolOption("noVTK");
argList::addOption("batch", "file");
# include "setRootCase.H"
# include "createTime.H"

View File

@ -58,7 +58,7 @@ using namespace Foam;
int main(int argc, char *argv[])
{
argList::validOptions.insert("noFlipMap", "");
argList::addBoolOption("noFlipMap");
# include "addRegionOption.H"
# include "addTimeOptions.H"

View File

@ -66,7 +66,8 @@ void interpolateFields
int main(int argc, char *argv[])
{
Foam::argList::validOptions.insert("overwrite", "");
argList::addBoolOption("overwrite");
# include "addTimeOptions.H"
# include "setRootCase.H"
# include "createTime.H"

View File

@ -110,12 +110,12 @@ void checkPatch(const polyBoundaryMesh& bMesh, const word& name)
int main(int argc, char *argv[])
{
Foam::argList::noParallel();
argList::noParallel();
Foam::argList::validArgs.append("faceSet");
Foam::argList::validArgs.append("masterPatch");
Foam::argList::validArgs.append("slavePatch");
Foam::argList::validOptions.insert("overwrite", "");
argList::validArgs.append("faceSet");
argList::validArgs.append("masterPatch");
argList::validArgs.append("slavePatch");
argList::addBoolOption("overwrite");
# include "setRootCase.H"
# include "createTime.H"

View File

@ -1232,15 +1232,15 @@ label findCorrespondingRegion
int main(int argc, char *argv[])
{
argList::validOptions.insert("cellZones", "");
argList::validOptions.insert("cellZonesOnly", "");
argList::validOptions.insert("blockedFaces", "faceSet");
argList::validOptions.insert("makeCellZones", "");
argList::validOptions.insert("largestOnly", "");
argList::validOptions.insert("insidePoint", "point");
argList::validOptions.insert("overwrite", "");
argList::validOptions.insert("detectOnly", "");
argList::validOptions.insert("sloppyCellZones", "");
argList::addBoolOption("cellZones");
argList::addBoolOption("cellZonesOnly");
argList::addOption("blockedFaces", "faceSet");
argList::addBoolOption("makeCellZones");
argList::addBoolOption("largestOnly");
argList::addOption("insidePoint", "point");
argList::addBoolOption("overwrite");
argList::addBoolOption("detectOnly");
argList::addBoolOption("sloppyCellZones");
# include "setRootCase.H"
# include "createTime.H"

View File

@ -95,17 +95,16 @@ void checkPatch(const polyBoundaryMesh& bMesh, const word& name)
int main(int argc, char *argv[])
{
Foam::argList::noParallel();
argList::noParallel();
Foam::argList::validArgs.append("masterPatch");
Foam::argList::validArgs.append("slavePatch");
argList::validArgs.append("masterPatch");
argList::validArgs.append("slavePatch");
Foam::argList::validOptions.insert("partial", "");
Foam::argList::validOptions.insert("perfect", "");
argList::addBoolOption("partial");
argList::addBoolOption("perfect");
argList::addBoolOption("overwrite");
Foam::argList::validOptions.insert("overwrite", "");
Foam::argList::validOptions.insert("toleranceDict", "file with tolerances");
argList::addOption("toleranceDict", "file with tolerances");
# include "setRootCase.H"
# include "createTime.H"
@ -174,8 +173,10 @@ int main(int argc, char *argv[])
dictionary slidingTolerances;
if (args.options().found("toleranceDict"))
{
IOdictionary toleranceFile(
IOobject(
IOdictionary toleranceFile
(
IOobject
(
args.options()["toleranceDict"],
runTime.constant(),
mesh,
@ -202,7 +203,7 @@ int main(int argc, char *argv[])
// Make list of masterPatch faces
labelList isf(masterPatch.size());
forAll (isf, i)
forAll(isf, i)
{
isf[i] = masterPatch.start() + i;
}

View File

@ -152,8 +152,8 @@ void subsetPointFields
int main(int argc, char *argv[])
{
argList::validArgs.append("set");
argList::validOptions.insert("patch", "patch name");
argList::validOptions.insert("overwrite", "");
argList::addOption("patch", "patch name");
argList::addBoolOption("overwrite");
# include "setRootCase.H"
# include "createTime.H"

View File

@ -142,12 +142,12 @@ void rotateFields(const Time& runTime, const tensor& T)
int main(int argc, char *argv[])
{
argList::validOptions.insert("translate", "vector");
argList::validOptions.insert("rotate", "(vector vector)");
argList::validOptions.insert("rollPitchYaw", "(roll pitch yaw)");
argList::validOptions.insert("yawPitchRoll", "(yaw pitch roll)");
argList::validOptions.insert("rotateFields", "");
argList::validOptions.insert("scale", "vector");
argList::addOption("translate", "vector");
argList::addOption("rotate", "(vector vector)");
argList::addOption("rollPitchYaw", "(roll pitch yaw)");
argList::addOption("yawPitchRoll", "(yaw pitch roll)");
argList::addBoolOption("rotateFields");
argList::addOption("scale", "vector");
# include "setRootCase.H"
# include "createTime.H"