Renaming field_sampling_error to grid_searching_error

Author: erikvansebille

parcels/_index_search.py

@@ -15,7 +15,7 @@
     FieldOutOfBoundSurfaceError,
     _raise_field_out_of_bound_error,
     _raise_field_out_of_bound_surface_error,
-    _raise_field_sampling_error,
+    _raise_grid_searching_error,
     _raise_time_extrapolation_error,
 )
 
@@ -243,7 +243,7 @@ def _search_indices_rectilinear(
         zi, zeta = -1, 0
 
     if not ((0 <= xsi <= 1) and (0 <= eta <= 1) and (0 <= zeta <= 1)):
-        _raise_field_sampling_error(z, y, x)
+        _raise_grid_searching_error(z, y, x)
 
     _ei = field.ravel_index(zi, yi, xi)
 
@@ -314,7 +314,7 @@ def _search_indices_curvilinear_2d(
     eta = np.where(eta < 0.0, 0.0, np.where(eta > 1.0, 1.0, eta))
 
     if np.any((xsi < 0) | (xsi > 1) | (eta < 0) | (eta > 1)):
-        _raise_field_sampling_error(y, x)
+        _raise_grid_searching_error(y, x)
     return (yi, eta, xi, xsi)
 
 
@@ -400,7 +400,7 @@ def _search_indices_curvilinear(field, time, z, y, x, ti, particle=None, search2
         zeta = 0
 
     if not ((0 <= xsi <= 1) and (0 <= eta <= 1) and (0 <= zeta <= 1)):
-        _raise_field_sampling_error(z, y, x)
+        _raise_grid_searching_error(z, y, x)
 
     if particle:
         particle.ei[field.igrid] = field.ravel_index(zi, yi, xi)

parcels/kernel.py

@@ -15,9 +15,11 @@
 from parcels.basegrid import GridType
 from parcels.tools.statuscodes import (
     StatusCode,
+    _raise_field_interpolation_error,
     _raise_field_out_of_bound_error,
     _raise_field_out_of_bound_surface_error,
-    _raise_field_sampling_error,
+    _raise_general_error,
+    _raise_grid_searching_error,
     _raise_time_extrapolation_error,
 )
 from parcels.tools.warnings import KernelWarning
@@ -274,7 +276,9 @@ def execute(self, pset, endtime, dt):
                 StatusCode.ErrorTimeExtrapolation: _raise_time_extrapolation_error,
                 StatusCode.ErrorOutOfBounds: _raise_field_out_of_bound_error,
                 StatusCode.ErrorThroughSurface: _raise_field_out_of_bound_surface_error,
-                StatusCode.Error: _raise_field_sampling_error,
+                StatusCode.ErrorInterpolation: _raise_field_interpolation_error,
+                StatusCode.ErrorGridSearching: _raise_grid_searching_error,
+                StatusCode.Error: _raise_general_error,
             }
 
             for error_code, error_func in errors_to_throw.items():

parcels/tools/statuscodes.py

@@ -7,9 +7,11 @@
     "KernelError",
     "StatusCode",
     "TimeExtrapolationError",
+    "_raise_field_interpolation_error",
     "_raise_field_out_of_bound_error",
     "_raise_field_out_of_bound_surface_error",
-    "_raise_field_sampling_error",
+    "_raise_general_error",
+    "_raise_grid_searching_error",
     "_raise_time_extrapolation_error",
 ]
 
@@ -25,37 +27,38 @@ class StatusCode:
     StopAllExecution = 41
     Error = 50
     ErrorInterpolation = 51
+    ErrorGridSearching = 52
     ErrorOutOfBounds = 60
     ErrorThroughSurface = 61
     ErrorTimeExtrapolation = 70
 
 
-class FieldSamplingError(RuntimeError):
-    """Utility error class to propagate erroneous field sampling."""
+class FieldInterpolationError(RuntimeError):
+    """Utility error class to propagate NaN field interpolation."""
 
     pass
 
 
+def _raise_field_interpolation_error(z, y, x):
+    raise FieldInterpolationError(f"Field interpolation returned NaN at (depth={z}, lat={y}, lon={x})")
+
+
 class FieldOutOfBoundError(RuntimeError):
     """Utility error class to propagate out-of-bound field sampling."""
 
     pass
 
 
+def _raise_field_out_of_bound_error(z, y, x):
+    raise FieldOutOfBoundError(f"Field sampled out-of-bound, at (depth={z}, lat={y}, lon={x})")
+
+
 class FieldOutOfBoundSurfaceError(RuntimeError):
     """Utility error class to propagate out-of-bound field sampling at the surface."""
 
     pass
 
 
-def _raise_field_sampling_error(z, y, x):
-    raise FieldSamplingError(f"Field sampled at (depth={z}, lat={y}, lon={x})")
-
-
-def _raise_field_out_of_bound_error(z, y, x):
-    raise FieldOutOfBoundError(f"Field sampled out-of-bound, at (depth={z}, lat={y}, lon={x})")
-
-
 def _raise_field_out_of_bound_surface_error(z: float | None, y: float | None, x: float | None) -> None:
     def format_out(val):
         return "unknown" if val is None else val
@@ -65,6 +68,32 @@ def format_out(val):
     )
 
 
+class FieldSamplingError(RuntimeError):
+    """Utility error class to propagate field sampling errors."""
+
+    pass
+
+
+class GridSearchingError(RuntimeError):
+    """Utility error class to propagate grid searching errors."""
+
+    pass
+
+
+def _raise_grid_searching_error(z, y, x):
+    raise GridSearchingError(f"Grid searching failed at (depth={z}, lat={y}, lon={x})")
+
+
+class GeneralError(RuntimeError):
+    """Utility error class to propagate general errors."""
+
+    pass
+
+
+def _raise_general_error(z, y, x):
+    raise GeneralError(f"General error occurred at (depth={z}, lat={y}, lon={x})")
+
+
 class TimeExtrapolationError(RuntimeError):
     """Utility error class to propagate erroneous time extrapolation sampling."""
 
@@ -91,9 +120,11 @@ def __init__(self, particle, fieldset=None, msg=None):
 
 
 AllParcelsErrorCodes = {
-    FieldSamplingError: StatusCode.Error,
+    FieldInterpolationError: StatusCode.ErrorInterpolation,
     FieldOutOfBoundError: StatusCode.ErrorOutOfBounds,
     FieldOutOfBoundSurfaceError: StatusCode.ErrorThroughSurface,
+    GridSearchingError: StatusCode.ErrorGridSearching,
     TimeExtrapolationError: StatusCode.ErrorTimeExtrapolation,
     KernelError: StatusCode.Error,
+    GeneralError: StatusCode.Error,
 }