renaming raise method, updating message content and example for OutsideTimeInterval error

Author: vicenzodarezzo

docs/examples/example_globcurrent.py

@@ -121,7 +121,7 @@ def test__particles_init_time():
     assert pset[0].time - pset4[0].time == 0
 
 
-def test_globcurrent_time_extrapolation_error():
+def test_globcurrent_outside_time_interval_error():
     fieldset = set_globcurrent_fieldset()
     pset = parcels.ParticleSet(
         fieldset,

src/parcels/_core/index_search.py

@@ -5,7 +5,7 @@
 
 import numpy as np
 
-from parcels._core.statuscodes import _raise_time_extrapolation_error
+from parcels._core.statuscodes import _raise_outside_time_interval_error
 
 if TYPE_CHECKING:
     from parcels._core.field import Field
@@ -78,7 +78,7 @@ def _search_time_index(field: Field, time: datetime):
         return np.zeros(shape=time.shape, dtype=np.float32), np.zeros(shape=time.shape, dtype=np.int32)
 
     if not field.time_interval.is_all_time_in_interval(time):
-        _raise_time_extrapolation_error(time, field=None)
+        _raise_outside_time_interval_error(time, field=None)
 
     ti = np.searchsorted(field.data.time.data, time, side="right") - 1
     tau = (time - field.data.time.data[ti]) / (field.data.time.data[ti + 1] - field.data.time.data[ti])

src/parcels/_core/kernel.py

@@ -14,7 +14,7 @@
     _raise_field_out_of_bound_surface_error,
     _raise_general_error,
     _raise_grid_searching_error,
-    _raise_time_extrapolation_error,
+    _raise_outside_time_interval_error,
 )
 from parcels._core.warnings import KernelWarning
 from parcels.kernels import (
@@ -31,7 +31,7 @@
 
 
 ErrorsToThrow = {
-    StatusCode.ErrorOutsideTimeInterval: _raise_time_extrapolation_error,
+    StatusCode.ErrorOutsideTimeInterval: _raise_outside_time_interval_error,
     StatusCode.ErrorOutOfBounds: _raise_field_out_of_bound_error,
     StatusCode.ErrorThroughSurface: _raise_field_out_of_bound_surface_error,
     StatusCode.ErrorInterpolation: _raise_field_interpolation_error,

src/parcels/_core/statuscodes.py

@@ -12,7 +12,7 @@
     "_raise_field_out_of_bound_surface_error",
     "_raise_general_error",
     "_raise_grid_searching_error",
-    "_raise_time_extrapolation_error",
+    "_raise_outside_time_interval_error",
 ]
 
 
@@ -98,14 +98,11 @@ class OutsideTimeInterval(RuntimeError):
     """Utility error class to propagate erroneous time extrapolation sampling."""
 
     def __init__(self, time, field=None):
-        message = (
-            f"{field.name if field else 'Field'} sampled outside time domain at time {time}."
-            " Try setting allow_time_extrapolation to True."
-        )
+        message = f"{field.name if field else 'Field'} sampled outside time domain at time {time}."
         super().__init__(message)
 
 
-def _raise_time_extrapolation_error(time: float, field=None):
+def _raise_outside_time_interval_error(time: float, field=None):
     raise OutsideTimeInterval(time, field)