From b98213c85be1da7a6c8b914df553f72e6aba5744 Mon Sep 17 00:00:00 2001 From: Erik van Sebille Date: Tue, 17 Nov 2026 07:52:50 +0100 Subject: [PATCH 1/4] Adding unit test for out-of-range ei search Based on minimal example by @jemmajeffree in #3062 --- tests/test_convert.py | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/tests/test_convert.py b/tests/test_convert.py index ac7f9ceae..523196ad4 100644 --- a/tests/test_convert.py +++ b/tests/test_convert.py @@ -372,3 +372,22 @@ def test_mom6_to_sgrid_withdepth(): V = V.expand_dims(depth=[0], axis=1) with pytest.raises(ValueError, match="has more than 2 spatial dimensions"): convert.mom6_to_sgrid(fields={"U": U, "V": V}, coords=coords) + + +def test_mom6_to_sgrid_clip_ei(): + U = parcels.tutorial.open_dataset("MOM6_example_data/U")["ssu"] + V = parcels.tutorial.open_dataset("MOM6_example_data/V")["ssv"] + coords = parcels.tutorial.open_dataset("MOM6_example_data/static") + ds = convert.mom6_to_sgrid(fields={"U": U, "V": V}, coords=coords) + fieldset = FieldSet.from_sgrid_conventions(ds) + + X = coords.geolon.isel(xh=-1) + Y = coords.geolat.isel(xh=-1) + + pset = parcels.ParticleSet(fieldset=fieldset, x=X, y=Y) + + pset.execute( + [parcels.kernels.AdvectionRK2], + runtime=np.timedelta64(12, "h"), + dt=np.timedelta64(1, "h"), + ) From e8f9b7b829f74db59ce2317ea47376e64454738b Mon Sep 17 00:00:00 2001 From: Erik van Sebille Date: Tue, 17 Nov 2026 07:53:21 +0100 Subject: [PATCH 2/4] Clip the particle element indices to be within axes dims --- src/parcels/_core/field.py | 7 ++++--- src/parcels/_core/xgrid.py | 2 ++ 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/src/parcels/_core/field.py b/src/parcels/_core/field.py index 2ab059b28..cfce5c0bb 100644 --- a/src/parcels/_core/field.py +++ b/src/parcels/_core/field.py @@ -319,9 +319,10 @@ def _update_particles_ei(particles, grid_positions: dict, field: Field): if isinstance(field.grid, XGrid): particles.ei[:, field.igrid] = field.grid.ravel_index( { - "X": grid_positions["X"]["index"], - "Y": grid_positions["Y"]["index"], - "Z": grid_positions["Z"]["index"], + # Clip the axis indices to be within the valid range of the grid dimensions (#3062) + "X": np.clip(grid_positions["X"]["index"], 0, field.grid.xdim - 1), + "Y": np.clip(grid_positions["Y"]["index"], 0, field.grid.ydim - 1), + "Z": np.clip(grid_positions["Z"]["index"], 0, field.grid.zdim - 1), } ) elif isinstance(field.grid, UxGrid): diff --git a/src/parcels/_core/xgrid.py b/src/parcels/_core/xgrid.py index c96fee26b..3bcde7af2 100644 --- a/src/parcels/_core/xgrid.py +++ b/src/parcels/_core/xgrid.py @@ -248,6 +248,8 @@ def ydim(self) -> int: @cached_property def zdim(self) -> int: + if "Z" not in self.axes: + return np.ones(1) return self.get_axis_dim("Z") def get_axis_dim(self, axis: ptyping.XgridAxis) -> int: From 30b75625f30f89825a4060c8ddc16f8d49e0f8dc Mon Sep 17 00:00:00 2001 From: Erik van Sebille Date: Tue, 17 Nov 2026 07:56:19 +0100 Subject: [PATCH 3/4] Also supporting missing xdim and ydim --- src/parcels/_core/xgrid.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/parcels/_core/xgrid.py b/src/parcels/_core/xgrid.py index 3bcde7af2..86e661566 100644 --- a/src/parcels/_core/xgrid.py +++ b/src/parcels/_core/xgrid.py @@ -240,10 +240,14 @@ def deg2m(self) -> float: @cached_property def xdim(self) -> int: + if "X" not in self.axes: + return np.ones(1) return self.get_axis_dim("X") @cached_property def ydim(self) -> int: + if "Y" not in self.axes: + return np.ones(1) return self.get_axis_dim("Y") @cached_property From 6355ed2dfe4588b1015e0f67b079687fcdbd4ce7 Mon Sep 17 00:00:00 2001 From: Erik van Sebille Date: Tue, 17 Nov 2026 16:44:33 +0100 Subject: [PATCH 4/4] Move grid size finding to _update_particles_ei --- src/parcels/_core/field.py | 17 +++++++++-------- src/parcels/_core/xgrid.py | 6 ------ 2 files changed, 9 insertions(+), 14 deletions(-) diff --git a/src/parcels/_core/field.py b/src/parcels/_core/field.py index 9c112d7d5..f0995cfed 100644 --- a/src/parcels/_core/field.py +++ b/src/parcels/_core/field.py @@ -319,15 +319,16 @@ def __getitem__(self, key): def _update_particles_ei(particles, grid_positions: dict, field: Field): """Update the element index (ei) of the particles""" if particles is not None: + + def _maybe_clip(axis): + # Helper function to clip the axis indices to be within the valid range of the grid dimensions (#3062) + if axis not in field.grid.axes: + return grid_positions[axis]["index"] + dim = field.grid.get_axis_dim(axis) + return (np.clip(grid_positions[axis]["index"], 0, dim - 1),) + if isinstance(field.grid, XGrid): - particles.ei[:, field.igrid] = field.grid.ravel_index( - { - # Clip the axis indices to be within the valid range of the grid dimensions (#3062) - "X": np.clip(grid_positions["X"]["index"], 0, field.grid.xdim - 1), - "Y": np.clip(grid_positions["Y"]["index"], 0, field.grid.ydim - 1), - "Z": np.clip(grid_positions["Z"]["index"], 0, field.grid.zdim - 1), - } - ) + particles.ei[:, field.igrid] = field.grid.ravel_index({axis: _maybe_clip(axis) for axis in ["X", "Y", "Z"]}) elif isinstance(field.grid, UxGrid): particles.ei[:, field.igrid] = field.grid.ravel_index( { diff --git a/src/parcels/_core/xgrid.py b/src/parcels/_core/xgrid.py index 86e661566..c96fee26b 100644 --- a/src/parcels/_core/xgrid.py +++ b/src/parcels/_core/xgrid.py @@ -240,20 +240,14 @@ def deg2m(self) -> float: @cached_property def xdim(self) -> int: - if "X" not in self.axes: - return np.ones(1) return self.get_axis_dim("X") @cached_property def ydim(self) -> int: - if "Y" not in self.axes: - return np.ones(1) return self.get_axis_dim("Y") @cached_property def zdim(self) -> int: - if "Z" not in self.axes: - return np.ones(1) return self.get_axis_dim("Z") def get_axis_dim(self, axis: ptyping.XgridAxis) -> int: