Delete old 3d interpolator

Author: VeckoTheGecko

parcels/_interpolation.py

@@ -3,7 +3,7 @@
 
 import numpy as np
 
-from parcels._typing import GridIndexingType, InterpMethodOption
+from parcels._typing import GridIndexingType
 
 
 @dataclass
@@ -73,7 +73,6 @@ class InterpolationContext3D:
     yi: int
     xi: int
     gridindexingtype: GridIndexingType  #! Needed in 2d as well??
-    interp_method: InterpMethodOption  # TODO: Remove during refactoring
 
 
 _interpolator_registry_2d: dict[str, Callable[[InterpolationContext2D], float]] = {}
@@ -248,37 +247,6 @@ def z_layer_interp(*, zeta: float, f0: float, f1: float, zi: int, zdim: int, gri
     return (1 - zeta) * f0 + zeta * f1
 
 
-@register_3d_interpolator("linear")
-@register_3d_interpolator("bgrid_velocity")
-@register_3d_interpolator("bgrid_w_velocity")
-@register_3d_interpolator("partialslip")
-@register_3d_interpolator("freeslip")
-def _linear_3d_old(ctx: InterpolationContext3D) -> float:
-    zeta = ctx.zeta
-    eta = ctx.eta
-    xsi = ctx.xsi
-    zdim = ctx.data.shape[1]
-    if ctx.interp_method == "bgrid_velocity":
-        if ctx.gridindexingtype == "mom5":
-            zeta = 1.0
-        else:
-            zeta = 0.0
-    elif ctx.interp_method == "bgrid_w_velocity":
-        eta = 1.0
-        xsi = 1.0
-    data_3d = ctx.data[ctx.ti, :, :, :]
-    f0, f1 = get_3d_f0_f1(eta=eta, xsi=xsi, data=data_3d, zi=ctx.zi, yi=ctx.yi, xi=ctx.xi)
-
-    if ctx.gridindexingtype == "pop" and ctx.zi >= zdim - 2:
-        # Since POP is indexed at cell top, allow linear interpolation of W to zero in lowest cell
-        return (1 - zeta) * f0
-    if ctx.interp_method == "bgrid_w_velocity" and ctx.gridindexingtype == "mom5" and ctx.zi == -1:
-        # Since MOM5 is indexed at cell bottom, allow linear interpolation of W to zero in uppermost cell
-        return zeta * f1
-    else:
-        return (1 - zeta) * f0 + zeta * f1
-
-
 @register_3d_interpolator("linear")
 @register_3d_interpolator("partialslip")
 @register_3d_interpolator("freeslip")

parcels/field.py

@@ -1258,9 +1258,7 @@ def interpolator3D(self, *_):
     def _interpolator3D(self, ti, z, y, x, time, particle=None):
         """Impelement 3D interpolation with coordinate transformations as seen in Delandmeter, P. and van Sebille, E (2019)."""
         (zeta, eta, xsi, zi, yi, xi) = self._search_indices(time, z, y, x, ti, particle=particle)
-        ctx = InterpolationContext3D(
-            self.data, zeta, eta, xsi, ti, zi, yi, xi, self.gridindexingtype, self.interp_method
-        )
+        ctx = InterpolationContext3D(self.data, zeta, eta, xsi, ti, zi, yi, xi, self.gridindexingtype)
 
         try:
             f = get_3d_interpolator_registry()[self.interp_method]

tests/test_interpolation.py

@@ -96,49 +96,6 @@ def test_3d(self, data_3d, func, zeta, eta, xsi, expected):
         assert func(ctx) == expected
 
 
-@pytest.mark.parametrize("zeta", np.linspace(0, 1, 5))
-@pytest.mark.parametrize("eta", np.linspace(0, 1, 5))
-@pytest.mark.parametrize("xsi", np.linspace(0, 1, 5))
-@pytest.mark.parametrize(
-    "interp_method",
-    [
-        "linear",
-        "bgrid_velocity",
-        "bgrid_w_velocity",
-        "partialslip",
-        "freeslip",
-        "linear_invdist_land_tracer",
-        "bgrid_tracer",
-        "cgrid_tracer",
-    ],
-)
-@pytest.mark.parametrize(
-    "gridindexingtype",
-    [
-        "mom5",
-        "pop",
-    ],
-)
-def test_interpolation_3d_refactor(data_3d, zeta, eta, xsi, interp_method, gridindexingtype):
-    # fmt: off
-    f_old, f_new = {
-        "linear":           (interpolation._linear_3d_old, interpolation._linear_3d),
-        "bgrid_velocity":   (interpolation._linear_3d_old, interpolation._linear_3d_bgrid_velocity),
-        "bgrid_w_velocity": (interpolation._linear_3d_old, interpolation._linear_3d_old),
-        "partialslip":      (interpolation._linear_3d_old, interpolation._linear_3d),
-        "freeslip":         (interpolation._linear_3d_old, interpolation._linear_3d),
-        "linear_invdist_land_tracer": (interpolation._linear_invdist_land_tracer_3d, interpolation._linear_invdist_land_tracer_3d),
-        "bgrid_tracer":     (interpolation._tracer_3d, interpolation._tracer_3d),
-        "cgrid_tracer":     (interpolation._tracer_3d, interpolation._tracer_3d),
-    }[interp_method]
-    # fmt: on
-
-    ti, zi, yi, xi = 1, 1, 1, 1
-
-    ctx = interpolation.InterpolationContext3D(data_3d, zeta, eta, xsi, ti, zi, yi, xi, gridindexingtype, interp_method)
-    assert np.isclose(f_old(ctx), f_new(ctx))
-
-
 @pytest.mark.usefixtures("tmp_interpolator_registry")
 def test_full_depth_provided_to_interpolators():
     """The full depth needs to be provided to the interpolation schemes as some interpolators