review feedback

Author: VeckoTheGecko

parcels/_interpolation.py

@@ -113,8 +113,8 @@ def _nearest_2d(ctx: InterpolationContext2D) -> float:
     return ctx.data[ctx.ti, yii, xii]
 
 
-def _unit_square_to_target(*, eta: float, xsi: float, data: np.ndarray, yi: int, xi: int) -> float:
-    """Interpolation on a unit square. See Delandmeter and Sebille 2019."""
+def _interp_on_unit_square(*, eta: float, xsi: float, data: np.ndarray, yi: int, xi: int) -> float:
+    """Interpolation on a unit square. See Delandmeter and Van Sebille (2019), 10.5194/gmd-12-3571-2019."""
     return (
         (1 - xsi) * (1 - eta) * data[yi, xi]
         + xsi * (1 - eta) * data[yi, xi + 1]
@@ -128,13 +128,7 @@ def _unit_square_to_target(*, eta: float, xsi: float, data: np.ndarray, yi: int,
 @register_2d_interpolator("partialslip")
 @register_2d_interpolator("freeslip")
 def _linear_2d(ctx: InterpolationContext2D) -> float:
-    xsi = ctx.xsi
-    eta = ctx.eta
-    data = ctx.data
-    yi = ctx.yi
-    xi = ctx.xi
-    ti = ctx.ti
-    val = _unit_square_to_target(eta=eta, xsi=xsi, data=data[ti, :, :], yi=yi, xi=xi)
+    val = _interp_on_unit_square(eta=ctx.eta, xsi=ctx.xsi, data=ctx.data[ctx.ti, :, :], yi=ctx.yi, xi=ctx.xi)
     return val
 
 
@@ -167,7 +161,7 @@ def _linear_invdist_land_tracer_2d(ctx: InterpolationContext2D) -> float:
                     w_sum += 1 / distance
         return val / w_sum
     else:
-        val = _unit_square_to_target(eta=eta, xsi=xsi, data=data[ti, :, :], yi=yi, xi=xi)
+        val = _interp_on_unit_square(eta=eta, xsi=xsi, data=data[ti, :, :], yi=yi, xi=xi)
         return val
 
 
@@ -221,23 +215,23 @@ def _linear_invdist_land_tracer_3d(ctx: InterpolationContext3D) -> float:
         return val / w_sum
     else:
         data = ctx.data[ctx.ti, ctx.zi, :, :]
-        f0 = _unit_square_to_target(eta=ctx.eta, xsi=ctx.xsi, data=data, yi=ctx.yi, xi=ctx.xi)
+        f0 = _interp_on_unit_square(eta=ctx.eta, xsi=ctx.xsi, data=data, yi=ctx.yi, xi=ctx.xi)
 
         data = ctx.data[ctx.ti, ctx.zi + 1, :, :]
-        f1 = _unit_square_to_target(eta=ctx.eta, xsi=ctx.xsi, data=data, yi=ctx.yi, xi=ctx.xi)
+        f1 = _interp_on_unit_square(eta=ctx.eta, xsi=ctx.xsi, data=data, yi=ctx.yi, xi=ctx.xi)
 
         return (1 - ctx.zeta) * f0 + ctx.zeta * f1
 
 
 def _get_3d_f0_f1(*, eta: float, xsi: float, data: np.ndarray, zi: int, yi: int, xi: int) -> tuple[float, float | None]:
     data_2d = data[zi, :, :]
-    f0 = _unit_square_to_target(eta=eta, xsi=xsi, data=data_2d, yi=yi, xi=xi)
+    f0 = _interp_on_unit_square(eta=eta, xsi=xsi, data=data_2d, yi=yi, xi=xi)
     try:
         data_2d = data[zi + 1, :, :]
     except IndexError:
         f1 = None  # POP indexing at edge of domain
     else:
-        f1 = _unit_square_to_target(eta=eta, xsi=xsi, data=data_2d, yi=yi, xi=xi)
+        f1 = _interp_on_unit_square(eta=eta, xsi=xsi, data=data_2d, yi=yi, xi=xi)
 
     return f0, f1
 
@@ -259,14 +253,11 @@ def _z_layer_interp(
 @register_3d_interpolator("partialslip")
 @register_3d_interpolator("freeslip")
 def _linear_3d(ctx: InterpolationContext3D) -> float:
-    zeta = ctx.zeta
-    eta = ctx.eta
-    xsi = ctx.xsi
     zdim = ctx.data.shape[1]
     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)
+    f0, f1 = _get_3d_f0_f1(eta=ctx.eta, xsi=ctx.xsi, data=data_3d, zi=ctx.zi, yi=ctx.yi, xi=ctx.xi)
 
-    return _z_layer_interp(zeta=zeta, f0=f0, f1=f1, zi=ctx.zi, zdim=zdim, gridindexingtype=ctx.gridindexingtype)
+    return _z_layer_interp(zeta=ctx.zeta, f0=f0, f1=f1, zi=ctx.zi, zdim=zdim, gridindexingtype=ctx.gridindexingtype)
 
 
 @register_3d_interpolator("bgrid_velocity")