Skip to content

Commit 991d0e9

Browse files
Apply writing suggestions from code review
Co-authored-by: Erik van Sebille <[email protected]>
1 parent fe37280 commit 991d0e9

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/user_guide/examples/explanation_interpolation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ relate to the value at any point within a grid cell.
2121

2222
Each `parcels.Field` is defined on a (structured) `parcels.XGrid` or (unstructured) `parcels.UXGrid`.
2323
The interpolation function takes information about the particles position relative to this grid (`grid_positions`),
24-
as well as the `parcels.Field` values of the surrounding grid points in time and space, to calculate
25-
the requested value at the particles location.
24+
as well as the values of the grid points of the `parcels.Field` in time and space, to calculate
25+
the requested value at the particles location. Note that all grid values are available so that higher-order interpolation is possible.
2626

2727
## Interpolator API
2828

2929
The interpolators included in Parcels are designed for common interpolation schemes in Parcels simulations.
3030
If we want to add a custom interpolation method, we need to look at the interpolator API:
3131

32-
We can write an interpolator function that takes a `parcels.Field`, a dictionary with the `particle_positions`
32+
We can write an interpolator function that takes a `parcels.Field` (or `parcels.VectorField`), a dictionary with the `particle_positions`
3333
in real space and time, and a dictionary with the `grid_positions`.
3434

3535
The `particle_positions` dictionary contains:
@@ -38,7 +38,7 @@ The `particle_positions` dictionary contains:
3838
particle_positions = {"time", time, "z", z, "lat", lat, "lon", lon}
3939
```
4040

41-
For structured (`X`) grids, the `grid_positions` dictionary looks like:
41+
For structured (`X`) grids, the `grid_positions` dictionary contains:
4242

4343
```
4444
grid_positions = {

0 commit comments

Comments
 (0)