From b364a9e72c4aa6ca843517cda438b80c178bf974 Mon Sep 17 00:00:00 2001 From: Mark Olesen Date: Mon, 1 Nov 2021 11:31:56 +0100 Subject: [PATCH] ENH: argList improvements - argList::envExecutable() static method. This is identical to getEnv("FOAM_EXECUTABLE"), where the name of the executable has typically been set from the argList construction. Provides a singleton access to this value from locations that do not have knowledge of the originating command args (argList). This is a similar rationale as for the argList::envGlobalPath() static. - additional argList::envRelativePath() static method. - make -dry-run handling more central and easier to use by adding into argList itself. STYLE: drop handling of -srcDoc (v1706 option) - replaced with -doc-source for 1712 and never used much anyhow --- .../generation/snappyHexMesh/snappyHexMesh.C | 5 +- .../foamRestoreFields/foamRestoreFields.C | 7 +- .../decomposePar/decomposePar.C | 5 +- .../redistributePar/redistributePar.C | 5 +- .../lumpedPointMovement/lumpedPointMovement.C | 5 +- .../lumpedPointZones/lumpedPointZones.C | 9 +-- .../PDR/PDRsetFields/PDRsetFields.C | 7 +- .../foamUpgradeCyclics/foamUpgradeCyclics.C | 3 +- .../setExprBoundaryFields.C | 5 +- .../setExprFields/setExprFields.C | 5 +- src/OpenFOAM/db/Time/TimePaths.C | 4 +- src/OpenFOAM/global/argList/argList.C | 62 ++++++++++---- src/OpenFOAM/global/argList/argList.H | 80 ++++++++++++++----- src/OpenFOAM/global/argList/argListI.H | 43 ++++++---- src/OpenFOAM/global/argList/parRun.H | 52 ++++++++---- src/OpenFOAM/global/foamConfig.Cver | 5 -- src/OpenFOAM/include/addCheckCaseOptions.H | 25 +++++- src/OpenFOAM/include/createMesh.H | 2 +- .../dynamicFvMesh/dynamicFvMeshNew.C | 4 +- src/finiteArea/include/faCFD.H | 2 - .../cfdTools/general/include/fvCFD.H | 2 - .../bridge/code/polynomial-motion.C | 5 +- .../building/code/building-motion.C | 7 +- 23 files changed, 226 insertions(+), 123 deletions(-) diff --git a/applications/utilities/mesh/generation/snappyHexMesh/snappyHexMesh.C b/applications/utilities/mesh/generation/snappyHexMesh/snappyHexMesh.C index 1218daddde..1d18e68fb9 100644 --- a/applications/utilities/mesh/generation/snappyHexMesh/snappyHexMesh.C +++ b/applications/utilities/mesh/generation/snappyHexMesh/snappyHexMesh.C @@ -756,9 +756,8 @@ int main(int argc, char *argv[]) "checkGeometry", "Check all surface geometry for quality" ); - argList::addBoolOption + argList::addDryRunOption ( - "dry-run", "Check case set-up only using a single time step" ); argList::addOption @@ -789,7 +788,7 @@ int main(int argc, char *argv[]) const bool overwrite = args.found("overwrite"); const bool checkGeometry = args.found("checkGeometry"); const bool surfaceSimplify = args.found("surfaceSimplify"); - const bool dryRun = args.found("dry-run"); + const bool dryRun = args.dryRun(); if (dryRun) { diff --git a/applications/utilities/miscellaneous/foamRestoreFields/foamRestoreFields.C b/applications/utilities/miscellaneous/foamRestoreFields/foamRestoreFields.C index 03518dcc0c..163f4c3195 100644 --- a/applications/utilities/miscellaneous/foamRestoreFields/foamRestoreFields.C +++ b/applications/utilities/miscellaneous/foamRestoreFields/foamRestoreFields.C @@ -5,7 +5,7 @@ \\ / A nd | www.openfoam.com \\/ M anipulation | ------------------------------------------------------------------------------- - Copyright (C) 2018-2020 OpenCFD Ltd. + Copyright (C) 2018-2021 OpenCFD Ltd. ------------------------------------------------------------------------------- License This file is part of OpenFOAM. @@ -228,9 +228,8 @@ int main(int argc, char *argv[]) "In serial mode use times from processor0/ directory, but operate on " "processor\\d+ directories" ); - argList::addBoolOption + argList::addDryRunOption ( - "dry-run", "Report action without moving/renaming" ); argList::addBoolOption @@ -247,7 +246,7 @@ int main(int argc, char *argv[]) #include "setRootCase.H" - dryrun = args.found("dry-run"); + dryrun = args.dryRun(); verbose = args.found("verbose"); diff --git a/applications/utilities/parallelProcessing/decomposePar/decomposePar.C b/applications/utilities/parallelProcessing/decomposePar/decomposePar.C index 792869d315..74d245653f 100644 --- a/applications/utilities/parallelProcessing/decomposePar/decomposePar.C +++ b/applications/utilities/parallelProcessing/decomposePar/decomposePar.C @@ -325,9 +325,8 @@ int main(int argc, char *argv[]) #include "addAllRegionOptions.H" - argList::addBoolOption + argList::addDryRunOption ( - "dry-run", "Test without writing the decomposition. " "Changes -cellDist to only write VTK output." ); @@ -410,7 +409,7 @@ int main(int argc, char *argv[]) #include "setRootCase.H" - const bool dryrun = args.found("dry-run"); + const bool dryrun = args.dryRun(); const bool writeCellDist = args.found("cellDist"); const bool verbose = args.found("verbose"); diff --git a/applications/utilities/parallelProcessing/redistributePar/redistributePar.C b/applications/utilities/parallelProcessing/redistributePar/redistributePar.C index 5a3b4925cb..db5f26c773 100644 --- a/applications/utilities/parallelProcessing/redistributePar/redistributePar.C +++ b/applications/utilities/parallelProcessing/redistributePar/redistributePar.C @@ -2488,9 +2488,8 @@ int main(int argc, char *argv[]) #include "addOverwriteOption.H" argList::addBoolOption("decompose", "Decompose case"); argList::addBoolOption("reconstruct", "Reconstruct case"); - argList::addBoolOption + argList::addDryRunOption ( - "dry-run", "Test without writing the decomposition. " "Changes -cellDist to only write volScalarField." ); @@ -2555,7 +2554,7 @@ int main(int argc, char *argv[]) const bool reconstruct = args.found("reconstruct"); const bool writeCellDist = args.found("cellDist"); - const bool dryrun = args.found("dry-run"); + const bool dryrun = args.dryRun(); const bool newTimes = args.found("newTimes"); bool decompose = args.found("decompose"); diff --git a/applications/utilities/postProcessing/lumped/lumpedPointMovement/lumpedPointMovement.C b/applications/utilities/postProcessing/lumped/lumpedPointMovement/lumpedPointMovement.C index ef5597dcae..659c02ccd4 100644 --- a/applications/utilities/postProcessing/lumped/lumpedPointMovement/lumpedPointMovement.C +++ b/applications/utilities/postProcessing/lumped/lumpedPointMovement/lumpedPointMovement.C @@ -119,9 +119,8 @@ int main(int argc, char *argv[]) "len", "Visualization length for planes (visualized as triangles)" ); - argList::addBoolOption + argList::addDryRunOption ( - "dry-run", "Test movement without a mesh" ); argList::addBoolOption @@ -142,7 +141,7 @@ int main(int argc, char *argv[]) const label span = Foam::max(1, args.getOrDefault