From dd8f4f657a1c11f1007cce12b0b614c1bb52e3f9 Mon Sep 17 00:00:00 2001 From: Mark Olesen Date: Wed, 9 Dec 2009 10:19:53 +0100 Subject: [PATCH] adjust usage for a few applications to account for new style --- .../mesh/generation/blockMesh/blockMeshApp.C | 4 +- .../transformPoints/transformPoints.C | 37 +++++++++++++--- .../foamToEnsight/foamToEnsight.C | 6 +-- .../foamToEnsightParts/foamToEnsightParts.C | 2 +- .../dataConversion/foamToVTK/foamToVTK.C | 42 +++++++++++++++---- 5 files changed, 72 insertions(+), 19 deletions(-) diff --git a/applications/utilities/mesh/generation/blockMesh/blockMeshApp.C b/applications/utilities/mesh/generation/blockMesh/blockMeshApp.C index 93a6536506..9140c090ec 100644 --- a/applications/utilities/mesh/generation/blockMesh/blockMeshApp.C +++ b/applications/utilities/mesh/generation/blockMesh/blockMeshApp.C @@ -42,7 +42,7 @@ Usage @param -region \ \n Specify an alternative mesh region. - @param -dict \ \n + @param -dict \ \n Specify an alternative dictionary for the block mesh description. \*---------------------------------------------------------------------------*/ @@ -80,7 +80,7 @@ int main(int argc, char *argv[]) argList::addOption ( "dict", - "NAME", + "file", "specify an alternative dictionary for the blockMesh description" ); diff --git a/applications/utilities/mesh/manipulation/transformPoints/transformPoints.C b/applications/utilities/mesh/manipulation/transformPoints/transformPoints.C index 9fdc9681c6..2ea94212ca 100644 --- a/applications/utilities/mesh/manipulation/transformPoints/transformPoints.C +++ b/applications/utilities/mesh/manipulation/transformPoints/transformPoints.C @@ -142,12 +142,39 @@ void rotateFields(const Time& runTime, const tensor& T) int main(int argc, char *argv[]) { - argList::addOption("translate", "vector"); - argList::addOption("rotate", "(vector vector)"); - argList::addOption("rollPitchYaw", "(roll pitch yaw)"); - argList::addOption("yawPitchRoll", "(yaw pitch roll)"); + argList::addOption + ( + "translate", + "vector", + "translate by the specified - eg, '(1 0 0)'" + ); + argList::addOption + ( + "rotate", + "(vectorA vectorB)", + "transform in terms of a rotation between and " + "- eg, '( (1 0 0) (0 0 1) )'" + ); + argList::addOption + ( + "rollPitchYaw", + "vector", + "transform in terms of '( roll pitch yaw )' in degrees" + ); + argList::addOption + ( + "yawPitchRoll", + "vector", + "transform in terms of '( yaw pitch roll )' in degrees" + ); argList::addBoolOption("rotateFields"); - argList::addOption("scale", "vector"); + argList::addOption + ( + "scale", + "vector", + "scale by the specified amount - eg, '(0.001 0.001 0.001)' for a " + "uniform [mm] to [m] scaling" + ); # include "setRootCase.H" # include "createTime.H" diff --git a/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C b/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C index 94cf1dfecf..c0ea000959 100644 --- a/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C +++ b/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C @@ -101,13 +101,13 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "noPatches", - "Suppress writing any patches" + "suppress writing any patches" ); argList::addOption ( "patches", - "patchList", - "Specify particular patches to write. " + "wordList", + "specify particular patches to write - eg '(inlet outlet)'. " "An empty list suppresses writing the internalMesh." ); diff --git a/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C b/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C index 862816a946..22ba937868 100644 --- a/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C +++ b/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C @@ -94,7 +94,7 @@ int main(int argc, char *argv[]) argList::addBoolOption ( "noMesh", - "Suppress writing the geometry. " + "suppress writing the geometry. " "Can be useful for converting partial results for a static geometry" ); diff --git a/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C b/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C index 9a82419e20..73dc60b762 100644 --- a/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C +++ b/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C @@ -241,20 +241,46 @@ int main(int argc, char *argv[]) # include "addRegionOption.H" - argList::addOption("fields", "fields"); - argList::addOption("cellSet", "cellSet name"); - argList::addOption("faceSet", "faceSet name"); - argList::addOption("pointSet", "pointSet name"); - argList::addBoolOption("ascii"); + argList::addOption + ( + "fields", "wordList", + "only convert the specified fields - eg '(p T U)'" + ); + argList::addOption + ( + "cellSet", + "name", + "convert a mesh subset corresponding to the specified cellSet" + ); + argList::addOption("faceSet", "name"); + argList::addOption("pointSet", "name"); + argList::addBoolOption + ( + "ascii", + "write in ASCII format instead of binary" + ); argList::addBoolOption("surfaceFields"); argList::addBoolOption("nearCellValue"); argList::addBoolOption("noInternal"); argList::addBoolOption("noPointValues"); argList::addBoolOption("allPatches"); - argList::addOption("excludePatches","patches to exclude"); + argList::addOption + ( + "excludePatches", + "wordReList", + "a list of patches to exclude - eg '( inlet \".*Wall\" )' " + ); argList::addBoolOption("noFaceZones"); - argList::addBoolOption("noLinks"); - argList::addBoolOption("useTimeName"); + argList::addBoolOption + ( + "noLinks", + "don't link processor VTK files - parallel only" + ); + argList::addBoolOption + ( + "useTimeName", + "use the time name instead of the time index when naming the files" + ); # include "setRootCase.H" # include "createTime.H"