Polygon

Author: ecomodeller

mikeio/spatial/_FM_geometry.py

@@ -22,7 +22,7 @@
 from ._FM_utils import (
     _get_node_centered_data,
     _plot_map,
-    BoundaryPolylines,
+    BoundaryPolygons,
     Polygon,
     _set_xy_label_by_projection,  # TODO remove
     _to_polygons,  # TODO remove
@@ -843,9 +843,9 @@ def get_element_area(self) -> np.ndarray:
         return np.abs(area)
 
     @cached_property
-    def boundary_polylines(self) -> BoundaryPolylines:
+    def boundary_polylines(self) -> BoundaryPolygons:
         """Lists of closed polylines defining domain outline."""
-        return self._get_boundary_polylines()
+        return self._get_boundary_polygons()
 
     def contains(self, points: np.ndarray) -> np.ndarray:
         """Test if a list of points are contained by mesh.
@@ -861,19 +861,18 @@ def contains(self, points: np.ndarray) -> np.ndarray:
             True for points inside, False otherwise
 
         """
-
         points = np.atleast_2d(points)
 
         return self.boundary_polylines.contains(points)
 
     def __contains__(self, pt: np.ndarray) -> bool:
         return self.contains(pt)[0]
 
-    def _get_boundary_polylines_uncategorized(self) -> list[list[np.int64]]:
-        """Construct closed polylines for all boundary faces."""
+    def _get_boundary_polygons_uncategorized(self) -> list[list[np.int64]]:
+        """Construct closed polygons for all boundary faces."""
         boundary_faces = self._get_boundary_faces()
         face_remains = boundary_faces.copy()
-        polylines = []
+        polygons = []
         while face_remains.shape[0] > 1:
             n0 = face_remains[:, 0]
             n1 = face_remains[:, 1]
@@ -892,28 +891,26 @@ def _get_boundary_polylines_uncategorized(self) -> list[list[np.int64]]:
                     break
 
             face_remains = np.delete(face_remains, index_to_delete, axis=0)
-            polylines.append(polyline)
-        return polylines
+            polygons.append(polyline)
+        return polygons
 
-    def _get_boundary_polylines(self) -> BoundaryPolylines:
+    def _get_boundary_polygons(self) -> BoundaryPolygons:
         """Get boundary polylines and categorize as inner or outer by assessing the signed area."""
-        polylines = self._get_boundary_polylines_uncategorized()
+        polygons = self._get_boundary_polygons_uncategorized()
 
         interiors = []
         exteriors = []
 
-        for polyline in polylines:
-            # xy = self.node_coordinates[polyline, :2]
-
-            poly_line = np.asarray(polyline)
-            xy = self.node_coordinates[poly_line, 0:2]
+        for polygon in polygons:
+            polygon_np = np.asarray(polygon)
+            xy = self.node_coordinates[polygon_np, 0:2]
             poly = Polygon(xy)
             if poly.area > 0:
                 exteriors.append(poly)
             else:
                 interiors.append(poly)
 
-        return BoundaryPolylines(exteriors=exteriors, interiors=interiors)
+        return BoundaryPolygons(exteriors=exteriors, interiors=interiors)
 
     def _get_boundary_faces(self) -> np.ndarray:
         """Construct list of faces."""

mikeio/spatial/_FM_geometry_layered.py

@@ -12,7 +12,7 @@
 from ._FM_geometry import GeometryFM2D, _GeometryFM, _GeometryFMPlotter
 from ._geometry import GeometryPoint3D
 
-from ._FM_utils import _plot_vertical_profile, BoundaryPolylines
+from ._FM_utils import _plot_vertical_profile, BoundaryPolygons
 
 from ._utils import _relative_cumulative_distance
 
@@ -653,7 +653,7 @@ def __init__(
         self.plot = _GeometryFMPlotter(self)
 
     @property
-    def boundary_polylines(self) -> BoundaryPolylines:
+    def boundary_polylines(self) -> BoundaryPolygons:
         return self.geometry2d.boundary_polylines
 
     def contains(self, points: np.ndarray) -> np.ndarray:

mikeio/spatial/_FM_utils.py

@@ -31,7 +31,7 @@ def area(self) -> float:
 
 
 @dataclass
-class BoundaryPolylines:
+class BoundaryPolygons:
     exteriors: list[Polygon]
     interiors: list[Polygon]