feat(GridIntersect): add array support, fast point locating and support for points with z-coordinates

.docs/Notebooks/groundwater2023_watershed_example.py

@@ -94,8 +94,8 @@ def densify_geometry(line, step, keep_internal_nodes=True):
 
 # function to set the active and inactive model area
 def set_idomain(grid, boundary):
-    ix = GridIntersect(grid, method="vertex", rtree=True)
-    result = ix.intersect(Polygon(boundary))
+    ix = GridIntersect(grid, rtree=True)
+    result = ix.intersect(Polygon(boundary), geo_dataframe=False)
     idx = list(result.cellids)
     idx = np.array(idx, dtype=int)
     nr = idx.shape[0]
@@ -241,10 +241,10 @@ def set_idomain(grid, boundary):
     extrapolate_edges=True,
 )
 
-ixs = flopy.utils.GridIntersect(struct_grid, method="structured")
+ixs = flopy.utils.GridIntersect(struct_grid)
 cellids = []
 for sg in sgs:
-    v = ixs.intersect(LineString(sg), sort_by_cellid=True)
+    v = ixs.intersect(LineString(sg), sort_by_cellid=True, geo_dataframe=False)
     cellids += v["cellids"].tolist()
 intersection_sg = np.zeros(struct_grid.shape[1:])
 for loc in cellids:
@@ -315,10 +315,10 @@ def set_idomain(grid, boundary):
     extrapolate_edges=True,
 )
 
-ixs = flopy.utils.GridIntersect(struct_vrc_grid, method="structured")
+ixs = flopy.utils.GridIntersect(struct_vrc_grid)
 cellids = []
 for sg in sgs:
-    v = ixs.intersect(LineString(sg), sort_by_cellid=True)
+    v = ixs.intersect(LineString(sg), sort_by_cellid=True, geo_dataframe=False)
     cellids += v["cellids"].tolist()
 intersection_sg_vrc = np.zeros(struct_vrc_grid.shape[1:])
 for loc in cellids:
@@ -419,20 +419,20 @@ def set_idomain(grid, boundary):
 top_nested_grid = [top_ngp, top_ngc]
 
 # +
-ixs = flopy.utils.GridIntersect(struct_gridp, method="structured")
+ixs = flopy.utils.GridIntersect(struct_gridp)
 cellids = []
 for sg in sgs:
-    v = ixs.intersect(LineString(sg), sort_by_cellid=True)
+    v = ixs.intersect(LineString(sg), sort_by_cellid=True, geo_dataframe=False)
     cellids += v["cellids"].tolist()
 intersection_ngp = np.zeros(struct_gridp.shape[1:])
 for loc in cellids:
     intersection_ngp[loc] = 1
 intersection_ngp[idomainp[0] == 0] = 0
 
-ixs = flopy.utils.GridIntersect(struct_gridc, method="structured")
+ixs = flopy.utils.GridIntersect(struct_gridc)
 cellids = []
 for sg in sgs:
-    v = ixs.intersect(LineString(sg), sort_by_cellid=True)
+    v = ixs.intersect(LineString(sg), sort_by_cellid=True, geo_dataframe=False)
     cellids += v["cellids"].tolist()
 intersection_ngc = np.zeros(struct_gridc.shape[1:])
 for loc in cellids:
@@ -515,10 +515,10 @@ def set_idomain(grid, boundary):
     extrapolate_edges=True,
 )
 
-ixs = flopy.utils.GridIntersect(quadtree_grid, method="vertex")
+ixs = flopy.utils.GridIntersect(quadtree_grid)
 cellids = []
 for sg in sgs:
-    v = ixs.intersect(LineString(sg), sort_by_cellid=True)
+    v = ixs.intersect(LineString(sg), sort_by_cellid=True, geo_dataframe=False)
     cellids += v["cellids"].tolist()
 intersection_qg = np.zeros(quadtree_grid.shape[1:])
 for loc in cellids:
@@ -583,14 +583,14 @@ def set_idomain(grid, boundary):
     extrapolate_edges=True,
 )
 
-ixs = flopy.utils.GridIntersect(triangular_grid)  # , method="vertex")
+ixs = flopy.utils.GridIntersect(triangular_grid)
 cellids = []
 for sg in sgs:
     v = ixs.intersect(
         LineString(sg),
         return_all_intersections=True,
-        keepzerolengths=False,
         sort_by_cellid=True,
+        geo_dataframe=False,
     )
     cellids += v["cellids"].tolist()
 intersection_tg = np.zeros(triangular_grid.shape[1:])
@@ -633,14 +633,14 @@ def set_idomain(grid, boundary):
     extrapolate_edges=True,
 )
 
-ixs = flopy.utils.GridIntersect(voronoi_grid, method="vertex")
+ixs = flopy.utils.GridIntersect(voronoi_grid)
 cellids = []
 for sg in sgs:
     v = ixs.intersect(
         LineString(sg),
         return_all_intersections=True,
-        keepzerolengths=False,
         sort_by_cellid=True,
+        geo_dataframe=False,
     )
     cellids += v["cellids"].tolist()
 intersection_vg = np.zeros(voronoi_grid.shape[1:])

.docs/Notebooks/mf6_parallel_model_splitting_example.py

@@ -354,8 +354,8 @@ def string2geom(geostring, conversion=None):
 
 # +
 # calculate and set idomain
-ix = flopy.utils.GridIntersect(modelgrid, method="vertex", rtree=True)
-result = ix.intersect(Polygon(boundary_polygon))
+ix = flopy.utils.GridIntersect(modelgrid, rtree=True)
+result = ix.intersect(Polygon(boundary_polygon), geo_dataframe=False)
 idxs = tuple(zip(*result.cellids))
 idomain = np.zeros((nrow, ncol), dtype=int)
 idomain[idxs] = 1
@@ -369,10 +369,10 @@ def string2geom(geostring, conversion=None):
 
 # Intersect the stream segments with the modelgrid
 
-ixs = flopy.utils.GridIntersect(modelgrid, method="structured")
+ixs = flopy.utils.GridIntersect(modelgrid)
 cellids = []
 for seg in segs:
-    v = ixs.intersect(LineString(seg), sort_by_cellid=True)
+    v = ixs.intersect(LineString(seg), sort_by_cellid=True, geo_dataframe=False)
     cellids += v["cellids"].tolist()
 intersection_rg = np.zeros(modelgrid.shape[1:])
 for loc in cellids:
@@ -401,11 +401,11 @@ def string2geom(geostring, conversion=None):
 
 # +
 # intersect stream segs to simulate as drains
-ixs = flopy.utils.GridIntersect(modelgrid, method="structured")
+ixs = flopy.utils.GridIntersect(modelgrid)
 drn_cellids = []
 drn_lengths = []
 for seg in segs:
-    v = ixs.intersect(LineString(seg), sort_by_cellid=True)
+    v = ixs.intersect(LineString(seg), sort_by_cellid=True, geo_dataframe=False)
     drn_cellids += v["cellids"].tolist()
     drn_lengths += v["lengths"].tolist()
 # -

.docs/md/optional_dependencies.md

@@ -13,9 +13,8 @@ Dependencies for optional features are listed below. These may be installed with
 | `.resample_to_grid()` in `flopy.utils.rasters`                                       | **scipy.interpolate**                                                    |
 | `.interpolate()` in `flopy.mf6.utils.reference` `StructuredSpatialReference` class   | **scipy.interpolate**                                                    |
 | `.get_authority_crs()` in `flopy.utils.crs`                                          | **pyproj** >= 2.2.0                                                      |
-| `.generate_classes()` in `flopy.mf6.utils`                                           | [**modflow-devtools**](https://github.com/MODFLOW-ORG/modflow-devtools) |
+| `.generate_classes()` in `flopy.mf6.utils`                                           | [**modflow-devtools**](https://github.com/MODFLOW-ORG/modflow-devtools)  |
 | `GridIntersect()` in `flopy.utils.gridintersect`                                     | **shapely**                                                              |
-| `GridIntersect().plot_polygon()` in `flopy.utils.gridintersect`                      | **shapely** and **descartes**                                            |
 | `Raster()` in `flopy.utils.Raster`                                                   | **rasterio**, **rasterstats**, **affine**, and **scipy**                 |
 | `Raster().sample_polygon()` in `flopy.utils.Raster`                                  | **shapely**                                                              |
 | `Raster().crop()` in `flopy.utils.Raster`                                            | **shapely**                                                              |