Skip to content

Commit 376c069

Browse files
Adding info on Interaction Kernel in migration guide
1 parent cefddfc commit 376c069

File tree

2 files changed

+2
-1
lines changed

2 files changed

+2
-1
lines changed

docs/user_guide/examples/tutorial_interaction.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
"outputs": [],
5656
"source": [
5757
"def Pull(particles, fieldset):\n",
58-
" \"\"\"Kernel that \"pulls\" all neighbor particles\n",
58+
" \"\"\"Kernel that \"pulls\" all neighbour particles\n",
5959
" toward the attracting particle with a constant velocity\"\"\"\n",
6060
" interaction_distance = 0.5\n",
6161
" velocity = -0.04 # predefined attracting velocity\n",

docs/user_guide/v4-migration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Version 4 of Parcels is unreleased at the moment. The information in this migrat
1414
- The `particle` argument in the Kernel signature has been renamed to `particles`.
1515
- `math` functions should be replaced with array compatible equivalents (e.g., `math.sin` -> `np.sin`). Instead of `ParcelsRandom` you should use numpy's random functions.
1616
- `particle.depth` has been changed to `particles.z` to be consistent with the [CF conventions for trajectory data](https://cfconventions.org/cf-conventions/cf-conventions.html#trajectory-data), and to make Parcels also generalizable to atmospheric contexts.
17+
- The `InteractionKernel` class has been removed. Since normal Kernels now have access to _all_ particles, particle-particle interaction can be performed within normal Kernels.
1718

1819
## FieldSet
1920

0 commit comments

Comments
 (0)