From 0e33bf0bba2c86e5d114c28c26d691d6b71a301c Mon Sep 17 00:00:00 2001
From: Mark Olesen <Mark.Olesen@Germany>
Date: Fri, 4 Dec 2009 10:20:15 +0100
Subject: [PATCH] add some usage information to a few utilities
---
.../createFields.H | 6 ++-
.../foamToStarMesh/foamToStarMesh.C | 25 +++++++++--
.../mesh/conversion/star4ToFoam/star4ToFoam.C | 19 +++++++--
.../mesh/generation/blockMesh/blockMeshApp.C | 14 ++++++-
.../decomposePar/decomposePar.C | 41 ++++++++++++++-----
.../foamToEnsight/foamToEnsight.C | 21 ++++++++--
.../foamToEnsightParts/foamToEnsightParts.C | 21 ++++++++--
7 files changed, 118 insertions(+), 29 deletions(-)
diff --git a/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/createFields.H b/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/createFields.H
index 78b0e8b552f..5b5767ef3eb 100644
--- a/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/createFields.H
+++ b/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/createFields.H
@@ -47,8 +47,10 @@
)
);
- word kinematicCloudName("kinematicCloud");
- args.optionReadIfPresent("cloudName", kinematicCloudName);
+ const word kinematicCloudName
+ (
+ args.optionLookupOrDefault<word>("cloudName", "kinematicCloud")
+ );
Info<< "Constructing kinematicCloud " << kinematicCloudName << endl;
basicKinematicCloud kinematicCloud
diff --git a/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C b/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C
index 7b021d355ca..9df568f1b54 100644
--- a/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C
+++ b/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C
@@ -76,10 +76,27 @@ int main(int argc, char *argv[])
argList::noParallel();
timeSelector::addOptions();
- argList::addOption("scale", "scale");
- argList::addBoolOption("noBnd");
- argList::addBoolOption("tri");
- argList::addBoolOption("surface");
+ argList::addOption
+ (
+ "scale",
+ "factor",
+ "specify geometry scaling factor - default is 1000 ([m] to [mm])"
+ );
+ argList::addBoolOption
+ (
+ "noBnd",
+ "suppress writing the .bnd file"
+ );
+ argList::addBoolOption
+ (
+ "tri",
+ "Extract a triangulated surface. Implies -surface"
+ );
+ argList::addBoolOption
+ (
+ "surface",
+ "extract the surface of the volume mesh only"
+ );
# include "setRootCase.H"
# include "createTime.H"
diff --git a/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C b/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C
index 0cc4c4efd29..e48625230c0 100644
--- a/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C
+++ b/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C
@@ -62,9 +62,22 @@ int main(int argc, char *argv[])
{
argList::noParallel();
argList::validArgs.append("pro-STAR prefix");
- argList::addBoolOption("ascii");
- argList::addOption("scale", "scale");
- argList::addBoolOption("solids");
+ argList::addBoolOption
+ (
+ "ascii",
+ "write in ASCII instead of binary format"
+ );
+ argList::addOption
+ (
+ "scale",
+ "scale",
+ "geometry scaling factor - default is 0.001 ([mm] to [m])"
+ );
+ argList::addBoolOption
+ (
+ "solids",
+ "retain solid cells and treat them like fluid cells"
+ );
argList args(argc, argv);
Time runTime(args.rootPath(), args.caseName());
diff --git a/applications/utilities/mesh/generation/blockMesh/blockMeshApp.C b/applications/utilities/mesh/generation/blockMesh/blockMeshApp.C
index 6e92fae989c..93a65365066 100644
--- a/applications/utilities/mesh/generation/blockMesh/blockMeshApp.C
+++ b/applications/utilities/mesh/generation/blockMesh/blockMeshApp.C
@@ -72,8 +72,18 @@ using namespace Foam;
int main(int argc, char *argv[])
{
argList::noParallel();
- argList::addBoolOption("blockTopology");
- argList::addOption("dict", "dictionary");
+ argList::addBoolOption
+ (
+ "blockTopology",
+ "write block edges and centres as .obj files"
+ );
+ argList::addOption
+ (
+ "dict",
+ "NAME",
+ "specify an alternative dictionary for the blockMesh description"
+ );
+
# include "addRegionOption.H"
# include "setRootCase.H"
# include "createTime.H"
diff --git a/applications/utilities/parallelProcessing/decomposePar/decomposePar.C b/applications/utilities/parallelProcessing/decomposePar/decomposePar.C
index 34a30d63f65..ca246cc78ba 100644
--- a/applications/utilities/parallelProcessing/decomposePar/decomposePar.C
+++ b/applications/utilities/parallelProcessing/decomposePar/decomposePar.C
@@ -88,20 +88,39 @@ int main(int argc, char *argv[])
argList::noParallel();
# include "addRegionOption.H"
argList::addBoolOption("cellDist");
- argList::addBoolOption("copyUniform");
- argList::addBoolOption("fields");
- argList::addBoolOption("filterPatches");
- argList::addBoolOption("force");
- argList::addBoolOption("ifRequired");
+ argList::addBoolOption
+ (
+ "copyUniform",
+ "copy any uniform/ directories too"
+ );
+ argList::addBoolOption
+ (
+ "fields",
+ "use existing geometry decomposition and convert fields only"
+ );
+ argList::addBoolOption
+ (
+ "filterPatches",
+ "remove empty patches when decomposing the geometry"
+ );
+ argList::addBoolOption
+ (
+ "force",
+ "remove existing processor*/ subdirs before decomposing the geometry"
+ );
+ argList::addBoolOption
+ (
+ "ifRequired",
+ "only decompose geometry if the number of domains has changed"
+ );
# include "setRootCase.H"
word regionName = fvMesh::defaultRegion;
word regionDir = word::null;
- if (args.optionFound("region"))
+ if (args.optionReadIfPresent("region", regionName))
{
- regionName = args.option("region");
regionDir = regionName;
Info<< "Decomposing mesh " << regionName << nl << endl;
}
@@ -124,10 +143,10 @@ int main(int argc, char *argv[])
isDir
(
runTime.path()
- /(word("processor") + name(nProcs))
- /runTime.constant()
- /regionDir
- /polyMesh::meshSubDir
+ / (word("processor") + name(nProcs))
+ / runTime.constant()
+ / regionDir
+ / polyMesh::meshSubDir
)
)
{
diff --git a/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C b/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C
index 977972e4cac..94cf1dfecf3 100644
--- a/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C
+++ b/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C
@@ -93,10 +93,23 @@ bool inFileNameList
int main(int argc, char *argv[])
{
- argList::addBoolOption("ascii");
- argList::addBoolOption("noPatches");
-
- argList::addOption("patches", "patchList");
+ argList::addBoolOption
+ (
+ "ascii",
+ "write in ASCII format instead of 'C Binary'"
+ );
+ argList::addBoolOption
+ (
+ "noPatches",
+ "Suppress writing any patches"
+ );
+ argList::addOption
+ (
+ "patches",
+ "patchList",
+ "Specify particular patches to write. "
+ "An empty list suppresses writing the internalMesh."
+ );
# include "addTimeOptions.H"
# include "setRootCase.H"
diff --git a/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C b/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C
index 6797f69978e..5f4db4c9952 100644
--- a/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C
+++ b/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C
@@ -79,9 +79,24 @@ int main(int argc, char *argv[])
// afterwards anyhow
timeSelector::addOptions(true, false);
argList::noParallel();
- argList::addBoolOption("ascii");
- argList::addOption("index", "start");
- argList::addBoolOption("noMesh");
+ argList::addBoolOption
+ (
+ "ascii",
+ "write in ASCII format instead of 'C Binary'"
+ );
+ argList::addOption
+ (
+ "index",
+ "start",
+ "ignore the time index contained in the uniform/time file "
+ "and use a simple indexing when creating the files"
+ );
+ argList::addBoolOption
+ (
+ "noMesh",
+ "Suppress writing the geometry. "
+ "Can be useful for converting partial results for a static geometry."
+ );
// the volume field types that we handle
wordHashSet volFieldTypes;
--
GitLab