From a43eb01b7e949cc628595ca828fe287e5c84af60 Mon Sep 17 00:00:00 2001
From: Mark Olesen <Mark.Olesen@esi-group.com>
Date: Mon, 7 Jan 2019 09:20:51 +0100
Subject: [PATCH] ENH: for-range, forAllIters() ... in finiteVolume/

- reduced clutter when iterating over containers
---
 .../solutionControlTemplates.C                | 25 +++++----
 .../singleCellFvMesh/singleCellFvMesh.C       | 18 +++----
 .../multivariateScheme/multivariateScheme.C   |  7 ++-
 .../multivariateSelectionScheme.C             |  7 ++-
 .../volPointInterpolation/pointConstraints.C  | 51 ++++++++++---------
 .../pairPatchAgglomeration.C                  |  2 +-
 .../oversetPolyPatch/oversetGAMGInterface.C   | 16 +++---
 ...sRadiativeCoupledMixedFvPatchScalarField.C | 10 ++--
 8 files changed, 67 insertions(+), 69 deletions(-)

diff --git a/src/finiteVolume/cfdTools/general/solutionControl/solutionControl/solutionControlTemplates.C b/src/finiteVolume/cfdTools/general/solutionControl/solutionControl/solutionControlTemplates.C
index f7f0425e54..4c62431f92 100644
--- a/src/finiteVolume/cfdTools/general/solutionControl/solutionControl/solutionControlTemplates.C
+++ b/src/finiteVolume/cfdTools/general/solutionControl/solutionControl/solutionControlTemplates.C
@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           |
+    \\  /    A nd           | Copyright (C) 2019 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
                             | Copyright (C) 2011-2013 OpenFOAM Foundation
@@ -36,24 +36,23 @@ void Foam::solutionControl::storePrevIter() const
 {
     typedef GeometricField<Type, fvPatchField, volMesh> GeoField;
 
-    HashTable<GeoField*>
-        flds(mesh_.objectRegistry::lookupClass<GeoField>());
+    HashTable<GeoField*> flds(mesh_.objectRegistry::lookupClass<GeoField>());
 
-    forAllIter(typename HashTable<GeoField*>, flds, iter)
+    forAllIters(flds, iter)
     {
         GeoField& fld = *iter();
 
-        const word& fName = fld.name();
+        const word& fldName = fld.name();
 
-        size_t prevIterField = fName.find("PrevIter");
-
-        if ((prevIterField == word::npos) && mesh_.relaxField(fName))
+        if
+        (
+            (fldName.find("PrevIter") == std::string::npos)
+         && mesh_.relaxField(fldName)
+        )
         {
-            if (debug)
-            {
-                Info<< algorithmName_ << ": storing previous iter for "
-                    << fName << endl;
-            }
+            DebugInfo
+                << algorithmName_ << ": storing previous iter for "
+                << fldName << endl;
 
             fld.storePrevIter();
         }
diff --git a/src/finiteVolume/fvMesh/singleCellFvMesh/singleCellFvMesh.C b/src/finiteVolume/fvMesh/singleCellFvMesh/singleCellFvMesh.C
index 074c0c447a..0b149f1317 100644
--- a/src/finiteVolume/fvMesh/singleCellFvMesh/singleCellFvMesh.C
+++ b/src/finiteVolume/fvMesh/singleCellFvMesh/singleCellFvMesh.C
@@ -104,18 +104,12 @@ void Foam::singleCellFvMesh::agglomerateMesh
                     label myZone = agglom[patchi][i];
                     label nbrZone = nbrAgglom[bFacei];
 
-                    Map<label>::const_iterator iter = localToNbr.find(myZone);
+                    const auto iter = localToNbr.cfind(myZone);
 
-                    if (iter == localToNbr.end())
-                    {
-                        // First occurrence of this zone. Store correspondence
-                        // to remote zone number.
-                        localToNbr.insert(myZone, nbrZone);
-                    }
-                    else
+                    if (iter.found())
                     {
                         // Check that zone numbers are still the same.
-                        if (iter() != nbrZone)
+                        if (iter.val() != nbrZone)
                         {
                             FatalErrorInFunction
                                 << "agglomeration is not synchronised across"
@@ -126,6 +120,12 @@ void Foam::singleCellFvMesh::agglomerateMesh
                                 << exit(FatalError);
                         }
                     }
+                    else
+                    {
+                        // First occurrence of this zone. Store correspondence
+                        // to remote zone number.
+                        localToNbr.insert(myZone, nbrZone);
+                    }
                 }
             }
         }
diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/multivariateSchemes/multivariateScheme/multivariateScheme.C b/src/finiteVolume/interpolation/surfaceInterpolation/multivariateSchemes/multivariateScheme/multivariateScheme.C
index f571dd2a0c..0edcc7b37c 100644
--- a/src/finiteVolume/interpolation/surfaceInterpolation/multivariateSchemes/multivariateScheme/multivariateScheme.C
+++ b/src/finiteVolume/interpolation/surfaceInterpolation/multivariateSchemes/multivariateScheme/multivariateScheme.C
@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           |
+    \\  /    A nd           | Copyright (C) 2019 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
                             | Copyright (C) 2011 OpenFOAM Foundation
@@ -62,15 +62,14 @@ Foam::multivariateScheme<Type, Scheme>::multivariateScheme
         dimless
     )
 {
-    typename multivariateSurfaceInterpolationScheme<Type>::
-        fieldTable::const_iterator iter = this->fields().begin();
+    auto iter = this->fields().cbegin();
 
     surfaceScalarField limiter
     (
         Scheme(mesh, faceFlux_, *this).limiter(*iter())
     );
 
-    for (++iter; iter != this->fields().end(); ++iter)
+    for (++iter; iter.good(); ++iter)
     {
         limiter = min
         (
diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/multivariateSchemes/multivariateSelectionScheme/multivariateSelectionScheme.C b/src/finiteVolume/interpolation/surfaceInterpolation/multivariateSchemes/multivariateSelectionScheme/multivariateSelectionScheme.C
index 5ed89556ad..0bf6603f22 100644
--- a/src/finiteVolume/interpolation/surfaceInterpolation/multivariateSchemes/multivariateSelectionScheme/multivariateSelectionScheme.C
+++ b/src/finiteVolume/interpolation/surfaceInterpolation/multivariateSchemes/multivariateSelectionScheme/multivariateSelectionScheme.C
@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           |
+    \\  /    A nd           | Copyright (C) 2019 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
                             | Copyright (C) 2011 OpenFOAM Foundation
@@ -65,8 +65,7 @@ Foam::multivariateSelectionScheme<Type>::multivariateSelectionScheme
         dimless
     )
 {
-    typename multivariateSurfaceInterpolationScheme<Type>::
-        fieldTable::const_iterator iter = this->fields().begin();
+    auto iter = this->fields().cbegin();
 
     surfaceScalarField limiter
     (
@@ -78,7 +77,7 @@ Foam::multivariateSelectionScheme<Type>::multivariateSelectionScheme
         )().limiter(*iter())
     );
 
-    for (++iter; iter != this->fields().end(); ++iter)
+    for (++iter; iter.good(); ++iter)
     {
         limiter = min
         (
diff --git a/src/finiteVolume/interpolation/volPointInterpolation/pointConstraints.C b/src/finiteVolume/interpolation/volPointInterpolation/pointConstraints.C
index dc09c5659a..618814919b 100644
--- a/src/finiteVolume/interpolation/volPointInterpolation/pointConstraints.C
+++ b/src/finiteVolume/interpolation/volPointInterpolation/pointConstraints.C
@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2017 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2017-2019 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
                             | Copyright (C) 2013-2016 OpenFOAM Foundation
@@ -109,22 +109,22 @@ void Foam::pointConstraints::makePatchPatchAddressing()
 
             forAll(bp, pointi)
             {
-                label ppp = meshPoints[bp[pointi]];
+                const label ppp = meshPoints[bp[pointi]];
 
-                Map<label>::iterator iter = patchPatchPointSet.find(ppp);
+                const auto iter = patchPatchPointSet.cfind(ppp);
 
                 label constraintI = -1;
 
-                if (iter == patchPatchPointSet.end())
+                if (iter.found())
+                {
+                    constraintI = iter.val();
+                }
+                else
                 {
                     patchPatchPointSet.insert(ppp, pppi);
                     patchPatchPoints[pppi] = ppp;
                     constraintI = pppi++;
                 }
-                else
-                {
-                    constraintI = iter();
-                }
 
                 // Apply to patch constraints
                 pbm[patchi].applyConstraint
@@ -169,14 +169,15 @@ void Foam::pointConstraints::makePatchPatchAddressing()
 
                 forAll(bp, pointi)
                 {
-                    label ppp = meshPoints[bp[pointi]];
+                    const label ppp = meshPoints[bp[pointi]];
 
-                    Map<label>::const_iterator fnd = cpPointMap.find(ppp);
-                    if (fnd != cpPointMap.end())
+                    const auto iter = cpPointMap.cfind(ppp);
+
+                    if (iter.found())
                     {
                         // Can just copy (instead of apply) constraint
                         // will already be consistent across multiple patches.
-                        constraints[fnd()] = patchPatchPointConstraints_
+                        constraints[iter.val()] = patchPatchPointConstraints_
                         [
                             patchPatchPointSet[ppp]
                         ];
@@ -219,11 +220,22 @@ void Foam::pointConstraints::makePatchPatchAddressing()
             {
                 label meshPointi = cpMeshPoints[coupledPointi];
 
-                Map<label>::iterator iter = patchPatchPointSet.find(meshPointi);
+                const auto iter = patchPatchPointSet.cfind(meshPointi);
 
                 label constraintI = -1;
 
-                if (iter == patchPatchPointSet.end())
+                if (iter.found())
+                {
+                    //Pout<< indent << "on meshpoint:" << meshPointi
+                    //    << " coupled:" << coupledPointi
+                    //    << " at:" << mesh.points()[meshPointi]
+                    //    << " have possibly extended constraint:"
+                    //    << constraints[coupledPointi]
+                    //    << endl;
+
+                    constraintI = iter.val();
+                }
+                else
                 {
                     //Pout<< indent << "on meshpoint:" << meshPointi
                     //    << " coupled:" << coupledPointi
@@ -250,17 +262,6 @@ void Foam::pointConstraints::makePatchPatchAddressing()
                     patchPatchPoints[pppi] = meshPointi;
                     constraintI = pppi++;
                 }
-                else
-                {
-                    //Pout<< indent << "on meshpoint:" << meshPointi
-                    //    << " coupled:" << coupledPointi
-                    //    << " at:" << mesh.points()[meshPointi]
-                    //    << " have possibly extended constraint:"
-                    //    << constraints[coupledPointi]
-                    //    << endl;
-
-                    constraintI = iter();
-                }
 
                 // Combine (new or existing) constraint with one
                 // on coupled.
diff --git a/src/fvAgglomerationMethods/pairPatchAgglomeration/pairPatchAgglomeration.C b/src/fvAgglomerationMethods/pairPatchAgglomeration/pairPatchAgglomeration.C
index 949d9c9123..e01609eb13 100644
--- a/src/fvAgglomerationMethods/pairPatchAgglomeration/pairPatchAgglomeration.C
+++ b/src/fvAgglomerationMethods/pairPatchAgglomeration/pairPatchAgglomeration.C
@@ -129,7 +129,7 @@ void Foam::pairPatchAgglomeration::setEdgeWeights
     edgeHashSet fineFeaturedFaces(coarsePatch.nEdges()/10);
 
     // Map fine faces with featured edge into coarse faces
-    forAllConstIter(EdgeMap<scalar>, facePairWeight_, iter)
+    forAllConstIters(facePairWeight_, iter)
     {
         if (iter() == -1.0)
         {
diff --git a/src/overset/oversetPolyPatch/oversetGAMGInterface.C b/src/overset/oversetPolyPatch/oversetGAMGInterface.C
index 74a166d645..63fb3c0dd9 100644
--- a/src/overset/oversetPolyPatch/oversetGAMGInterface.C
+++ b/src/overset/oversetPolyPatch/oversetGAMGInterface.C
@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2017 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2017-2019 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -81,17 +81,17 @@ Foam::oversetGAMGInterface::oversetGAMGInterface
         label coarseCelli = localRestrictAddressing[ffi];
 
         // Do we have coarse face for it?
-        Map<label>::iterator iter = cellToCoarseFace.find(coarseCelli);
-        if (iter == cellToCoarseFace.end())
+        const auto iter = cellToCoarseFace.cfind(coarseCelli);
+        if (iter.found())
         {
-            label coarseFacei = dynFaceCells.size();
-            cellToCoarseFace.insert(coarseCelli, coarseFacei);
-            dynFaceCells.append(coarseCelli);
-            dynFaceRestrictAddressing.append(coarseFacei);
+            dynFaceRestrictAddressing.append(iter.val());
         }
         else
         {
-            dynFaceRestrictAddressing.append(iter());
+            const label coarseFacei = dynFaceCells.size();
+            cellToCoarseFace.insert(coarseCelli, coarseFacei);
+            dynFaceCells.append(coarseCelli);
+            dynFaceRestrictAddressing.append(coarseFacei);
         }
     }
 
diff --git a/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisRadiativeCoupledMixed/filmPyrolysisRadiativeCoupledMixedFvPatchScalarField.C b/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisRadiativeCoupledMixed/filmPyrolysisRadiativeCoupledMixedFvPatchScalarField.C
index 4a17110c6e..b06050e379 100644
--- a/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisRadiativeCoupledMixed/filmPyrolysisRadiativeCoupledMixedFvPatchScalarField.C
+++ b/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisRadiativeCoupledMixed/filmPyrolysisRadiativeCoupledMixedFvPatchScalarField.C
@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           |
+    \\  /    A nd           | Copyright (C) 2019 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
                             | Copyright (C) 2013-2017 OpenFOAM Foundation
@@ -43,7 +43,7 @@ filmModel() const
     HashTable<const filmModelType*> models
         = db().time().lookupClass<filmModelType>();
 
-    forAllConstIter(HashTable<const filmModelType*>, models, iter)
+    forAllConstIters(models, iter)
     {
         if (iter()->regionMesh().name() == filmRegionName_)
         {
@@ -52,7 +52,7 @@ filmModel() const
     }
 
     DynamicList<word> modelNames;
-    forAllConstIter(HashTable<const filmModelType*>, models, iter)
+    forAllConstIters(models, iter)
     {
         modelNames.append(iter()->regionMesh().name());
     }
@@ -74,7 +74,7 @@ pyrModel() const
     HashTable<const pyrolysisModelType*> models =
         db().time().lookupClass<pyrolysisModelType>();
 
-    forAllConstIter(HashTable<const pyrolysisModelType*>, models, iter)
+    forAllConstIters(models, iter)
     {
         if (iter()->regionMesh().name() == pyrolysisRegionName_)
         {
@@ -83,7 +83,7 @@ pyrModel() const
     }
 
     DynamicList<word> modelNames;
-    forAllConstIter(HashTable<const pyrolysisModelType*>, models, iter)
+    forAllConstIters(models, iter)
     {
         modelNames.append(iter()->regionMesh().name());
     }