Repository navigation
Vertical Coordinate Interpolators - #3037
Conversation
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
…s-code/Parcels into vertical-coordinate-interpolators
for more information, see https://pre-commit.ci
erikvansebille
left a comment
There was a problem hiding this comment.
Looks good! Some comments below
| warnings.warn( | ||
| "Time-varying (3D) z coordinates are experimental and may cause significant memory overhead that " | ||
| f"leads to OOM errors. This z coordinate has sizes {dict(z.sizes)} ({z.nbytes / 1e9:.3g} GB). " | ||
| f"Assumptions: z has dims {z.dims}, i.e. it is defined at the layer interfaces ('zf') on the mesh " | ||
| "nodes or faces, and is strictly increasing along 'zf'; each particle's z column is interpolated with " | ||
| "the grid's `z_interp_method` (by default barycentrically from its face's nodes for node z, or " | ||
| "constant over its face for face z), and linearly in time between z snapshots.", | ||
| FieldSetWarning, | ||
| stacklevel=5, |
There was a problem hiding this comment.
But I thought this warning may not be necessary anymore because the 4D depth fields can use the ChunkCachedArray or WindowedArray backend?
There was a problem hiding this comment.
This is true, I had kept it because we currently don't set it to be ChunkCachedArray or WindowedArray explicitly, but we should probably do this in _init_time_varying_z and then remove the warning.
| isinstance(value, XVerticalCoordinateConstant) | ||
| and get_dim_position(self.sgrid_metadata, depth_dims[-1]) != "face" | ||
| ): | ||
| raise ValueError(f"XVerticalCoordinateConstant needs depth on the cell centres, got dims {depth_dims}") |
There was a problem hiding this comment.
Can we be more explicit here what the cell centres are called in this dataset? Would we know that?
There was a problem hiding this comment.
Yes we can be more explicit. Fixed in 401194b
|
|
||
| if "Z" in self.axes and ds.depth.ndim == 4: | ||
| zi, zeta = self._search_time_varying_depth(z, yi, xi, ti, tau) | ||
| zi, zeta = self._search_time_varying_depth(z, yi, eta, xi, xsi, ti, tau) |
There was a problem hiding this comment.
I only realise this now, but would it not make more sense to use the order ti, tau, yi, eta, xi, xsi for the position here - in order to harmonise dimensionality throughout the codebase?
There was a problem hiding this comment.
I can't comment on individual lines, so below some comments on the notebook
- rename the title to use lowercase `time varying'?
- use the hide-input tag for the dataset creation cell, so that users don't get overwhelmed by it? It's not that relevant for most users how the dataset is created?
- Type-o in coordiante
- Is it expected that the particles don't move horizontally on the right panel of the last animation?
There was a problem hiding this comment.
Fixed in fdde86e
It is expected that the particles don't move horizontally, the goal here is to show that when using a discontinuous interpolation scheme you can get spurious particle deletion for near surface particles when they grid moves around them. I changed the animations to change the color of the particles when they are deleted and then include a legend for the animation. Let me know what you think, it is possible that it is best to just remove the code blocks in the "Choosing how z is interpolated" section entirely.
There was a problem hiding this comment.
Ah, I only now realise that these particles are deleted. Perhaps change them from a circle to a cross when they are deleted? Would that be even clearer?
There was a problem hiding this comment.
Yep, that's a good idea. Changed in 06cda90
| def __repr__(self): | ||
| return f"{self.__class__.__name__}(...)" |
There was a problem hiding this comment.
Should we move this interpolators.__repr__ to the repr_utils.py file, so they are all in one place
There was a problem hiding this comment.
That makes sense, this way ScalarInterpolator, VectorInterpolator, and VerticalCoordinateInterpolator are also guaranteed to have the same format. Changed in 4b6d64b
…s-code/Parcels into vertical-coordinate-interpolators
…xgrid constructors, and to uxgrid fields
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
…s-code/Parcels into vertical-coordinate-interpolators
for more information, see https://pre-commit.ci
erikvansebille
left a comment
There was a problem hiding this comment.
Besides the suggestion above on perhaps using a cross x instead of a circle for deleted particles in the final animation of the notebook, I think this PR is good to go!
|
Great! I'll wait for CI and then merge! |
Description
This PR addresses the need for more complex interpolation methods for time varying z dimensions, while maintaining flexibility for users and alignment with the current interpolator API.
The key change is the introduction of a
VerticalCoordinateInterpolatorabstract class that sits at the same level as the Vector and Scalar interpolator classes. At its core, theVerticalCoordinateInterpolatorclass enables any existing or user madeScalarInterpolatorto be used to interpolate the vertical coordinate. This is done through its base method_columns_from_scalar, which takes in a scalar interpolator and uses it to run a horizontal interpolation on every vertical interface at each particle's horizontal position. These interfaces are then used to reconstruct the vertical columns at each particle position, which can be used for the vertical grid search.For time varying z coordinate datasets, a vertical coordinate interpolator is set during Fieldset creation, and can be overwritten by the user.
This PR also adjusts all UxInterpolators to perform linear in time interpolation for data that falls between two model snapshots. This is required to avoid large temporal jump discontinuities in time varying vertical grids.
Checklist
mainfor normal development,v3-supportfor v3 support)AI Disclosure