Point In Face & Get Faces Containing Point

benchmarks/mpas_ocean.py

@@ -3,6 +3,7 @@
 from pathlib import Path
 
 import numpy as np
+from polars.testing.parametric import dtypes
 
 import uxarray as ux
 
@@ -194,6 +195,31 @@ def time_const_lat(self, resolution, lat_step):
             self.uxgrid.cross_section.constant_latitude(lat)
 
 
+class PointInPolygon:
+    param_names = ['resolution']
+    params = ['480km', '120km']
+
+    def setup(self, resolution):
+        self.uxgrid = ux.open_grid(file_path_dict[resolution][0])
+        self.uxgrid.normalize_cartesian_coordinates()
+
+        # Construct variables needed to ensure that the benchmark doesn't measure construction time
+        _ = self.uxgrid.face_edge_connectivity
+        _ = self.uxgrid.face_x.values
+        _ = self.uxgrid.face_lon.values
+
+        point = np.array([0.0, 0.0, 1.0])
+        res = self.uxgrid.get_faces_containing_point(point)
+
+    def teardown(self, resolution):
+        del self.uxgrid
+
+    def time_face_search(self, resolution):
+        point_xyz = np.array([self.uxgrid.face_x[0].values, self.uxgrid.face_y[0].values, self.uxgrid.face_z[0].values], dtype=np.float64)
+        point_lonlat = np.array([self.uxgrid.face_lon[0].values, self.uxgrid.face_lat.values[0]], dtype=np.float64)
+        self.uxgrid.get_faces_containing_point(point_xyz=point_xyz, point_lonlat=point_lonlat)
+
+
 class ZonalAverage(DatasetBenchmark):
     def setup(self, resolution, *args, **kwargs):
         self.uxds = ux.open_dataset(file_path_dict[resolution][0], file_path_dict[resolution][1])

docs/api.rst

@@ -139,6 +139,7 @@ Descriptors
    Grid.partial_sphere_coverage
    Grid.global_sphere_coverage
    Grid.triangular
+   Grid.max_face_radius
 
 Attributes
 ~~~~~~~~~~
@@ -159,6 +160,7 @@ Methods
    Grid.calculate_total_face_area
    Grid.normalize_cartesian_coordinates
    Grid.construct_face_centers
+   Grid.get_faces_containing_point
 
 Inheritance of Xarray Functionality
 -----------------------------------