From 345a2a42f15a1bfe53662d96b80c64c9322adca3 Mon Sep 17 00:00:00 2001 From: Mark Olesen Date: Mon, 8 Jan 2018 15:35:18 +0100 Subject: [PATCH] ENH: simplify method names for reading argList options and arguments - use succincter method names that more closely resemble dictionary and HashTable method names. This improves method name consistency between classes and also requires less typing effort: args.found(optName) vs. args.optionFound(optName) args.readIfPresent(..) vs. args.optionReadIfPresent(..) ... args.opt(optName) vs. args.optionRead(optName) args.read(index) vs. args.argRead(index) - the older method names forms have been retained for code compatibility, but are now deprecated --- .../basic/potentialFoam/createFields.H | 4 +- .../overPotentialFoam/createFields.H | 4 +- .../overPotentialFoam/potentialFoam.C | 4 +- .../basic/potentialFoam/potentialFoam.C | 4 +- .../magneticFoam/magneticFoam.C | 8 +- .../solvers/lagrangian/DPMFoam/createFields.H | 2 +- .../createFields.H | 2 +- .../createFields.H | 2 +- .../test/FixedList2/Test-FixedList2.C | 14 +- .../Test-GAMGAgglomeration.C | 4 +- .../test/HashTable4/Test-HashTable4.C | 6 +- .../test/IOobjectList/Test-IOobjectList.C | 4 +- .../test/IndirectList/Test-IndirectList.C | 2 +- applications/test/List/Test-List.C | 16 +- applications/test/List2/Test-List2.C | 12 +- .../test/PackedList/Test-PackedList.C | 6 +- applications/test/argList/Test-argList.C | 62 ++- .../Test-checkDecomposePar.C | 10 +- .../test/decomposePar/Test-decomposePar.C | 14 +- .../dictionaryTokens/Test-dictionaryTokens.C | 4 +- applications/test/etcFiles/Test-etcFiles.C | 4 +- .../Test-externalFileCoupler.C | 4 +- applications/test/fileName/Test-fileName.C | 8 +- .../test/fileNameClean/Test-fileNameClean.C | 6 +- .../findCell-octree/Test-findCell-octree.C | 2 +- .../Test-fvSolutionCombine.C | 4 +- .../test/labelRanges/Test-labelRanges.C | 6 +- .../momentOfInertia/Test-momentOfInertia.C | 2 +- applications/test/mvBak/Test-mvBak.C | 2 +- .../test/objectRegistry/Test-objectRegistry.C | 4 +- .../test/quaternion/Test-quaternion.C | 8 +- applications/test/spline/Test-spline.C | 6 +- .../test/stringSplit/Test-stringSplit.C | 26 +- .../Test-surfaceIntersection.C | 16 +- .../Test-surfaceMeshConvert.C | 34 +- applications/test/tokenize/Test-tokenize.C | 6 +- .../finiteArea/makeFaMesh/makeFaMesh.C | 2 +- .../utilities/mesh/advanced/PDRMesh/PDRMesh.C | 2 +- .../advanced/collapseEdges/collapseEdges.C | 8 +- .../combinePatchFaces/combinePatchFaces.C | 8 +- .../mesh/advanced/modifyMesh/modifyMesh.C | 2 +- .../advanced/refineHexMesh/refineHexMesh.C | 4 +- .../refineWallLayer/refineWallLayer.C | 6 +- .../refinementLevel/refinementLevel.C | 2 +- .../mesh/advanced/removeFaces/removeFaces.C | 2 +- .../mesh/advanced/splitCells/splitCells.C | 10 +- .../mesh/conversion/ansysToFoam/ansysToFoam.L | 2 +- .../mesh/conversion/ccm/ccmToFoam/ccmToFoam.C | 24 +- .../mesh/conversion/ccm/foamToCcm/foamToCcm.C | 18 +- .../mesh/conversion/cfx4ToFoam/cfx4ToFoam.C | 2 +- .../mesh/conversion/fireToFoam/fireToFoam.C | 6 +- .../fluent3DMeshToFoam/fluent3DMeshToFoam.L | 8 +- .../fluentMeshToFoam/fluentMeshToFoam.L | 8 +- .../foamToFireMesh/foamToFireMesh.C | 6 +- .../foamToStarMesh/foamToStarMesh.C | 6 +- .../conversion/foamToSurface/foamToSurface.C | 4 +- .../conversion/gambitToFoam/gambitToFoam.L | 2 +- .../mesh/conversion/gmshToFoam/gmshToFoam.C | 4 +- .../ideasUnvToFoam/ideasUnvToFoam.C | 2 +- .../mesh/conversion/kivaToFoam/kivaToFoam.C | 6 +- .../mesh/conversion/mshToFoam/mshToFoam.C | 2 +- .../conversion/plot3dToFoam/plot3dToFoam.C | 8 +- .../mesh/conversion/star4ToFoam/star4ToFoam.C | 6 +- .../conversion/tetgenToFoam/tetgenToFoam.C | 2 +- .../conversion/writeMeshObj/writeMeshObj.C | 20 +- .../mesh/generation/blockMesh/blockMesh.C | 12 +- .../extrude/extrudeMesh/extrudeMesh.C | 2 +- .../extrudeToRegionMesh/extrudeToRegionMesh.C | 9 +- .../extrude2DMesh/extrude2DMeshApp.C | 2 +- .../foamyMesh/foamyHexMesh/foamyHexMesh.C | 6 +- .../foamyHexMeshBackgroundMesh.C | 6 +- .../foamyHexMeshSurfaceSimplify_non_octree.C | 2 +- .../foamyMesh/foamyQuadMesh/foamyQuadMesh.C | 4 +- .../generation/snappyHexMesh/snappyHexMesh.C | 19 +- .../mesh/manipulation/attachMesh/attachMesh.C | 2 +- .../mesh/manipulation/autoPatch/autoPatch.C | 4 +- .../mesh/manipulation/checkMesh/checkMesh.C | 14 +- .../createBaffles/createBaffles.C | 2 +- .../manipulation/createPatch/createPatch.C | 6 +- .../manipulation/deformedGeom/deformedGeom.C | 2 +- .../manipulation/mergeMeshes/mergeMeshes.C | 8 +- .../mergeOrSplitBaffles/mergeOrSplitBaffles.C | 8 +- .../mesh/manipulation/mirrorMesh/mirrorMesh.C | 2 +- .../moveDynamicMesh/moveDynamicMesh.C | 2 +- .../orientFaceZone/orientFaceZone.C | 2 +- .../polyDualMesh/polyDualMeshApp.C | 13 +- .../mesh/manipulation/refineMesh/refineMesh.C | 6 +- .../manipulation/renumberMesh/renumberMesh.C | 6 +- .../mesh/manipulation/rotateMesh/rotateMesh.C | 4 +- .../mesh/manipulation/setSet/setSet.C | 8 +- .../manipulation/setsToZones/setsToZones.C | 2 +- .../mesh/manipulation/splitMesh/splitMesh.C | 2 +- .../splitMeshRegions/splitMeshRegions.C | 26 +- .../mesh/manipulation/stitchMesh/stitchMesh.C | 20 +- .../mesh/manipulation/subsetMesh/subsetMesh.C | 10 +- .../mesh/manipulation/topoSet/topoSet.C | 2 +- .../transformPoints/transformPoints.C | 28 +- .../foamDictionary/foamDictionary.C | 26 +- .../foamFormatConvert/foamFormatConvert.C | 6 +- .../helpTypes/helpBoundary/helpBoundary.C | 10 +- .../helpFunctionObject/helpFunctionObject.C | 2 +- .../helpTypes/helpSolver/helpSolver.C | 4 +- .../foamListTimes/foamListTimes.C | 4 +- .../miscellaneous/patchSummary/patchSummary.C | 2 +- .../decomposePar/decomposePar.C | 24 +- .../reconstructPar/reconstructPar.C | 16 +- .../reconstructParMesh/reconstructParMesh.C | 11 +- .../redistributePar/redistributePar.C | 16 +- .../foamToEnsight/foamToEnsight.C | 28 +- .../foamToEnsightParts/foamToEnsightParts.C | 12 +- .../foamToTecplot360/foamToTecplot360.C | 24 +- .../dataConversion/foamToVTK/foamToVTK.C | 48 +-- .../lumpedPointForces/lumpedPointForces.C | 2 +- .../lumpedPointMovement/lumpedPointMovement.C | 10 +- .../lumpedPointZones/lumpedPointZones.C | 2 +- .../temporalInterpolate/temporalInterpolate.C | 10 +- .../postProcessing/postProcess/postProcess.C | 10 +- .../applyBoundaryLayer/applyBoundaryLayer.C | 6 +- .../applyBoundaryLayer/createFields.H | 8 +- .../changeDictionary/changeDictionary.C | 12 +- .../createExternalCoupledPatchGeometry.C | 8 +- .../createZeroDirectory/createZeroDirectory.C | 2 +- .../foamUpgradeCyclics/foamUpgradeCyclics.C | 6 +- .../preProcessing/mapFields/mapFields.C | 16 +- .../preProcessing/mapFields/setTimeIndex.H | 4 +- .../preProcessing/mapFieldsPar/mapFieldsPar.C | 18 +- .../preProcessing/mapFieldsPar/setTimeIndex.H | 4 +- .../utilities/surface/surfaceAdd/surfaceAdd.C | 6 +- .../surfaceBooleanFeatures.C | 14 +- .../surface/surfaceCheck/surfaceCheck.C | 8 +- .../surface/surfaceClean/surfaceClean.C | 8 +- .../surface/surfaceCoarsen/surfaceCoarsen.C | 4 +- .../surface/surfaceConvert/surfaceConvert.C | 26 +- .../surfaceFeatureConvert.C | 2 +- .../surface/surfaceFind/surfaceFind.C | 6 +- .../surface/surfaceHookUp/surfaceHookUp.C | 2 +- .../surface/surfaceInertia/surfaceInertia.C | 6 +- .../surface/surfaceInflate/surfaceInflate.C | 12 +- .../surfaceLambdaMuSmooth.C | 8 +- .../surfaceMeshConvert/surfaceMeshConvert.C | 16 +- .../surfaceMeshExport/surfaceMeshExport.C | 16 +- .../surfaceMeshImport/surfaceMeshImport.C | 16 +- .../surface/surfaceMeshInfo/surfaceMeshInfo.C | 6 +- .../surfaceMeshTriangulate.C | 10 +- .../surface/surfaceOrient/surfaceOrient.C | 8 +- .../surfacePointMerge/surfacePointMerge.C | 4 +- .../surfaceRedistributePar.C | 4 +- .../surfaceSplitNonManifolds.C | 2 +- .../surface/surfaceToPatch/surfaceToPatch.C | 4 +- .../surfaceTransformPoints.C | 24 +- .../chemkinToFoam/chemkinToFoam.C | 2 +- src/OpenFOAM/db/Time/Time.C | 6 +- src/OpenFOAM/db/Time/timeSelector.C | 22 +- .../functionObjectList/functionObjectList.C | 8 +- .../functionObjectList/postProcess.H | 2 +- src/OpenFOAM/global/argList/argList.C | 160 ++++---- src/OpenFOAM/global/argList/argList.H | 385 ++++++++++-------- src/OpenFOAM/global/argList/argListI.H | 256 +++++++----- src/OpenFOAM/include/checkConstantOption.H | 2 +- src/OpenFOAM/include/checkTimeOption.H | 6 +- src/OpenFOAM/include/createNamedMesh.H | 5 +- src/OpenFOAM/include/createNamedPolyMesh.H | 5 +- src/OpenFOAM/include/listOutput.H | 20 +- .../include/setConstantMeshDictionaryIO.H | 2 +- .../include/setSystemMeshDictionaryIO.H | 2 +- .../include/setSystemRunTimeDictionaryIO.H | 2 +- .../include/createNamedDynamicFvMesh.H | 6 +- .../calcRadiusField/calcRadiusField.C | 2 +- 168 files changed, 1161 insertions(+), 1040 deletions(-) diff --git a/applications/solvers/basic/potentialFoam/createFields.H b/applications/solvers/basic/potentialFoam/createFields.H index eda7cbc0c2..fb699bddf0 100644 --- a/applications/solvers/basic/potentialFoam/createFields.H +++ b/applications/solvers/basic/potentialFoam/createFields.H @@ -28,7 +28,7 @@ surfaceScalarField phi fvc::flux(U) ); -if (args.optionFound("initialiseUBCs")) +if (args.found("initialiseUBCs")) { U.correctBoundaryConditions(); phi = fvc::flux(U); @@ -41,7 +41,7 @@ if (args.optionFound("initialiseUBCs")) word pName("p"); // Update name of the pressure field from the command-line option -args.optionReadIfPresent("pName", pName); +args.readIfPresent("pName", pName); // Infer the pressure BCs from the velocity wordList pBCTypes diff --git a/applications/solvers/basic/potentialFoam/overPotentialFoam/createFields.H b/applications/solvers/basic/potentialFoam/overPotentialFoam/createFields.H index b7daa4fe47..0dae19a0de 100644 --- a/applications/solvers/basic/potentialFoam/overPotentialFoam/createFields.H +++ b/applications/solvers/basic/potentialFoam/overPotentialFoam/createFields.H @@ -28,7 +28,7 @@ surfaceScalarField phi fvc::flux(U) ); -if (args.optionFound("initialiseUBCs")) +if (args.found("initialiseUBCs")) { U.correctBoundaryConditions(); phi = fvc::flux(U); @@ -41,7 +41,7 @@ if (args.optionFound("initialiseUBCs")) word pName("p"); // Update name of the pressure field from the command-line option -args.optionReadIfPresent("pName", pName); +args.readIfPresent("pName", pName); // Infer the pressure BCs from the velocity wordList pBCTypes diff --git a/applications/solvers/basic/potentialFoam/overPotentialFoam/potentialFoam.C b/applications/solvers/basic/potentialFoam/overPotentialFoam/potentialFoam.C index 7d340fbc36..d63f664a5c 100644 --- a/applications/solvers/basic/potentialFoam/overPotentialFoam/potentialFoam.C +++ b/applications/solvers/basic/potentialFoam/overPotentialFoam/potentialFoam.C @@ -193,13 +193,13 @@ int main(int argc, char *argv[]) phi.write(); // Optionally write Phi - if (args.optionFound("writePhi")) + if (args.found("writePhi")) { Phi.write(); } // Calculate the pressure field from the Euler equation - if (args.optionFound("writep")) + if (args.found("writep")) { Info<< nl << "Calculating approximate pressure field" << endl; diff --git a/applications/solvers/basic/potentialFoam/potentialFoam.C b/applications/solvers/basic/potentialFoam/potentialFoam.C index dfc80be425..b0e2b93538 100644 --- a/applications/solvers/basic/potentialFoam/potentialFoam.C +++ b/applications/solvers/basic/potentialFoam/potentialFoam.C @@ -181,13 +181,13 @@ int main(int argc, char *argv[]) phi.write(); // Optionally write Phi - if (args.optionFound("writePhi")) + if (args.found("writePhi")) { Phi.write(); } // Calculate the pressure field from the Euler equation - if (args.optionFound("writep")) + if (args.found("writep")) { Info<< nl << "Calculating approximate pressure field" << endl; diff --git a/applications/solvers/electromagnetics/magneticFoam/magneticFoam.C b/applications/solvers/electromagnetics/magneticFoam/magneticFoam.C index 6613d2f206..9430aeb8e7 100644 --- a/applications/solvers/electromagnetics/magneticFoam/magneticFoam.C +++ b/applications/solvers/electromagnetics/magneticFoam/magneticFoam.C @@ -86,7 +86,7 @@ int main(int argc, char *argv[]) psi.write(); - if (!args.optionFound("noH") || args.optionFound("HdotGradH")) + if (!args.found("noH") || args.found("HdotGradH")) { volVectorField H ( @@ -99,7 +99,7 @@ int main(int argc, char *argv[]) fvc::reconstruct(fvc::snGrad(psi)*mesh.magSf()) ); - if (!args.optionFound("noH")) + if (!args.found("noH")) { Info<< nl << "Creating field H for time " @@ -108,7 +108,7 @@ int main(int argc, char *argv[]) H.write(); } - if (args.optionFound("HdotGradH")) + if (args.found("HdotGradH")) { Info<< nl << "Creating field HdotGradH for time " @@ -129,7 +129,7 @@ int main(int argc, char *argv[]) } } - if (!args.optionFound("noB")) + if (!args.found("noB")) { Info<< nl << "Creating field B for time " diff --git a/applications/solvers/lagrangian/DPMFoam/createFields.H b/applications/solvers/lagrangian/DPMFoam/createFields.H index 49f280e428..218388f5c5 100644 --- a/applications/solvers/lagrangian/DPMFoam/createFields.H +++ b/applications/solvers/lagrangian/DPMFoam/createFields.H @@ -123,7 +123,7 @@ volScalarField alphac ); word kinematicCloudName("kinematicCloud"); -args.optionReadIfPresent("cloud", kinematicCloudName); +args.readIfPresent("cloud", kinematicCloudName); Info<< "Constructing kinematicCloud " << kinematicCloudName << endl; basicKinematicTypeCloud kinematicCloud diff --git a/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/createFields.H b/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/createFields.H index 76c70fffd9..fe2134e3c8 100644 --- a/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/createFields.H +++ b/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/createFields.H @@ -58,7 +58,7 @@ volScalarField mu ); word kinematicCloudName("kinematicCloud"); -args.optionReadIfPresent("cloud", kinematicCloudName); +args.readIfPresent("cloud", kinematicCloudName); Info<< "Constructing kinematicCloud " << kinematicCloudName << endl; basicKinematicCollidingCloud kinematicCloud diff --git a/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/createFields.H b/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/createFields.H index 9aa648ce5f..e8dd95b2e8 100644 --- a/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/createFields.H +++ b/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/createFields.H @@ -51,7 +51,7 @@ autoPtr turbulence const word kinematicCloudName ( - args.optionLookupOrDefault("cloud", "kinematicCloud") + args.lookupOrDefault("cloud", "kinematicCloud") ); Info<< "Constructing kinematicCloud " << kinematicCloudName << endl; diff --git a/applications/test/FixedList2/Test-FixedList2.C b/applications/test/FixedList2/Test-FixedList2.C index efd3cfabdc..5cca80e7a3 100644 --- a/applications/test/FixedList2/Test-FixedList2.C +++ b/applications/test/FixedList2/Test-FixedList2.C @@ -96,7 +96,7 @@ int main(int argc, char *argv[]) Info<< nl << "Specify an option! " << nl << endl; } - if (args.optionFound("label")) + if (args.found("label")) { FixedList list1(1); FixedList list2(0); @@ -104,7 +104,7 @@ int main(int argc, char *argv[]) runSwapTest(1000001, list1, list2); } - if (args.optionFound("float")) + if (args.found("float")) { FixedList list1(1.0); FixedList list2(0.0); @@ -112,7 +112,7 @@ int main(int argc, char *argv[]) runSwapTest(1000001, list1, list2); } - if (args.optionFound("vector")) + if (args.found("vector")) { FixedList list1(vector::one); FixedList list2(vector::zero); @@ -120,7 +120,7 @@ int main(int argc, char *argv[]) runSwapTest(100001, list1, list2); } - if (args.optionFound("labelList")) + if (args.found("labelList")) { typedef labelList testType; testType initVal(500); @@ -134,7 +134,7 @@ int main(int argc, char *argv[]) runSwapTest(100001, list1, list2); } - if (args.optionFound("vectorList")) + if (args.found("vectorList")) { typedef vectorList testType; testType initVal(500); @@ -148,7 +148,7 @@ int main(int argc, char *argv[]) runSwapTest(100001, list1, list2); } - if (args.optionFound("fixedLabel")) + if (args.found("fixedLabel")) { typedef FixedList testType; @@ -163,7 +163,7 @@ int main(int argc, char *argv[]) runSwapTest(100001, list1, list2); } - if (args.optionFound("fixedLabelList")) + if (args.found("fixedLabelList")) { typedef labelList testType; typedef FixedList containerType; diff --git a/applications/test/GAMGAgglomeration/Test-GAMGAgglomeration.C b/applications/test/GAMGAgglomeration/Test-GAMGAgglomeration.C index 611c8163bc..434dd05986 100644 --- a/applications/test/GAMGAgglomeration/Test-GAMGAgglomeration.C +++ b/applications/test/GAMGAgglomeration/Test-GAMGAgglomeration.C @@ -53,8 +53,8 @@ int main(int argc, char *argv[]) #include "setRootCase.H" #include "createTime.H" - bool writeObj = args.optionFound("writeObj"); - bool normalise = args.optionFound("normalise"); + bool writeObj = args.found("writeObj"); + bool normalise = args.found("normalise"); #include "createMesh.H" diff --git a/applications/test/HashTable4/Test-HashTable4.C b/applications/test/HashTable4/Test-HashTable4.C index b9333f320d..343d89e07e 100644 --- a/applications/test/HashTable4/Test-HashTable4.C +++ b/applications/test/HashTable4/Test-HashTable4.C @@ -151,9 +151,9 @@ int main(int argc, char *argv[]) argList args(argc, argv); - const bool optStd = args.optionFound("std"); - const bool optSet = args.optionFound("set"); - const bool optFnd = args.optionFound("find"); + const bool optStd = args.found("std"); + const bool optSet = args.found("set"); + const bool optFnd = args.found("find"); cpuTime timer; diff --git a/applications/test/IOobjectList/Test-IOobjectList.C b/applications/test/IOobjectList/Test-IOobjectList.C index 27bd495950..21ab2fafaf 100644 --- a/applications/test/IOobjectList/Test-IOobjectList.C +++ b/applications/test/IOobjectList/Test-IOobjectList.C @@ -49,9 +49,9 @@ int main(int argc, char *argv[]) #include "createTime.H" wordReList matcher; - if (args.optionFound("re")) + if (args.found("re")) { - matcher = args.optionReadList("re"); + matcher = args.readList("re"); Info<<"limit names: " << matcher << nl; } diff --git a/applications/test/IndirectList/Test-IndirectList.C b/applications/test/IndirectList/Test-IndirectList.C index 449af8ca7d..17120cc098 100644 --- a/applications/test/IndirectList/Test-IndirectList.C +++ b/applications/test/IndirectList/Test-IndirectList.C @@ -117,7 +117,7 @@ int main(int argc, char *argv[]) printInfo(idl3); fileName binaryOutput; - if (args.optionReadIfPresent("binary", binaryOutput)) + if (args.readIfPresent("binary", binaryOutput)) { Info<<"Writing output to " << binaryOutput << endl; diff --git a/applications/test/List/Test-List.C b/applications/test/List/Test-List.C index cfb709bf3b..ec4ec9e5a1 100644 --- a/applications/test/List/Test-List.C +++ b/applications/test/List/Test-List.C @@ -331,29 +331,29 @@ int main(int argc, char *argv[]) scalar xxx(-1); - if (args.optionFound("flag")) + if (args.found("flag")) { Info<<"-flag:" << args["flag"] << endl; } - if (args.optionReadIfPresent("float", xxx)) + if (args.readIfPresent("float", xxx)) { Info<<"read float " << xxx << endl; } - if (args.optionFound("reList")) + if (args.found("reList")) { - reLst = args.optionReadList("reList"); + reLst = args.readList("reList"); } - if (args.optionFound("wordList")) + if (args.found("wordList")) { - wLst = args.optionReadList("wordList"); + wLst = args.readList("wordList"); } - if (args.optionFound("stringList")) + if (args.found("stringList")) { - sLst = args.optionReadList("stringList"); + sLst = args.readList("stringList"); } Info<< nl diff --git a/applications/test/List2/Test-List2.C b/applications/test/List2/Test-List2.C index 0be3acda63..e6183bd553 100644 --- a/applications/test/List2/Test-List2.C +++ b/applications/test/List2/Test-List2.C @@ -212,28 +212,28 @@ int main(int argc, char *argv[]) std::initializer_list