Skip to content

Commit 881ee71

Browse files
Merge pull request #664 from DanielVandH/patch-1
Clarify the meaning of `u_data` and `I` in the EnsembleProblem docs
2 parents eadca99 + 4c72bfa commit 881ee71

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

docs/src/features/ensemble.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,13 @@ EnsembleProblem(prob::DEProblem;
3030
`rerun` was true this will be `2`, `3`, etc. counting the number of times
3131
problem `i` has been repeated.
3232
- `reduction`: This function determines how to reduce the data in each batch.
33-
Defaults to appending the data from the batches. The second part of the output
34-
determines whether the simulation has converged. If `true`, the simulation
35-
will exit early. By default, this is always `false`.
33+
Defaults to appending the `data` into `u`, initialised via `u_data`, from
34+
the batches. `I` is a range of indices giving the trajectories corresponding
35+
to the batches. The second part of the output determines whether the simulation
36+
has converged. If `true`, the simulation will exit early. By default, this is
37+
always `false`.
38+
- `u_init`: The initial form of the object that gets updated in-place inside the
39+
`reduction` function.
3640
- `safetycopy`: Determines whether a safety `deepcopy` is called on the `prob`
3741
before the `prob_func`. By default, this is true for any user-given `prob_func`,
3842
as without this, modifying the arguments of something in the `prob_func`, such

0 commit comments

Comments
 (0)