From e5892377d82cfbecb2cad5b5b3cd7afe271c7548 Mon Sep 17 00:00:00 2001
From: Henry Weller <http://cfd.direct>
Date: Mon, 27 Sep 2021 14:25:58 +0100
Subject: [PATCH] snappyHexMesh::refinementParameters: Rationalised handling of
 cell region selection parameters

---
 .../meshRefinement/meshRefinement.C           | 18 +++++-----
 .../meshRefinement/meshRefinement.H           | 11 +++---
 .../meshRefinement/meshRefinementBaffles.C    | 12 +++----
 .../refinementParameters.C                    | 26 ++++++++------
 .../refinementParameters.H                    | 35 ++++++++++++++++---
 .../snappyHexMeshDriver/snappyRefineDriver.C  | 18 +++++-----
 6 files changed, 75 insertions(+), 45 deletions(-)

diff --git a/src/mesh/snappyHexMesh/meshRefinement/meshRefinement.C b/src/mesh/snappyHexMesh/meshRefinement/meshRefinement.C
index 6b4639d54e..d7ed8def83 100644
--- a/src/mesh/snappyHexMesh/meshRefinement/meshRefinement.C
+++ b/src/mesh/snappyHexMesh/meshRefinement/meshRefinement.C
@@ -2125,24 +2125,24 @@ void Foam::meshRefinement::findRegions
     const polyMesh& mesh,
     labelList& cellRegion,
     const vector& perturbVec,
-    const List<point>& locationsInMesh
+    const refinementParameters::locations& meshLocations
 )
 {
     // List of all cells inside any of the regions
-    // which have a point in the locationsInMesh list
+    // which have a point in the meshLocations.inside() list
     PackedBoolList insideCells(mesh.nCells());
 
-    // For each of the locationsInMesh find the corresponding region
+    // For each of the meshLocations.inside() find the corresponding region
     // and mark the cells
-    forAll(locationsInMesh, i)
+    forAll(meshLocations.inside(), i)
     {
-        // Find the region corresponding to the locationsInMesh[i]
+        // Find the region corresponding to the meshLocations.inside()[i]
         const label regioni = findRegion
         (
             mesh,
             cellRegion,
             perturbVec,
-            locationsInMesh[i]
+            meshLocations.inside()[i]
         );
 
         // Add all the cells in the region to insideCells
@@ -2170,7 +2170,7 @@ Foam::autoPtr<Foam::mapPolyMesh> Foam::meshRefinement::splitMeshRegions
 (
     const labelList& globalToMasterPatch,
     const labelList& globalToSlavePatch,
-    const List<point>& locationsInMesh
+    const refinementParameters::locations& meshLocations
 )
 {
     // Force calculation of face decomposition (used in findCell)
@@ -2189,7 +2189,7 @@ Foam::autoPtr<Foam::mapPolyMesh> Foam::meshRefinement::splitMeshRegions
         mesh_,
         cellRegion,
         mergeDistance_*vector::one,
-        locationsInMesh
+        meshLocations
     );
 
     // Subset
@@ -2218,7 +2218,7 @@ Foam::autoPtr<Foam::mapPolyMesh> Foam::meshRefinement::splitMeshRegions
         reduce(nCellsToKeep, sumOp<label>());
 
         Info<< "Keeping all cells in regions containing any point in "
-            << locationsInMesh << endl
+            << meshLocations.inside() << endl
             << "Selected for keeping : " << nCellsToKeep << " cells." << endl;
 
         // Remove cells
diff --git a/src/mesh/snappyHexMesh/meshRefinement/meshRefinement.H b/src/mesh/snappyHexMesh/meshRefinement/meshRefinement.H
index c1d9385866..04fa83d335 100644
--- a/src/mesh/snappyHexMesh/meshRefinement/meshRefinement.H
+++ b/src/mesh/snappyHexMesh/meshRefinement/meshRefinement.H
@@ -51,6 +51,7 @@ SourceFiles
 #include "pointFieldsFwd.H"
 #include "Tuple2.H"
 #include "pointIndexHit.H"
+#include "refinementParameters.H"
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
@@ -838,7 +839,7 @@ public:
                 Time& runTime,
                 const labelList& globalToMasterPatch,
                 const labelList& globalToSlavePatch,
-                const List<point>& locationsInMesh
+                const refinementParameters::locations& meshLocations
             );
 
             //- Split off (with optional buffer layers) unreachable areas
@@ -848,7 +849,7 @@ public:
                 const label nBufferLayers,
                 const labelList& globalToMasterPatch,
                 const labelList& globalToSlavePatch,
-                const List<point>& locationsInMesh
+                const refinementParameters::locations& meshLocations
             );
 
             //- Find boundary points that connect to more than one cell
@@ -910,7 +911,7 @@ public:
                 const polyMesh&,
                 const labelList& cellRegion,
                 const vector& perturbVec,
-                const point& locationInMesh
+                const point& location
             );
 
             //- Find regions points are in and update cellRegion
@@ -920,7 +921,7 @@ public:
                 const polyMesh&,
                 labelList& cellRegion,
                 const vector& perturbVec,
-                const List<point>& locationsInMesh
+                const refinementParameters::locations& meshLocations
             );
 
             //- Split mesh. Keep regions containing any point in locationsInMesh
@@ -928,7 +929,7 @@ public:
             (
                 const labelList& globalToMasterPatch,
                 const labelList& globalToSlavePatch,
-                const List<point>& locationsInMesh
+                const refinementParameters::locations& meshLocations
             );
 
             //- Split faces into two
diff --git a/src/mesh/snappyHexMesh/meshRefinement/meshRefinementBaffles.C b/src/mesh/snappyHexMesh/meshRefinement/meshRefinementBaffles.C
index b78345fd9c..89a1fbbb7e 100644
--- a/src/mesh/snappyHexMesh/meshRefinement/meshRefinementBaffles.C
+++ b/src/mesh/snappyHexMesh/meshRefinement/meshRefinementBaffles.C
@@ -2263,7 +2263,7 @@ void Foam::meshRefinement::baffleAndSplitMesh
     Time& runTime,
     const labelList& globalToMasterPatch,
     const labelList& globalToSlavePatch,
-    const List<point>& locationsInMesh
+    const refinementParameters::locations& meshLocations
 )
 {
     // Introduce baffles
@@ -2354,7 +2354,7 @@ void Foam::meshRefinement::baffleAndSplitMesh
         runTime++;
     }
 
-    splitMeshRegions(globalToMasterPatch, globalToSlavePatch, locationsInMesh);
+    splitMeshRegions(globalToMasterPatch, globalToSlavePatch, meshLocations);
 
     if (debug)
     {
@@ -2445,7 +2445,7 @@ Foam::autoPtr<Foam::mapPolyMesh> Foam::meshRefinement::splitMesh
     const label nBufferLayers,
     const labelList& globalToMasterPatch,
     const labelList& globalToSlavePatch,
-    const List<point>& locationsInMesh
+    const refinementParameters::locations& meshLocations
 )
 {
     // Determine patches to put intersections into
@@ -2484,13 +2484,13 @@ Foam::autoPtr<Foam::mapPolyMesh> Foam::meshRefinement::splitMesh
     regionSplit cellRegion(mesh_, blockedFace);
     blockedFace.clear();
 
-    // Find the regions containing any of the points in locationsInMesh
+    // Find the regions containing any of the points in meshLocations
     findRegions
     (
         mesh_,
         cellRegion,
         mergeDistance_*vector::one,
-        locationsInMesh
+        meshLocations
     );
 
 
@@ -2668,7 +2668,7 @@ Foam::autoPtr<Foam::mapPolyMesh> Foam::meshRefinement::splitMesh
     reduce(nCellsInMesh, sumOp<label>());
 
     Info<< "Selecting all cells in regions containing any of the points in "
-        << locationsInMesh << endl
+        << meshLocations.inside() << endl
         << "Selected: " << nCellsInMesh << " cells." << endl;
 
 
diff --git a/src/mesh/snappyHexMesh/snappyHexMeshDriver/refinementParameters/refinementParameters.C b/src/mesh/snappyHexMesh/snappyHexMeshDriver/refinementParameters/refinementParameters.C
index 59420ef9c3..4ea47fe502 100644
--- a/src/mesh/snappyHexMesh/snappyHexMeshDriver/refinementParameters/refinementParameters.C
+++ b/src/mesh/snappyHexMesh/snappyHexMeshDriver/refinementParameters/refinementParameters.C
@@ -44,12 +44,7 @@ Foam::refinementParameters::refinementParameters(const dictionary& dict)
         )
     ),
     nBufferLayers_(dict.lookup<label>("nCellsBetweenLevels")),
-    locationsInMesh_
-    (
-        dict.found("locationsInMesh")
-      ? List<point>(dict.lookup("locationsInMesh"))
-      : List<point>(1, dict.lookup("locationInMesh"))
-    ),
+    meshLocations_(dict),
     allowFreeStandingZoneFaces_(dict.lookup("allowFreeStandingZoneFaces")),
     useTopologicalSnapDetection_
     (
@@ -61,8 +56,6 @@ Foam::refinementParameters::refinementParameters(const dictionary& dict)
         dict.lookupOrDefault<Switch>("handleSnapProblems", true)
     )
 {
-    InfoInFunction << locationsInMesh_ << endl;
-
     scalar featAngle(dict.lookup<scalar>("resolveFeatureAngle"));
 
     if (featAngle < 0 || featAngle > 180)
@@ -76,6 +69,17 @@ Foam::refinementParameters::refinementParameters(const dictionary& dict)
 }
 
 
+Foam::refinementParameters::locations::locations(const dictionary& dict)
+:
+    inside_
+    (
+        dict.found("locationsInMesh")
+      ? List<point>(dict.lookup("locationsInMesh"))
+      : List<point>(1, dict.lookup("locationInMesh"))
+    )
+{}
+
+
 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
 Foam::labelList Foam::refinementParameters::findCells(const polyMesh& mesh)
@@ -88,11 +92,11 @@ const
     globalIndex globalCells(mesh.nCells());
 
     // Cell label per point
-    labelList cellLabels(locationsInMesh_.size());
+    labelList cellLabels(meshLocations_.inside().size());
 
-    forAll(locationsInMesh_, i)
+    forAll(meshLocations_.inside(), i)
     {
-        const point& locationInMesh = locationsInMesh_[i];
+        const point& locationInMesh = meshLocations_.inside()[i];
 
         label localCelli = mesh.findCell(locationInMesh);
 
diff --git a/src/mesh/snappyHexMesh/snappyHexMeshDriver/refinementParameters/refinementParameters.H b/src/mesh/snappyHexMesh/snappyHexMeshDriver/refinementParameters/refinementParameters.H
index 8669110fbc..38228b3cb9 100644
--- a/src/mesh/snappyHexMesh/snappyHexMeshDriver/refinementParameters/refinementParameters.H
+++ b/src/mesh/snappyHexMesh/snappyHexMeshDriver/refinementParameters/refinementParameters.H
@@ -54,6 +54,31 @@ class polyMesh;
 
 class refinementParameters
 {
+public:
+
+    // Public classes
+
+        //- Class to hold the meshed region selection locations
+        class locations
+        {
+            //- Locations in the meshed regions
+            const List<point> inside_;
+
+        public:
+
+            //- Constructor
+            locations(const dictionary& dict);
+
+            //- Return the locations inside the meshed regions
+            const List<point>& inside() const
+            {
+                return inside_;
+            }
+        };
+
+
+private:
+
     // Private Data
 
         //- Total number of cells
@@ -74,8 +99,8 @@ class refinementParameters
         //- Number of layers between different refinement levels
         const label nBufferLayers_;
 
-        //- Areas to keep
-        const List<point> locationsInMesh_;
+        //- Locations to select regions of cells
+        const locations meshLocations_;
 
         //- FaceZone faces allowed which have owner and neighbour in same
         //  cellZone?
@@ -142,10 +167,10 @@ public:
                 return nBufferLayers_;
             }
 
-            //- Locations in to select meshed regions
-            const List<point>& locationsInMesh() const
+            //- Locations to select meshed regions
+            const locations& meshLocations() const
             {
-                return locationsInMesh_;
+                return meshLocations_;
             }
 
             //- Are zone faces allowed only in between different cell zones
diff --git a/src/mesh/snappyHexMesh/snappyHexMeshDriver/snappyRefineDriver.C b/src/mesh/snappyHexMesh/snappyHexMeshDriver/snappyRefineDriver.C
index 9dc3b961d5..977806a179 100644
--- a/src/mesh/snappyHexMesh/snappyHexMeshDriver/snappyRefineDriver.C
+++ b/src/mesh/snappyHexMesh/snappyHexMeshDriver/snappyRefineDriver.C
@@ -94,7 +94,7 @@ Foam::label Foam::snappyRefineDriver::featureEdgeRefine
             (
                 meshRefiner_.refineCandidates
                 (
-                    refineParams.locationsInMesh(),
+                    refineParams.meshLocations().inside(),
                     refineParams.curvature(),
                     refineParams.planarAngle(),
 
@@ -207,7 +207,7 @@ Foam::label Foam::snappyRefineDriver::surfaceOnlyRefine
         (
             meshRefiner_.refineCandidates
             (
-                refineParams.locationsInMesh(),
+                refineParams.meshLocations().inside(),
                 refineParams.curvature(),
                 refineParams.planarAngle(),
 
@@ -341,7 +341,7 @@ Foam::label Foam::snappyRefineDriver::gapOnlyRefine
         (
             meshRefiner_.refineCandidates
             (
-                refineParams.locationsInMesh(),
+                refineParams.meshLocations().inside(),
                 refineParams.curvature(),
                 refineParams.planarAngle(),
 
@@ -692,7 +692,7 @@ void Foam::snappyRefineDriver::removeInsideCells
         nBufferLayers,                  // nBufferLayers
         globalToMasterPatch_,
         globalToSlavePatch_,
-        refineParams.locationsInMesh()
+        refineParams.meshLocations()
     );
 
     if (debug&meshRefinement::MESH)
@@ -753,7 +753,7 @@ Foam::label Foam::snappyRefineDriver::shellRefine
         (
             meshRefiner_.refineCandidates
             (
-                refineParams.locationsInMesh(),
+                refineParams.meshLocations().inside(),
                 refineParams.curvature(),
                 refineParams.planarAngle(),
 
@@ -921,7 +921,7 @@ void Foam::snappyRefineDriver::baffleAndSplitMesh
         const_cast<Time&>(mesh.time()),
         globalToMasterPatch_,
         globalToSlavePatch_,
-        refineParams.locationsInMesh()
+        refineParams.meshLocations()
     );
 }
 
@@ -956,7 +956,7 @@ void Foam::snappyRefineDriver::zonify
 
         meshRefiner_.zonify
         (
-            refineParams.locationsInMesh(),
+            refineParams.meshLocations().inside(),
             refineParams.allowFreeStandingZoneFaces()
         );
 
@@ -1023,7 +1023,7 @@ void Foam::snappyRefineDriver::splitAndMergeBaffles
         const_cast<Time&>(mesh.time()),
         globalToMasterPatch_,
         globalToSlavePatch_,
-        refineParams.locationsInMesh()
+        refineParams.meshLocations()
     );
 
     if (debug)
@@ -1061,7 +1061,7 @@ void Foam::snappyRefineDriver::splitAndMergeBaffles
         (
             globalToMasterPatch_,
             globalToSlavePatch_,
-            refineParams.locationsInMesh()
+            refineParams.meshLocations()
         );
 
         if (debug)