Skip to content

Commit 4cc9f2e

Browse files
Rename field interpolation methods
Removing `spatial` in interpolation method names, as interpolation is not only about space anymore, but also time
1 parent 51f60ec commit 4cc9f2e

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

parcels/field.py

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -642,7 +642,7 @@ def _interpolator3D(self, time, z, y, x, particle=None):
642642
ctx = InterpolationContext3D(self.data, tau, zeta, eta, xsi, ti, zi, yi, xi, self.gridindexingtype)
643643
return f(ctx)
644644

645-
def _spatial_interpolation(self, time, z, y, x, particle=None):
645+
def _interpolate(self, time, z, y, x, particle=None):
646646
"""Interpolate spatial field values."""
647647
try:
648648
if self.grid.zdim == 1:
@@ -720,7 +720,7 @@ def eval(self, time, z, y, x, particle=None, applyConversion=True):
720720
if self.gridindexingtype == "croco" and self not in [self.fieldset.H, self.fieldset.Zeta]:
721721
z = _croco_from_z_to_sigma_scipy(self.fieldset, time, z, y, x, particle=particle)
722722

723-
value = self._spatial_interpolation(time, z, y, x, particle=particle)
723+
value = self._interpolate(time, z, y, x, particle=particle)
724724

725725
if applyConversion:
726726
return self.units.to_target(value, z, y, x)
@@ -875,7 +875,7 @@ def _check_grid_dimensions(grid1, grid2):
875875
and np.allclose(grid1.time_full, grid2.time_full)
876876
)
877877

878-
def spatial_c_grid_interpolation2D(self, time, z, y, x, particle=None, applyConversion=True):
878+
def c_grid_interpolation2D(self, time, z, y, x, particle=None, applyConversion=True):
879879
grid = self.U.grid
880880
(tau, _, eta, xsi, ti, zi, yi, xi) = self.U._search_indices(time, z, y, x, particle=particle)
881881

@@ -956,7 +956,7 @@ def _calc_UV(ti, yi, xi):
956956
v = (1 - tau) * v + tau * vt1
957957
return (u, v)
958958

959-
def spatial_c_grid_interpolation3D_full(self, time, z, y, x, particle=None):
959+
def c_grid_interpolation3D_full(self, time, z, y, x, particle=None):
960960
grid = self.U.grid
961961
(tau, zeta, eta, xsi, ti, zi, yi, xi) = self.U._search_indices(time, z, y, x, particle=particle)
962962

@@ -1169,7 +1169,7 @@ def spatial_c_grid_interpolation3D_full(self, time, z, y, x, particle=None):
11691169
w = w.compute()
11701170
return (u, v, w)
11711171

1172-
def spatial_c_grid_interpolation3D(self, ti, z, y, x, time, particle=None, applyConversion=True):
1172+
def c_grid_interpolation3D(self, ti, z, y, x, time, particle=None, applyConversion=True):
11731173
"""Perform C grid interpolation in 3D. ::
11741174
11751175
+---+---+---+
@@ -1186,11 +1186,11 @@ def spatial_c_grid_interpolation3D(self, ti, z, y, x, time, particle=None, apply
11861186
Curvilinear grids are treated properly, since the element is projected to a rectilinear parent element.
11871187
"""
11881188
if self.U.grid._gtype in [GridType.RectilinearSGrid, GridType.CurvilinearSGrid]:
1189-
(u, v, w) = self.spatial_c_grid_interpolation3D_full(time, z, y, x, particle=particle)
1189+
(u, v, w) = self.c_grid_interpolation3D_full(time, z, y, x, particle=particle)
11901190
else:
11911191
if self.gridindexingtype == "croco":
11921192
z = _croco_from_z_to_sigma_scipy(self.fieldset, time, z, y, x, particle=particle)
1193-
(u, v) = self.spatial_c_grid_interpolation2D(time, z, y, x, particle=particle)
1193+
(u, v) = self.c_grid_interpolation2D(time, z, y, x, particle=particle)
11941194
w = self.W.eval(time, z, y, x, particle=particle, applyConversion=False)
11951195
if applyConversion:
11961196
w = self.W.units.to_target(w, z, y, x)
@@ -1208,7 +1208,7 @@ def _is_land2D(self, di, yi, xi):
12081208
else:
12091209
return True
12101210

1211-
def spatial_slip_interpolation(self, time, z, y, x, particle=None, applyConversion=True):
1211+
def slip_interpolation(self, time, z, y, x, particle=None, applyConversion=True):
12121212
(_, zeta, eta, xsi, ti, zi, yi, xi) = self.U._search_indices(time, z, y, x, particle=particle)
12131213
di = ti if self.U.grid.zdim == 1 else zi # general third dimension
12141214

@@ -1311,7 +1311,7 @@ def spatial_slip_interpolation(self, time, z, y, x, particle=None, applyConversi
13111311

13121312
def eval(self, time, z, y, x, particle=None, applyConversion=True):
13131313
if self.U.interp_method in ["partialslip", "freeslip"]:
1314-
return self.spatial_slip_interpolation(time, z, y, x, particle=particle, applyConversion=applyConversion)
1314+
return self.slip_interpolation(time, z, y, x, particle=particle, applyConversion=applyConversion)
13151315

13161316
if self.U.interp_method not in ["cgrid_velocity", "partialslip", "freeslip"]:
13171317
u = self.U.eval(time, z, y, x, particle=particle, applyConversion=False)
@@ -1321,9 +1321,7 @@ def eval(self, time, z, y, x, particle=None, applyConversion=True):
13211321
v = self.V.units.to_target(v, z, y, x)
13221322
elif self.U.interp_method == "cgrid_velocity":
13231323
tau, ti = self.U._time_index(time)
1324-
(u, v) = self.spatial_c_grid_interpolation2D(
1325-
time, z, y, x, particle=particle, applyConversion=applyConversion
1326-
)
1324+
(u, v) = self.c_grid_interpolation2D(time, z, y, x, particle=particle, applyConversion=applyConversion)
13271325
if "3D" in self.vector_type:
13281326
w = self.W.eval(time, z, y, x, particle=particle, applyConversion=applyConversion)
13291327
return (u, v, w)

0 commit comments

Comments
 (0)