From 147fa2a75d0d2f13056c4aafff8f52abdc716157 Mon Sep 17 00:00:00 2001 From: Mark Olesen Date: Tue, 27 Apr 2010 10:50:15 +0200 Subject: [PATCH] STYLE: add notes to some (most) command-line options - mapFields and splitMeshRegions need more clarification --- .../uncoupledKinematicParcelFoam.C | 7 +- .../combinePatchFaces/combinePatchFaces.C | 15 ++-- .../refineWallLayer/refineWallLayer.C | 10 ++- .../refinementLevel/refinementLevel.C | 14 ++-- .../mesh/advanced/splitCells/splitCells.C | 36 ++++++--- .../mesh/conversion/ansysToFoam/ansysToFoam.L | 10 ++- .../mesh/conversion/cfx4ToFoam/cfx4ToFoam.C | 10 ++- .../fluent3DMeshToFoam/fluent3DMeshToFoam.L | 28 ++++++- .../fluentMeshToFoam/fluentMeshToFoam.L | 24 ++++-- .../foamToStarMesh/foamToStarMesh.C | 2 +- .../conversion/foamToSurface/foamToSurface.C | 4 +- .../conversion/gambitToFoam/gambitToFoam.L | 10 ++- .../mesh/conversion/gmshToFoam/gmshToFoam.C | 6 +- .../mesh/conversion/kivaToFoam/kivaToFoam.C | 36 ++++++--- .../mesh/conversion/kivaToFoam/readKivaGrid.H | 2 +- .../mesh/conversion/mshToFoam/mshToFoam.C | 10 ++- .../conversion/plot3dToFoam/plot3dToFoam.C | 29 +++++-- .../conversion/polyDualMesh/polyDualMeshApp.C | 2 +- .../mesh/conversion/sammToFoam/sammToFoam.C | 9 ++- .../mesh/conversion/star3ToFoam/star3ToFoam.C | 9 ++- .../mesh/conversion/star4ToFoam/star4ToFoam.C | 2 +- .../conversion/tetgenToFoam/tetgenToFoam.C | 6 +- .../conversion/writeMeshObj/writeMeshObj.C | 77 ++++++++++++++----- .../mesh/generation/blockMesh/blockMeshApp.C | 4 +- .../extrudeToRegionMesh/extrudeToRegionMesh.C | 2 +- .../mesh/manipulation/checkMesh/checkMesh.C | 18 ++++- .../createBaffles/createBaffles.C | 31 ++++++-- .../manipulation/mergeMeshes/createTimes.H | 15 +++- .../manipulation/mergeMeshes/mergeMeshes.C | 70 +++++++++++++++-- .../mesh/manipulation/mergeMeshes/setRoots.H | 32 -------- .../mergeOrSplitBaffles/mergeOrSplitBaffles.C | 31 +++++--- .../mesh/manipulation/refineMesh/refineMesh.C | 20 +++-- .../manipulation/renumberMesh/renumberMesh.C | 18 ++++- .../mesh/manipulation/setSet/setSet.C | 7 +- .../manipulation/setsToZones/setsToZones.C | 49 +++++++----- .../splitMeshRegions/splitMeshRegions.C | 73 +++++++++++++----- .../mesh/manipulation/stitchMesh/stitchMesh.C | 41 +++++++--- .../mesh/manipulation/subsetMesh/subsetMesh.C | 25 ++++-- .../transformPoints/transformPoints.C | 4 +- .../miscellaneous/foamInfoExec/foamInfoExec.C | 56 +++++++++----- .../decomposePar/decomposePar.C | 16 ++-- .../reconstructParMesh/reconstructParMesh.C | 18 ++--- .../redistributeMeshPar/redistributeMeshPar.C | 8 +- .../foamToFieldview9/foamToFieldview9.C | 6 +- .../foamToTecplot360/foamToTecplot360.C | 69 ++++++++++++----- .../dataConversion/foamToVTK/foamToVTK.C | 64 +++++++++++---- .../postProcessing/foamCalc/foamCalcApp.C | 5 +- .../lagrangian/particleTracks/createFields.H | 2 +- .../foamListTimes/foamListTimes.C | 16 +++- .../postProcessing/wall/yPlusRAS/yPlusRAS.C | 15 ++-- .../applyBoundaryLayer/applyBoundaryLayer.C | 25 +++++- .../applyBoundaryLayer/createFields.H | 2 +- .../applyWallFunctionBoundaryConditions.C | 8 +- .../changeDictionary/changeDictionary.C | 15 +++- .../foamUpgradeFvSolution.C | 12 ++- .../preProcessing/mapFields/mapFields.C | 49 +++++++++++- .../preProcessing/mapFields/setRoots.H | 30 -------- .../utilities/surface/surfaceAdd/surfaceAdd.C | 24 ++++-- .../surfaceAutoPatch/surfaceAutoPatch.C | 9 +-- .../surface/surfaceCheck/surfaceCheck.C | 18 +++-- .../surface/surfaceClean/surfaceClean.C | 4 +- .../surface/surfaceCoarsen/surfaceCoarsen.C | 6 +- .../surface/surfaceConvert/surfaceConvert.C | 27 +++++-- .../surfaceFeatureConvert.C | 2 +- .../surfaceFeatureExtract.C | 51 +++++++++--- .../surface/surfaceFind/surfaceFind.C | 2 +- .../surface/surfaceInertia/surfaceInertia.C | 8 +- .../surfaceMeshConvert/surfaceMeshConvert.C | 13 +++- .../surfaceMeshConvertTesting.C | 14 +++- .../surfaceMeshExport/surfaceMeshExport.C | 59 +++++++++++--- .../surfaceMeshImport/surfaceMeshImport.C | 63 ++++++++++++--- .../surfaceMeshTriangulate.C | 27 +++++-- .../surface/surfaceOrient/surfaceOrient.C | 28 ++++--- .../surfacePointMerge/surfacePointMerge.C | 4 +- .../surfaceRedistributePar.C | 22 ++++-- .../surfaceRefineRedGreen.C | 4 +- .../surface/surfaceSmooth/surfaceSmooth.C | 4 +- .../surfaceSplitByPatch/surfaceSplitByPatch.C | 6 +- .../surfaceSplitNonManifolds.C | 15 +++- .../surface/surfaceSubset/surfaceSubset.C | 4 +- .../surface/surfaceToPatch/surfaceToPatch.C | 32 +++++--- .../surfaceTransformPoints.C | 4 +- src/OpenFOAM/global/argList/argList.C | 2 +- .../foamCalcFunctions/calcType/calcTypeNew.C | 24 ++++-- src/postProcessing/postCalc/postCalc.C | 3 +- 85 files changed, 1221 insertions(+), 472 deletions(-) delete mode 100644 applications/utilities/mesh/manipulation/mergeMeshes/setRoots.H delete mode 100644 applications/utilities/preProcessing/mapFields/setRoots.H diff --git a/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelFoam.C b/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelFoam.C index 13757df7ba..1fdc783a4f 100644 --- a/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelFoam.C +++ b/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelFoam.C @@ -41,7 +41,12 @@ Description int main(int argc, char *argv[]) { - argList::addOption("cloudName", "cloud name"); + argList::addOption + ( + "cloudName", + "name", + "specify alternative cloud name. default is 'kinematicCloud'" + ); #include "setRootCase.H" #include "createTime.H" diff --git a/applications/utilities/mesh/advanced/combinePatchFaces/combinePatchFaces.C b/applications/utilities/mesh/advanced/combinePatchFaces/combinePatchFaces.C index c3d671d232..56ea5e124f 100644 --- a/applications/utilities/mesh/advanced/combinePatchFaces/combinePatchFaces.C +++ b/applications/utilities/mesh/advanced/combinePatchFaces/combinePatchFaces.C @@ -38,7 +38,7 @@ Description E.g. to allow all faces on same patch to be merged: - combinePatchFaces .. cavity 180 -concaveAngle 90 + combinePatchFaces 180 -concaveAngle 90 \*---------------------------------------------------------------------------*/ @@ -429,15 +429,18 @@ int main(int argc, char *argv[]) { # include "addOverwriteOption.H" - argList::validArgs.append("feature angle [0..180]"); + argList::validArgs.append("featureAngle [0..180]"); argList::addOption ( "concaveAngle", - "[0..180]", - "specify concave angle [0..180] degrees (default: 30.0 degrees)" + "degrees", + "specify concave angle [0..180] (default: 30 degrees)" + ); + argList::addBoolOption + ( + "snapMesh", + "use system/snapMeshDict" ); - - argList::addBoolOption("snapMesh"); # include "setRootCase.H" # include "createTime.H" diff --git a/applications/utilities/mesh/advanced/refineWallLayer/refineWallLayer.C b/applications/utilities/mesh/advanced/refineWallLayer/refineWallLayer.C index 5e0ce9248f..4a1a9b5a08 100644 --- a/applications/utilities/mesh/advanced/refineWallLayer/refineWallLayer.C +++ b/applications/utilities/mesh/advanced/refineWallLayer/refineWallLayer.C @@ -46,12 +46,18 @@ using namespace Foam; int main(int argc, char *argv[]) { -# include "addOverwriteOption.H" + #include "addOverwriteOption.H" argList::noParallel(); argList::validArgs.append("patchName"); argList::validArgs.append("edgeWeight"); - argList::addOption("useSet", "cellSet"); + argList::addOption + ( + "useSet", + "name", + "restrict cells to refine based on specified cellSet name" + ); + # include "setRootCase.H" # include "createTime.H" diff --git a/applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C b/applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C index acaa9bf48d..0224943836 100644 --- a/applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C +++ b/applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C @@ -96,11 +96,15 @@ bool limitRefinementLevel int main(int argc, char *argv[]) { - argList::addBoolOption("readLevel"); + argList::addBoolOption + ( + "readLevel", + "read level from refinementLevel file" + ); -# include "setRootCase.H" -# include "createTime.H" -# include "createPolyMesh.H" + #include "setRootCase.H" + #include "createTime.H" + #include "createPolyMesh.H" Info<< "Dividing cells into bins depending on cell volume.\nThis will" << " correspond to refinement levels for a mesh with only 2x2x2" @@ -109,7 +113,7 @@ int main(int argc, char *argv[]) << " to allow for some truncation error." << nl << endl; - bool readLevel = args.optionFound("readLevel"); + const bool readLevel = args.optionFound("readLevel"); const scalarField& vols = mesh.cellVolumes(); diff --git a/applications/utilities/mesh/advanced/splitCells/splitCells.C b/applications/utilities/mesh/advanced/splitCells/splitCells.C index 19828287bc..3967a51516 100644 --- a/applications/utilities/mesh/advanced/splitCells/splitCells.C +++ b/applications/utilities/mesh/advanced/splitCells/splitCells.C @@ -517,17 +517,35 @@ void collectCuts int main(int argc, char *argv[]) { -# include "addOverwriteOption.H" + argList::addNote + ( + "split cells with flat faces" + ); + #include "addOverwriteOption.H" argList::noParallel(); - argList::addOption("set", "cellSet name"); - argList::addBoolOption("geometry"); - argList::addOption("tol", "edge snap tolerance"); - argList::validArgs.append("edge angle [0..360]"); + argList::validArgs.append("edgeAngle [0..360]"); -# include "setRootCase.H" -# include "createTime.H" + argList::addOption + ( + "set", + "name", + "split cells from specified cellSet only" + ); + argList::addBoolOption + ( + "geometry", + "use geometric cut for hexes as well" + ); + argList::addOption + ( + "tol", + "scalar", "edge snap tolerance (default 0.2)" + ); + + #include "setRootCase.H" + #include "createTime.H" runTime.functionObjects().off(); -# include "createPolyMesh.H" + #include "createPolyMesh.H" const word oldInstance = mesh.pointsInstance(); const scalar featureAngle = args.argRead(1); @@ -538,7 +556,7 @@ int main(int argc, char *argv[]) const bool geometry = args.optionFound("geometry"); const bool overwrite = args.optionFound("overwrite"); - scalar edgeTol = args.optionLookupOrDefault("tol", 0.2); + const scalar edgeTol = args.optionLookupOrDefault("tol", 0.2); Info<< "Trying to split cells with internal angles > feature angle\n" << nl << "featureAngle : " << featureAngle << nl diff --git a/applications/utilities/mesh/conversion/ansysToFoam/ansysToFoam.L b/applications/utilities/mesh/conversion/ansysToFoam/ansysToFoam.L index 2fb1c77043..16e3b9efe3 100644 --- a/applications/utilities/mesh/conversion/ansysToFoam/ansysToFoam.L +++ b/applications/utilities/mesh/conversion/ansysToFoam/ansysToFoam.L @@ -235,7 +235,12 @@ int main(int argc, char *argv[]) { argList::noParallel(); argList::validArgs.append("ANSYS input file"); - argList::addOption("scale", "scale factor"); + argList::addOption + ( + "scale", + "factor", + "geometry scaling factor - default is 1" + ); argList args(argc, argv); @@ -244,8 +249,7 @@ int main(int argc, char *argv[]) FatalError.exit(); } - scalar scaleFactor = 1.0; - args.optionReadIfPresent("scale", scaleFactor); + const scalar scaleFactor = args.optionLookupOrDefault("scale", 1.0); # include "createTime.H" diff --git a/applications/utilities/mesh/conversion/cfx4ToFoam/cfx4ToFoam.C b/applications/utilities/mesh/conversion/cfx4ToFoam/cfx4ToFoam.C index 02b758b569..2de1b840e9 100644 --- a/applications/utilities/mesh/conversion/cfx4ToFoam/cfx4ToFoam.C +++ b/applications/utilities/mesh/conversion/cfx4ToFoam/cfx4ToFoam.C @@ -49,7 +49,12 @@ int main(int argc, char *argv[]) { argList::noParallel(); argList::validArgs.append("CFX geom file"); - argList::addOption("scale", "scale factor"); + argList::addOption + ( + "scale", + "factor", + "geometry scaling factor - default is 1" + ); argList args(argc, argv); @@ -58,8 +63,7 @@ int main(int argc, char *argv[]) FatalError.exit(); } - scalar scaleFactor = 1.0; - args.optionReadIfPresent("scale", scaleFactor); + const scalar scaleFactor = args.optionLookupOrDefault("scale", 1.0); # include "createTime.H" diff --git a/applications/utilities/mesh/conversion/fluent3DMeshToFoam/fluent3DMeshToFoam.L b/applications/utilities/mesh/conversion/fluent3DMeshToFoam/fluent3DMeshToFoam.L index 02da5e6829..6c3a0c315a 100644 --- a/applications/utilities/mesh/conversion/fluent3DMeshToFoam/fluent3DMeshToFoam.L +++ b/applications/utilities/mesh/conversion/fluent3DMeshToFoam/fluent3DMeshToFoam.L @@ -761,10 +761,30 @@ int main(int argc, char *argv[]) { argList::noParallel(); argList::validArgs.append("Fluent mesh file"); - argList::addOption("scale", "scale factor"); - argList::addOption("ignoreCellGroups", "cell group names"); - argList::addOption("ignoreFaceGroups", "face group names"); - argList::addBoolOption("cubit"); + argList::addOption + ( + "scale", + "factor", + "geometry scaling factor - default is 1" + ); + argList::addOption + ( + "ignoreCellGroups", + "names", + "specify cell groups to ignore" + ); + argList::addOption + ( + "ignoreFaceGroups", + "names", + "specify face groups to ignore" + ); + + argList::addBoolOption + ( + "cubit", + "special parsing of (incorrect) cubit files" + ); argList args(argc, argv); diff --git a/applications/utilities/mesh/conversion/fluentMeshToFoam/fluentMeshToFoam.L b/applications/utilities/mesh/conversion/fluentMeshToFoam/fluentMeshToFoam.L index 8c954cd1cb..619374396f 100644 --- a/applications/utilities/mesh/conversion/fluentMeshToFoam/fluentMeshToFoam.L +++ b/applications/utilities/mesh/conversion/fluentMeshToFoam/fluentMeshToFoam.L @@ -866,9 +866,22 @@ int main(int argc, char *argv[]) { argList::noParallel(); argList::validArgs.append("Fluent mesh file"); - argList::addOption("scale", "scale factor"); - argList::addBoolOption("writeSets"); - argList::addBoolOption("writeZones"); + argList::addOption + ( + "scale", + "factor", + "geometry scaling factor - default is 1" + ); + argList::addBoolOption + ( + "writeSets", + "write cell zones and patches as sets" + ); + argList::addBoolOption + ( + "writeZones", + "write cell zones as zones" + ); argList args(argc, argv); @@ -877,8 +890,7 @@ int main(int argc, char *argv[]) FatalError.exit(); } - scalar scaleFactor = 1.0; - args.optionReadIfPresent("scale", scaleFactor); + const scalar scaleFactor = args.optionLookupOrDefault("scale", 1.0); const bool writeSets = args.optionFound("writeSets"); const bool writeZones = args.optionFound("writeZones"); @@ -1554,7 +1566,7 @@ int main(int argc, char *argv[]) // interior boundaries are handled via faceSets // cell zones will only be written if there is more than one - if (writeZones && cellGroupZoneID.size()>1) + if (writeZones && cellGroupZoneID.size() > 1) { Info<< "Adding Zones" << endl; List pz(0); diff --git a/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C b/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C index fbb2c3b12f..09e34235e5 100644 --- a/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C +++ b/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C @@ -69,7 +69,7 @@ int main(int argc, char *argv[]) ( "scale", "factor", - "specify geometry scaling factor - default is 1000 ([m] to [mm])" + "geometry scaling factor - default is 1000 ([m] to [mm])" ); argList::addBoolOption ( diff --git a/applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C b/applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C index 1616173a83..28ced25e87 100644 --- a/applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C +++ b/applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C @@ -61,8 +61,8 @@ int main(int argc, char *argv[]) argList::addOption ( "scale", - "scale", - "specify geometry scaling factor" + "factor", + "geometry scaling factor - default is 1" ); argList::addBoolOption ( diff --git a/applications/utilities/mesh/conversion/gambitToFoam/gambitToFoam.L b/applications/utilities/mesh/conversion/gambitToFoam/gambitToFoam.L index 5e3b62bec5..c1d2b44e82 100644 --- a/applications/utilities/mesh/conversion/gambitToFoam/gambitToFoam.L +++ b/applications/utilities/mesh/conversion/gambitToFoam/gambitToFoam.L @@ -628,7 +628,12 @@ int main(int argc, char *argv[]) { argList::noParallel(); argList::validArgs.append("GAMBIT file"); - argList::addOption("scale", "scale factor"); + argList::addOption + ( + "scale", + "factor", + "geometry scaling factor - default is 1" + ); argList args(argc, argv); @@ -637,8 +642,7 @@ int main(int argc, char *argv[]) FatalError.exit(); } - scalar scaleFactor = 1.0; - args.optionReadIfPresent("scale", scaleFactor); + const scalar scaleFactor = args.optionLookupOrDefault("scale", 1.0); # include "createTime.H" diff --git a/applications/utilities/mesh/conversion/gmshToFoam/gmshToFoam.C b/applications/utilities/mesh/conversion/gmshToFoam/gmshToFoam.C index 1bcc998ae9..a3f607ba0b 100644 --- a/applications/utilities/mesh/conversion/gmshToFoam/gmshToFoam.C +++ b/applications/utilities/mesh/conversion/gmshToFoam/gmshToFoam.C @@ -716,7 +716,11 @@ int main(int argc, char *argv[]) { argList::noParallel(); argList::validArgs.append(".msh file"); - argList::addBoolOption("keepOrientation"); + argList::addBoolOption + ( + "keepOrientation", + "retain raw orientation for prisms/hexs" + ); # include "setRootCase.H" # include "createTime.H" diff --git a/applications/utilities/mesh/conversion/kivaToFoam/kivaToFoam.C b/applications/utilities/mesh/conversion/kivaToFoam/kivaToFoam.C index 5adeb68236..ab764547a3 100644 --- a/applications/utilities/mesh/conversion/kivaToFoam/kivaToFoam.C +++ b/applications/utilities/mesh/conversion/kivaToFoam/kivaToFoam.C @@ -46,7 +46,7 @@ Description using namespace Foam; -// Supported KIVA versions +//- Supported KIVA versions enum kivaVersions { kiva3, @@ -59,37 +59,51 @@ enum kivaVersions int main(int argc, char *argv[]) { argList::noParallel(); - argList::addOption("file", "fileName"); - argList::addOption("version", "[kiva3|kiva3v]"); - argList::addOption("zHeadMin", "scalar"); + argList::addOption + ( + "file", + "name", + "specify alternative input file name - default is otape17" + ); + argList::addOption + ( + "version", + "version", + "specify kiva version [kiva3|kiva3v] - default is '3v'" + ); + argList::addOption + ( + "zHeadMin", + "scalar", + "minimum z-height for transferring liner faces to cylinder-head" + ); # include "setRootCase.H" # include "createTime.H" - fileName kivaFileName("otape17"); - args.optionReadIfPresent("file", kivaFileName); + const fileName kivaFileName = + args.optionLookupOrDefault("file", "otape17"); kivaVersions kivaVersion = kiva3v; if (args.optionFound("version")) { - const word kivaVersionName = args["version"]; + const word versionName = args["version"]; - if (kivaVersionName == "kiva3") + if (versionName == "kiva3") { kivaVersion = kiva3; } - else if (kivaVersionName == "kiva3v") + else if (versionName == "kiva3v") { kivaVersion = kiva3v; } else { FatalErrorIn("main(int argc, char *argv[])") - << "KIVA file version " << kivaVersionName << " not supported" + << "KIVA file version " << versionName << " not supported" << exit(FatalError); args.printUsage(); - FatalError.exit(1); } } diff --git a/applications/utilities/mesh/conversion/kivaToFoam/readKivaGrid.H b/applications/utilities/mesh/conversion/kivaToFoam/readKivaGrid.H index 6c50c02fcd..d4356c2cdc 100644 --- a/applications/utilities/mesh/conversion/kivaToFoam/readKivaGrid.H +++ b/applications/utilities/mesh/conversion/kivaToFoam/readKivaGrid.H @@ -315,7 +315,7 @@ for (label i=0; i \n - Specify an alternative dictionary for the block mesh description. + Specify alternative dictionary for the block mesh description. \*---------------------------------------------------------------------------*/ @@ -80,7 +80,7 @@ int main(int argc, char *argv[]) ( "dict", "file", - "specify an alternative dictionary for the blockMesh description" + "specify alternative dictionary for the blockMesh description" ); # include "addRegionOption.H" diff --git a/applications/utilities/mesh/generation/extrudeToRegionMesh/extrudeToRegionMesh.C b/applications/utilities/mesh/generation/extrudeToRegionMesh/extrudeToRegionMesh.C index dfcfb91471..2a5aef33d1 100644 --- a/applications/utilities/mesh/generation/extrudeToRegionMesh/extrudeToRegionMesh.C +++ b/applications/utilities/mesh/generation/extrudeToRegionMesh/extrudeToRegionMesh.C @@ -632,7 +632,7 @@ int main(int argc, char *argv[]) argList::validArgs.append("thickness"); #include "addRegionOption.H" - argList::validOptions.insert("overwrite", ""); + #include "addOverwriteOption.H" #include "setRootCase.H" #include "createTime.H" #include "createNamedMesh.H" diff --git a/applications/utilities/mesh/manipulation/checkMesh/checkMesh.C b/applications/utilities/mesh/manipulation/checkMesh/checkMesh.C index c426128e31..8662f404c1 100644 --- a/applications/utilities/mesh/manipulation/checkMesh/checkMesh.C +++ b/applications/utilities/mesh/manipulation/checkMesh/checkMesh.C @@ -48,9 +48,21 @@ int main(int argc, char *argv[]) { timeSelector::addOptions(); # include "addRegionOption.H" - argList::addBoolOption("noTopology"); - argList::addBoolOption("allGeometry"); - argList::addBoolOption("allTopology"); + argList::addBoolOption + ( + "noTopology", + "skip checking the mesh topology" + ); + argList::addBoolOption + ( + "allGeometry", + "include bounding box checks" + ); + argList::addBoolOption + ( + "allTopology", + "include extra topology checks" + ); # include "setRootCase.H" # include "createTime.H" diff --git a/applications/utilities/mesh/manipulation/createBaffles/createBaffles.C b/applications/utilities/mesh/manipulation/createBaffles/createBaffles.C index e02d0e1420..97a7571807 100644 --- a/applications/utilities/mesh/manipulation/createBaffles/createBaffles.C +++ b/applications/utilities/mesh/manipulation/createBaffles/createBaffles.C @@ -124,18 +124,35 @@ label findPatchID(const polyMesh& mesh, const word& name) int main(int argc, char *argv[]) { -# include "addOverwriteOption.H" -# include "addRegionOption.H" + argList::addNote + ( + "Makes internal faces into boundary faces.\n" + "Does not duplicate points, unlike mergeOrSplitBaffles." + ); + + #include "addOverwriteOption.H" + #include "addRegionOption.H" argList::validArgs.append("faceZone"); argList::validArgs.append("patch"); - argList::addOption("additionalPatches", "(patch2 .. patchN)"); - argList::addBoolOption("internalFacesOnly"); -# include "setRootCase.H" -# include "createTime.H" + argList::addOption + ( + "additionalPatches", + "(patch2 .. patchN)", + "specify additional patches for creating baffles" + ); + argList::addBoolOption + ( + "internalFacesOnly", + "do not convert boundary faces" + ); + + #include "setRootCase.H" + #include "createTime.H" runTime.functionObjects().off(); -# include "createNamedMesh.H" + #include "createNamedMesh.H" + const word oldInstance = mesh.pointsInstance(); const polyBoundaryMesh& patches = mesh.boundaryMesh(); diff --git a/applications/utilities/mesh/manipulation/mergeMeshes/createTimes.H b/applications/utilities/mesh/manipulation/mergeMeshes/createTimes.H index 4098a89e6e..01f173f10c 100644 --- a/applications/utilities/mesh/manipulation/mergeMeshes/createTimes.H +++ b/applications/utilities/mesh/manipulation/mergeMeshes/createTimes.H @@ -1,15 +1,22 @@ Info<< nl << "Create Times" << endl; + const fileName masterCasePath = masterCase.path(); + const fileName masterCaseName = masterCase.name(); + Time runTimeMaster ( Time::controlDictName, - rootDirMaster, - caseDirMaster + masterCasePath, + masterCaseName ); + const fileName addCasePath = addCase.path(); + const fileName addCaseName = addCase.name(); + Time runTimeToAdd ( Time::controlDictName, - rootDirToAdd, - caseDirToAdd + addCasePath, + addCaseName ); + diff --git a/applications/utilities/mesh/manipulation/mergeMeshes/mergeMeshes.C b/applications/utilities/mesh/manipulation/mergeMeshes/mergeMeshes.C index 502f1b7dd6..03741a528c 100644 --- a/applications/utilities/mesh/manipulation/mergeMeshes/mergeMeshes.C +++ b/applications/utilities/mesh/manipulation/mergeMeshes/mergeMeshes.C @@ -32,16 +32,76 @@ Description using namespace Foam; +void getRootCase(fileName& casePath) +{ + casePath.clean(); + + if (casePath.empty() || casePath == ".") + { + // handle degenerate form and '.' + casePath = cwd(); + } + else if (casePath[0] != '/' && casePath.name() == "..") + { + // avoid relative cases ending in '..' - makes for very ugly names + casePath = cwd()/casePath; + casePath.clean(); + } +} + + // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // // Main program: int main(int argc, char *argv[]) { - argList::noParallel(); -# include "setRoots.H" -# include "createTimes.H" + argList::addNote + ( + "merge two meshes" + ); - Info<< "Reading master mesh for time = " << runTimeMaster.timeName() << endl; + argList::noParallel(); + argList::validArgs.clear(); + + argList::validArgs.append("masterCase"); + argList::addOption + ( + "masterRegion", + "name", + "specify alternative mesh region for the master mesh" + ); + + argList::validArgs.append("addCase"); + argList::addOption + ( + "addRegion", + "name", + "specify alternative mesh region for the additional mesh" + ); + + argList args(argc, argv); + if (!args.check()) + { + FatalError.exit(); + } + + fileName masterCase = args[1]; + word masterRegion = polyMesh::defaultRegion; + args.optionReadIfPresent("masterRegion", masterRegion); + + fileName addCase = args[2]; + word addRegion = polyMesh::defaultRegion; + args.optionReadIfPresent("addRegion", addRegion); + + getRootCase(masterCase); + getRootCase(addCase); + + Info<< "Master: " << masterCase << " region " << masterRegion << nl + << "mesh to add: " << addCase << " region " << addRegion << endl; + + #include "createTimes.H" + + Info<< "Reading master mesh for time = " << runTimeMaster.timeName() << nl; Info<< "Create mesh\n" << endl; mergePolyMesh masterMesh @@ -55,7 +115,7 @@ int main(int argc, char *argv[]) ); - Info<< "Reading mesh to add for time = " << runTimeToAdd.timeName() << endl; + Info<< "Reading mesh to add for time = " << runTimeToAdd.timeName() << nl; Info<< "Create mesh\n" << endl; polyMesh meshToAdd diff --git a/applications/utilities/mesh/manipulation/mergeMeshes/setRoots.H b/applications/utilities/mesh/manipulation/mergeMeshes/setRoots.H deleted file mode 100644 index 3d1fdd0132..0000000000 --- a/applications/utilities/mesh/manipulation/mergeMeshes/setRoots.H +++ /dev/null @@ -1,32 +0,0 @@ - argList::validArgs.clear(); - - argList::validArgs.append("master root"); - argList::validArgs.append("master case"); - argList::addOption("masterRegion", "name"); - - argList::validArgs.append("root to add"); - argList::validArgs.append("case to add"); - argList::addOption("addRegion", "name"); - - argList args(argc, argv); - - if (!args.check()) - { - FatalError.exit(); - } - - fileName rootDirMaster = args[1]; - fileName caseDirMaster = args[2]; - word masterRegion = polyMesh::defaultRegion; - args.optionReadIfPresent("masterRegion", masterRegion); - - fileName rootDirToAdd = args[3]; - fileName caseDirToAdd = args[4]; - word addRegion = polyMesh::defaultRegion; - args.optionReadIfPresent("addRegion", addRegion); - - Info<< "Master: " << rootDirMaster << " " << caseDirMaster - << " region " << masterRegion << nl - << "mesh to add: " << rootDirToAdd << " " << caseDirToAdd - << " region " << addRegion << endl; - diff --git a/applications/utilities/mesh/manipulation/mergeOrSplitBaffles/mergeOrSplitBaffles.C b/applications/utilities/mesh/manipulation/mergeOrSplitBaffles/mergeOrSplitBaffles.C index d7a24a2bf9..399fcb0421 100644 --- a/applications/utilities/mesh/manipulation/mergeOrSplitBaffles/mergeOrSplitBaffles.C +++ b/applications/utilities/mesh/manipulation/mergeOrSplitBaffles/mergeOrSplitBaffles.C @@ -221,15 +221,30 @@ labelList findBaffles(const polyMesh& mesh, const labelList& boundaryFaces) int main(int argc, char *argv[]) { -# include "addOverwriteOption.H" -# include "addRegionOption.H" - argList::addBoolOption("split"); - argList::addBoolOption("detectOnly"); + argList::addNote + ( + "Detect faces that share points (baffles).\n" + "Merge them or duplicate the points." + ); -# include "setRootCase.H" -# include "createTime.H" + #include "addOverwriteOption.H" + #include "addRegionOption.H" + argList::addBoolOption + ( + "detectOnly", + "find baffles only, but do not merge or split them" + ); + argList::addBoolOption + ( + "split", + "topologically split duplicate surfaces" + ); + + #include "setRootCase.H" + #include "createTime.H" runTime.functionObjects().off(); -# include "createNamedMesh.H" + #include "createNamedMesh.H" + const word oldInstance = mesh.pointsInstance(); const bool split = args.optionFound("split"); @@ -248,12 +263,10 @@ int main(int argc, char *argv[]) if (detectOnly) { findBaffles(mesh, boundaryFaces); - return 0; } - // Read objects in time directory IOobjectList objects(mesh, runTime.timeName()); diff --git a/applications/utilities/mesh/manipulation/refineMesh/refineMesh.C b/applications/utilities/mesh/manipulation/refineMesh/refineMesh.C index 783848d09b..ba3170d281 100644 --- a/applications/utilities/mesh/manipulation/refineMesh/refineMesh.C +++ b/applications/utilities/mesh/manipulation/refineMesh/refineMesh.C @@ -290,18 +290,26 @@ label twoDNess(const polyMesh& mesh) int main(int argc, char *argv[]) { -# include "addOverwriteOption.H" - argList::addBoolOption("dict"); + argList::addNote + ( + "refine cells in multiple directions" + ); -# include "setRootCase.H" -# include "createTime.H" + #include "addOverwriteOption.H" + argList::addBoolOption + ( + "dict", + "refine according to system/refineMeshDict" + ); + + #include "setRootCase.H" + #include "createTime.H" runTime.functionObjects().off(); -# include "createPolyMesh.H" + #include "createPolyMesh.H" const word oldInstance = mesh.pointsInstance(); printEdgeStats(mesh); - // // Read/construct control dictionary // diff --git a/applications/utilities/mesh/manipulation/renumberMesh/renumberMesh.C b/applications/utilities/mesh/manipulation/renumberMesh/renumberMesh.C index 11bf6e853d..80f9b6f93a 100644 --- a/applications/utilities/mesh/manipulation/renumberMesh/renumberMesh.C +++ b/applications/utilities/mesh/manipulation/renumberMesh/renumberMesh.C @@ -363,9 +363,21 @@ autoPtr reorderMesh int main(int argc, char *argv[]) { - argList::addBoolOption("blockOrder"); - argList::addBoolOption("orderPoints"); - argList::addBoolOption("writeMaps"); + argList::addBoolOption + ( + "blockOrder", + "order cells into regions (using decomposition)" + ); + argList::addBoolOption + ( + "orderPoints", + "order points into internal and boundary points" + ); + argList::addBoolOption + ( + "writeMaps", + "write cellMap, faceMap, pointMap in polyMesh/" + ); # include "addOverwriteOption.H" # include "addTimeOptions.H" diff --git a/applications/utilities/mesh/manipulation/setSet/setSet.C b/applications/utilities/mesh/manipulation/setSet/setSet.C index d8c216c662..54ff169f16 100644 --- a/applications/utilities/mesh/manipulation/setSet/setSet.C +++ b/applications/utilities/mesh/manipulation/setSet/setSet.C @@ -828,7 +828,12 @@ int main(int argc, char *argv[]) # include "addRegionOption.H" argList::addBoolOption("noVTK", "do not write VTK files"); argList::addBoolOption("loop", "execute batch commands for all timesteps"); - argList::addOption("batch", "file"); + argList::addOption + ( + "batch", + "file", + "process in batch mode, using input from specified file" + ); # include "setRootCase.H" # include "createTime.H" diff --git a/applications/utilities/mesh/manipulation/setsToZones/setsToZones.C b/applications/utilities/mesh/manipulation/setsToZones/setsToZones.C index 8a30d3bdf8..5a2cdfdccc 100644 --- a/applications/utilities/mesh/manipulation/setsToZones/setsToZones.C +++ b/applications/utilities/mesh/manipulation/setsToZones/setsToZones.C @@ -57,14 +57,23 @@ using namespace Foam; int main(int argc, char *argv[]) { - argList::addBoolOption("noFlipMap"); + argList::addNote + ( + "add point/face/cell Zones from similar named point/face/cell Sets" + ); -# include "addRegionOption.H" -# include "addTimeOptions.H" -# include "setRootCase.H" -# include "createTime.H" + argList::addBoolOption + ( + "noFlipMap", + "ignore orientation of faceSet" + ); - bool noFlipMap = args.optionFound("noFlipMap"); + #include "addRegionOption.H" + #include "addTimeOptions.H" + #include "setRootCase.H" + #include "createTime.H" + + const bool noFlipMap = args.optionFound("noFlipMap"); // Get times list instantList Times = runTime.times(); @@ -73,11 +82,11 @@ int main(int argc, char *argv[]) label endTime = Times.size(); // check -time and -latestTime options -# include "checkTimeOption.H" + #include "checkTimeOption.H" runTime.setTime(Times[startTime], startTime); -# include "createNamedPolyMesh.H" + #include "createNamedPolyMesh.H" // Search for list of objects for the time of the mesh word setsInstance = runTime.findInstance @@ -153,9 +162,19 @@ int main(int argc, char *argv[]) DynamicList