ENH: renamed attachedToCell to haloToCell and fix parallel consistency

- was added for #1394

src/meshTools/Make/files

@@ -152,7 +152,6 @@ sets/topoSetSource/topoSetSource.C
 
 cellSources = sets/cellSources
 $(cellSources)/topoSetCellSource/topoSetCellSource.C
-$(cellSources)/attachedToCell/attachedToCell.C
 $(cellSources)/boundaryToCell/boundaryToCell.C
 $(cellSources)/boxToCell/boxToCell.C
 $(cellSources)/cellToCell/cellToCell.C
@@ -161,6 +160,7 @@ $(cellSources)/cylinderToCell/cylinderToCell.C
 $(cellSources)/faceToCell/faceToCell.C
 $(cellSources)/faceZoneToCell/faceZoneToCell.C
 $(cellSources)/fieldToCell/fieldToCell.C
+$(cellSources)/haloToCell/haloToCell.C
 $(cellSources)/labelToCell/labelToCell.C
 $(cellSources)/nbrToCell/nbrToCell.C
 $(cellSources)/nearestToCell/nearestToCell.C

src/meshTools/sets/cellSources/haloToCell/haloToCell.C

@@ -23,7 +23,7 @@ License
 
 \*---------------------------------------------------------------------------*/
 
-#include "attachedToCell.H"
+#include "haloToCell.H"
 #include "polyMesh.H"
 #include "cellSet.H"
 #include "syncTools.H"
@@ -33,60 +33,44 @@ License
 
 namespace Foam
 {
-    defineTypeNameAndDebug(attachedToCell, 0);
+    defineTypeNameAndDebug(haloToCell, 0);
-    addToRunTimeSelectionTable(topoSetSource, attachedToCell, word);
+    addToRunTimeSelectionTable(topoSetSource, haloToCell, word);
-    addToRunTimeSelectionTable(topoSetSource, attachedToCell, istream);
+    addToRunTimeSelectionTable(topoSetSource, haloToCell, istream);
-    addToRunTimeSelectionTable(topoSetCellSource, attachedToCell, word);
+    addToRunTimeSelectionTable(topoSetCellSource, haloToCell, word);
-    addToRunTimeSelectionTable(topoSetCellSource, attachedToCell, istream);
+    addToRunTimeSelectionTable(topoSetCellSource, haloToCell, istream);
     addNamedToRunTimeSelectionTable
     (
         topoSetCellSource,
-        attachedToCell,
+        haloToCell,
         word,
-        attached
+        halo
     );
     addNamedToRunTimeSelectionTable
     (
         topoSetCellSource,
-        attachedToCell,
+        haloToCell,
         istream,
-        attached
+        halo
     );
 }
 
 
-Foam::topoSetSource::addToUsageTable Foam::attachedToCell::usage_
+Foam::topoSetSource::addToUsageTable Foam::haloToCell::usage_
 (
-    attachedToCell::typeName,
+    haloToCell::typeName,
-    "\n    Usage: attachedToCell\n\n"
+    "\n    Usage: haloToCell\n\n"
-    "    Select attached cells\n\n"
+    "    Select halo cells\n\n"
 );
 
 
 // * * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //
 
-void Foam::attachedToCell::combine(topoSet& set, const bool add) const
+void Foam::haloToCell::combine(topoSet& set, const bool add) const
 {
     const cellList& cells = mesh_.cells();
     const labelList& faceOwn = mesh_.faceOwner();
     const labelList& faceNei = mesh_.faceNeighbour();
-    const label nIntFaces = mesh_.nInternalFaces();
-    const polyBoundaryMesh& patches = mesh_.boundaryMesh();
 
-    boolList isCoupled(mesh_.nBoundaryFaces(), false);
-
-    for (const polyPatch& pp : patches)
-    {
-        if (pp.coupled())
-        {
-            label facei = pp.start();
-            forAll(pp, i)
-            {
-                isCoupled[facei-nIntFaces] = true;
-                ++facei;
-            }
-        }
-    }
 
     // The starting set of cells
     bitSet current(cells.size());
@@ -97,19 +81,16 @@ void Foam::attachedToCell::combine(topoSet& set, const bool add) const
     }
 
     // The perimeter faces of the cell set
-    bitSet outsideFaces(mesh().nFaces());
+    bitSet outsideFaces(mesh_.nFaces());
 
-    // Get coupled cell status
+    bitSet updates(cells.size());
-    boolList neiInSet(mesh_.nFaces()-nIntFaces, false);
-
-    bitSet updates(current);
 
     for (label stepi = 0; stepi < steps_; ++stepi)
     {
-        // Mark up all perimeter faces
+        // Mark up perimeter faces. Each mesh face is attached exactly
-
+        // (0,1,2) times to a cell in the set. Using flip() each time means
-        // Don't attempt extra efficiency with caching old values,
+        // the only 'on' bits correspond to faces that are attached once to
-        // this make the parallel transfer too troublesome
+        // the cell set - ie, faces on the perimeter of the set.
 
         outsideFaces.reset();
         for (const label celli : current)
@@ -120,36 +101,18 @@ void Foam::attachedToCell::combine(topoSet& set, const bool add) const
             }
         }
 
-        // Coupled faces
+        // Use xor to eliminate perimeter faces that are actually attached
-        neiInSet = false;
+        // on both sides of the interface.
 
-        for
+        syncTools::syncFaceList
         (
-            bitSet::const_iterator iter = outsideFaces.cbegin(nIntFaces);
+            mesh_,
-            iter != outsideFaces.cend();
+            outsideFaces,
-            ++iter
+            bitXorEqOp<unsigned int>()
-        )
+        );
-        {
-            const label facei = *iter;
-
-            if (isCoupled[facei-nIntFaces])
-            {
-                neiInSet[facei-nIntFaces] = true;
-            }
-        }
-
-        syncTools::swapBoundaryFaceList(mesh_, neiInSet);
-
-        forAll(neiInSet, bfacei)
-        {
-            if (neiInSet[bfacei])
-            {
-                outsideFaces.flip(bfacei+nIntFaces);
-            }
-        }
 
+        // Select all cells attached to the perimeter faces.
         updates.reset();
-
         for (const label facei : outsideFaces)
         {
             updates.set(faceOwn[facei]);
@@ -161,9 +124,7 @@ void Foam::attachedToCell::combine(topoSet& set, const bool add) const
 
         if (add)
         {
-            // Face information retained for next loop
+            // Restrict to cells not already in the current set
-
-            // Changed cells
             updates -= current;
 
             if (verbose_)
@@ -172,11 +133,12 @@ void Foam::attachedToCell::combine(topoSet& set, const bool add) const
                     << " by " << updates.count() << endl;
             }
 
+            // Add to current set for the next loop
             current |= updates;
         }
         else
         {
-            // Changed cells
+            // Restrict to cells already in the current set
             updates &= current;
 
             if (verbose_)
@@ -185,25 +147,23 @@ void Foam::attachedToCell::combine(topoSet& set, const bool add) const
                     << " by " << updates.count() << endl;
             }
 
+            // Remove from current set for the next loop
             current -= updates;
         }
 
-        for (const label celli: updates)
-        {
-            addOrDelete(set, celli, add);
-        }
-
         if (updates.none())
         {
             break;
         }
+
+        addOrDelete(set, updates, add);
     }
 }
 
 
 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 
-Foam::attachedToCell::attachedToCell
+Foam::haloToCell::haloToCell
 (
     const polyMesh& mesh,
     const label steps
@@ -214,29 +174,29 @@ Foam::attachedToCell::attachedToCell
 {}
 
 
-Foam::attachedToCell::attachedToCell
+Foam::haloToCell::haloToCell
 (
     const polyMesh& mesh,
     const dictionary& dict
 )
 :
-    attachedToCell(mesh, dict.getOrDefault<label>("steps", 1))
+    haloToCell(mesh, dict.getOrDefault<label>("steps", 1))
 {}
 
 
-Foam::attachedToCell::attachedToCell
+Foam::haloToCell::haloToCell
 (
     const polyMesh& mesh,
     Istream& is
 )
 :
-    attachedToCell(mesh, 1)
+    haloToCell(mesh, 1)
 {}
 
 
 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
-void Foam::attachedToCell::applyToSet
+void Foam::haloToCell::applyToSet
 (
     const topoSetSource::setAction action,
     topoSet& set
@@ -246,7 +206,8 @@ void Foam::attachedToCell::applyToSet
     {
         if (verbose_)
         {
-            Info<< "    Cannot create new of attached" << endl;
+            Info<< "    Cannot create new of halo (needs a starting set)"
+                << endl;
         }
 
         set.clear();
@@ -255,7 +216,7 @@ void Foam::attachedToCell::applyToSet
     {
         if (verbose_)
         {
-            Info<< "    Adding cells attached to current set, using "
+            Info<< "    Adding halo cells to the current set, using "
                 << steps_ << " step ..." << endl;
         }
 
@@ -265,7 +226,7 @@ void Foam::attachedToCell::applyToSet
     {
         if (verbose_)
         {
-            Info<< "    Removing external cells of current set, using "
+            Info<< "    Removing cells on the perimeter of current set, using "
                 << steps_ << " step ..." << endl;
         }
 

src/meshTools/sets/cellSources/haloToCell/haloToCell.H

@@ -22,10 +22,13 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::attachedToCell
+    Foam::haloToCell
 
 Description
-    A topoSetCellSource to add/remove cells attached to the current cellSet
+    A topoSetCellSource to add/remove halo cells (cells attached to
+    the outside of the current cellSet).
+    When removing halo cells, this strips off any cells on the boundary
+    of the set.
 
     \heading Dictionary parameters
     \table
@@ -34,12 +37,12 @@ Description
     \endtable
 
 SourceFiles
-    attachedToCell.C
+    haloToCell.C
 
 \*---------------------------------------------------------------------------*/
 
-#ifndef attachedToCell_H
+#ifndef haloToCell_H
-#define attachedToCell_H
+#define haloToCell_H
 
 #include "topoSetCellSource.H"
 
@@ -49,10 +52,10 @@ namespace Foam
 {
 
 /*---------------------------------------------------------------------------*\
-                         Class attachedToCell Declaration
+                         Class haloToCell Declaration
 \*---------------------------------------------------------------------------*/
 
-class attachedToCell
+class haloToCell
 :
     public topoSetCellSource
 {
@@ -74,23 +77,23 @@ class attachedToCell
 public:
 
     //- Runtime type information
-    TypeName("attachedToCell");
+    TypeName("haloToCell");
 
 
     // Constructors
 
         //- Construct from components
-        explicit attachedToCell(const polyMesh& mesh, const label steps=1);
+        explicit haloToCell(const polyMesh& mesh, const label steps=1);
 
         //- Construct from dictionary
-        attachedToCell(const polyMesh& mesh, const dictionary& dict);
+        haloToCell(const polyMesh& mesh, const dictionary& dict);
 
         //- Construct from Istream
-        attachedToCell(const polyMesh& mesh, Istream& is);
+        haloToCell(const polyMesh& mesh, Istream& is);
 
 
     //- Destructor
-    virtual ~attachedToCell() = default;
+    virtual ~haloToCell() = default;
 
 
     // Member Functions