Polygon clipping support in ClipField and EquiZ MIR.

RELEASE-NOTES.md

@@ -48,6 +48,7 @@ The Axom project release numbers follow [Semantic Versioning](http://semver.org/
 - Sina fortran `sina_write_document` now accepts a third argument that preserves records in memory so they can be written to another file (otherwise they're released from memory as soon as they're written)
 - Primal: In Bezier and NURBS classes, accessors for arrays of control points, weights and knots 
   are now returned by (const) reference instead of returning a copy by value.
+- The `axom::bump::clipping::ClipField` and `axom::mir::EquiZAlgorithm` classes were enhanced so they can clip polygons up to 8 sides.
 - De-virtualized `axom::Array` methods to improve performance. This change may break code which
   utilizes `axom::Array` or `sidre::Array/MCArray` in a polymorphic manner, for example by overriding
   `Array::updateNumElements()` or `Array::dynamicRealloc()`.

src/axom/bump/CMakeLists.txt

@@ -85,6 +85,10 @@ set(bump_headers
 
 set(bump_sources
     clipping/ClipCasesHex.cpp
+    clipping/ClipCasesPoly5.cpp
+    clipping/ClipCasesPoly6.cpp
+    clipping/ClipCasesPoly7.cpp
+    clipping/ClipCasesPoly8.cpp
     clipping/ClipCasesPyr.cpp
     clipping/ClipCasesQua.cpp
     clipping/ClipCasesTet.cpp

src/axom/bump/MergeMeshes.hpp

@@ -482,7 +482,7 @@ class MergeMeshes
   {
     // Check the shape types.
     std::map<std::string, int> shape_map = buildShapeMap(inputs);
-    if(shape_map.find("polyhedral") != shape_map.end())
+    if(shape_map.find(views::PolyhedronTraits::name()) != shape_map.end())
     {
       // At least one input was polyhedral. Force all polyhedral output.
       mergeTopologiesPolyhedral(inputs, n_options, output);
@@ -516,18 +516,17 @@ class MergeMeshes
 
     // If there are polygon shapes then assume that the rest of the shapes
     // are 2D and should be promoted to polygons.
-    if(shape_map.find("polygonal") != shape_map.end() && shape_map.size() > 1)
+    if(shape_map.find(views::PolygonTraits::name()) != shape_map.end() && shape_map.size() > 1)
     {
       shape_map.clear();
-      shape_map["polygonal"] = axom::bump::views::shapeNameToID("polygonal");
+      shape_map[views::PolygonTraits::name()] = views::PolygonTraits::id();
     }
 
     conduit::Node *n_newTopoPtr = nullptr;
     axom::IndexType connOffset = 0, sizesOffset = 0, shapesOffset = 0, coordOffset = 0;
     for(axom::IndexType i = 0; i < n; i++)
     {
       const conduit::Node &n_srcTopo = getTopology(inputs[i]);
-
       const std::string srcShape = n_srcTopo.fetch_existing("elements/shape").as_string();
       const conduit::Node &n_srcConn = n_srcTopo.fetch_existing("elements/connectivity");
       const conduit::Node &n_srcSizes = n_srcTopo.fetch_existing("elements/sizes");
@@ -703,28 +702,28 @@ class MergeMeshes
         views::IndexNode_to_ArrayView(n_elem_conn, [&](auto connView) {
           using ConnectivityType = typename decltype(connView)::value_type;
 
-          if(shape == "tet")
+          if(shape == views::TetTraits::name())
           {
             using TetShape = views::TetShape<ConnectivityType>;
             auto topologyView =
               views::make_unstructured_single_shape_topology<TetShape>::view(n_srcTopo);
             makePolyhedralMesh(topologyView, n_srcTopo, n_phTopo);
           }
-          else if(shape == "pyramid")
+          else if(shape == views::PyramidTraits::name())
           {
             using PyramidShape = views::PyramidShape<ConnectivityType>;
             auto topologyView =
               views::make_unstructured_single_shape_topology<PyramidShape>::view(n_srcTopo);
             makePolyhedralMesh(topologyView, n_srcTopo, n_phTopo);
           }
-          else if(shape == "wedge")
+          else if(shape == views::WedgeTraits::name())
           {
             using WedgeShape = views::WedgeShape<ConnectivityType>;
             auto topologyView =
               views::make_unstructured_single_shape_topology<WedgeShape>::view(n_srcTopo);
             makePolyhedralMesh(topologyView, n_srcTopo, n_phTopo);
           }
-          else if(shape == "hex")
+          else if(shape == views::HexTraits::name())
           {
             using HexShape = views::HexShape<ConnectivityType>;
             auto topologyView =

src/axom/bump/clipping/ClipCases.h

@@ -9,6 +9,7 @@
 // NOTE: The values for EA-EL and N0-N3 were reduced.
 // NOTE: We're using AXOM_BUMP_EXPORT instead of VISIT_VTK_LIGHT_API throughout.
 // NOTE: All #define were changed to constexpr variables to avoid symbol collisions.
+// NOTE: We added ST_POLY5 through ST_POLY8.
 // clang-format off
 
 #include "axom/export/bump.h"
@@ -81,9 +82,13 @@ constexpr unsigned char ST_WDG = 102;
 constexpr unsigned char ST_HEX = 103;
 constexpr unsigned char ST_TRI = 104;
 constexpr unsigned char ST_QUA = 105;
-constexpr unsigned char ST_VTX = 106;
-constexpr unsigned char ST_LIN = 107;
-constexpr unsigned char ST_PNT = 108;
+constexpr unsigned char ST_POLY5 = 106;
+constexpr unsigned char ST_POLY6 = 107;
+constexpr unsigned char ST_POLY7 = 108;
+constexpr unsigned char ST_POLY8 = 109;
+constexpr unsigned char ST_VTX = 110;
+constexpr unsigned char ST_LIN = 111;
+constexpr unsigned char ST_PNT = 112;
 
 // Colors
 constexpr unsigned char COLOR0 =  120;
@@ -168,6 +173,10 @@ constexpr unsigned char ST_MAX = (ST_PNT + 1);
 
 extern AXOM_BUMP_EXPORT const size_t clipShapesTriSize;
 extern AXOM_BUMP_EXPORT const size_t clipShapesQuaSize;
+extern AXOM_BUMP_EXPORT const size_t clipShapesPoly5Size;
+extern AXOM_BUMP_EXPORT const size_t clipShapesPoly6Size;
+extern AXOM_BUMP_EXPORT const size_t clipShapesPoly7Size;
+extern AXOM_BUMP_EXPORT const size_t clipShapesPoly8Size;
 extern AXOM_BUMP_EXPORT const size_t clipShapesTetSize;
 extern AXOM_BUMP_EXPORT const size_t clipShapesPyrSize;
 extern AXOM_BUMP_EXPORT const size_t clipShapesWdgSize;

src/axom/bump/clipping/ClipCasesPoly5.cpp

@@ -0,0 +1,139 @@
+// Copyright (c) 2017-2025, Lawrence Livermore National Security, LLC and
+// other Axom Project Developers. See the top-level LICENSE file for details.
+//
+// SPDX-License-Identifier: (BSD-3-Clause)
+#include "ClipCases.h"
+
+namespace axom
+{
+namespace bump
+{
+namespace clipping
+{
+namespace tables
+{
+
+int numClipCasesPoly5 = 32;
+
+int numClipShapesPoly5[] = {1, 2, 2, 2, 2, 3, 2, 2, 2, 3, 3, 3, 2, 3, 2, 2,
+                            2, 2, 3, 2, 3, 3, 3, 2, 2, 2, 3, 2, 2, 2, 2, 1};
+
+int startClipShapesPoly5[] = {0,   7,   20,  33,  46,  59,  78,  91,  104, 117, 136,
+                              155, 174, 187, 206, 219, 232, 245, 258, 277, 290, 309,
+                              328, 347, 360, 373, 386, 405, 418, 431, 444, 457};
+
+// clang-format off
+unsigned char clipShapesPoly5[] = {
+  // Case #0
+  ST_POLY5, COLOR0, P0, P1, P2, P3, P4,
+  // Case #1
+  ST_POLY6, COLOR0, EA, P1, P2, P3, P4, EE,
+  ST_TRI, COLOR1, P0, EA, EE,
+  // Case #2
+  ST_POLY6, COLOR0, P0, EA, EB, P2, P3, P4,
+  ST_TRI, COLOR1, EA, P1, EB,
+  // Case #3
+  ST_POLY5, COLOR0, EB, P2, P3, P4, EE,
+  ST_QUA, COLOR1, P0, P1, EB, EE,
+  // Case #4
+  ST_POLY6, COLOR0, P0, P1, EB, EC, P3, P4,
+  ST_TRI, COLOR1, EB, P2, EC,
+  // Case #5
+  ST_TRI, COLOR0, EA, P1, EB,
+  ST_QUA, COLOR0, EC, P3, P4, EE,
+  ST_POLY6, COLOR1, P0, EA, EB, P2, EC, EE,
+  // Case #6
+  ST_POLY5, COLOR0, P0, EA, EC, P3, P4,
+  ST_QUA, COLOR1, EA, P1, P2, EC,
+  // Case #7
+  ST_QUA, COLOR0, EC, P3, P4, EE,
+  ST_POLY5, COLOR1, P0, P1, P2, EC, EE,
+  // Case #8
+  ST_POLY6, COLOR0, P0, P1, P2, EC, ED, P4,
+  ST_TRI, COLOR1, EC, P3, ED,
+  // Case #9
+  ST_TRI, COLOR0, ED, P4, EE,
+  ST_QUA, COLOR0, EA, P1, P2, EC,
+  ST_POLY6, COLOR1, P0, EA, EC, P3, ED, EE,
+  // Case #10
+  ST_TRI, COLOR0, EB, P2, EC,
+  ST_QUA, COLOR0, P0, EA, ED, P4,
+  ST_POLY6, COLOR1, EA, P1, EB, EC, P3, ED,
+  // Case #11
+  ST_TRI, COLOR0, EB, P2, EC,
+  ST_TRI, COLOR0, ED, P4, EE,
+  ST_POLY7, COLOR1, P0, P1, EB, EC, P3, ED, EE,
+  // Case #12
+  ST_POLY5, COLOR0, P0, P1, EB, ED, P4,
+  ST_QUA, COLOR1, EB, P2, P3, ED,
+  // Case #13
+  ST_TRI, COLOR0, ED, P4, EE,
+  ST_TRI, COLOR0, EA, P1, EB,
+  ST_POLY7, COLOR1, P0, EA, EB, P2, P3, ED, EE,
+  // Case #14
+  ST_QUA, COLOR0, P0, EA, ED, P4,
+  ST_POLY5, COLOR1, EA, P1, P2, P3, ED,
+  // Case #15
+  ST_TRI, COLOR0, ED, P4, EE,
+  ST_POLY6, COLOR1, P0, P1, P2, P3, ED, EE,
+  // Case #16
+  ST_POLY6, COLOR0, P0, P1, P2, P3, ED, EE,
+  ST_TRI, COLOR1, ED, P4, EE,
+  // Case #17
+  ST_POLY5, COLOR0, EA, P1, P2, P3, ED,
+  ST_QUA, COLOR1, P0, EA, ED, P4,
+  // Case #18
+  ST_TRI, COLOR0, P0, EA, EE,
+  ST_QUA, COLOR0, EB, P2, P3, ED,
+  ST_POLY6, COLOR1, EA, P1, EB, ED, P4, EE,
+  // Case #19
+  ST_QUA, COLOR0, EB, P2, P3, ED,
+  ST_POLY5, COLOR1, P0, P1, EB, ED, P4,
+  // Case #20
+  ST_TRI, COLOR0, EC, P3, ED,
+  ST_QUA, COLOR0, P0, P1, EB, EE,
+  ST_POLY6, COLOR1, EB, P2, EC, ED, P4, EE,
+  // Case #21
+  ST_TRI, COLOR0, EA, P1, EB,
+  ST_TRI, COLOR0, EC, P3, ED,
+  ST_POLY7, COLOR1, P0, EA, EB, P2, EC, ED, P4,
+  // Case #22
+  ST_TRI, COLOR0, EC, P3, ED,
+  ST_TRI, COLOR0, P0, EA, EE,
+  ST_POLY7, COLOR1, EA, P1, P2, EC, ED, P4, EE,
+  // Case #23
+  ST_TRI, COLOR0, EC, P3, ED,
+  ST_POLY6, COLOR1, P0, P1, P2, EC, ED, P4,
+  // Case #24
+  ST_POLY5, COLOR0, P0, P1, P2, EC, EE,
+  ST_QUA, COLOR1, EC, P3, P4, EE,
+  // Case #25
+  ST_QUA, COLOR0, EA, P1, P2, EC,
+  ST_POLY5, COLOR1, P0, EA, EC, P3, P4,
+  // Case #26
+  ST_TRI, COLOR0, P0, EA, EE,
+  ST_TRI, COLOR0, EB, P2, EC,
+  ST_POLY7, COLOR1, EA, P1, EB, EC, P3, P4, EE,
+  // Case #27
+  ST_TRI, COLOR0, EB, P2, EC,
+  ST_POLY6, COLOR1, P0, P1, EB, EC, P3, P4,
+  // Case #28
+  ST_QUA, COLOR0, P0, P1, EB, EE,
+  ST_POLY5, COLOR1, EB, P2, P3, P4, EE,
+  // Case #29
+  ST_TRI, COLOR0, EA, P1, EB,
+  ST_POLY6, COLOR1, P0, EA, EB, P2, P3, P4,
+  // Case #30
+  ST_TRI, COLOR0, P0, EA, EE,
+  ST_POLY6, COLOR1, EA, P1, P2, P3, P4, EE,
+  // Case #31
+  ST_POLY5, COLOR1, P0, P1, P2, P3, P4
+};
+// clang-format on
+
+const size_t clipShapesPoly5Size = sizeof(clipShapesPoly5) / sizeof(unsigned char);
+
+}  // namespace tables
+}  // namespace clipping
+}  // namespace bump
+}  // namespace axom