Skip to content

Commit

Permalink
Merge pull request #664 from DanielVandH/patch-1
Browse files Browse the repository at this point in the history
Clarify the meaning of `u_data` and `I` in the EnsembleProblem docs
  • Loading branch information
ChrisRackauckas authored Mar 21, 2023
2 parents eadca99 + 4c72bfa commit 881ee71
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions docs/src/features/ensemble.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,13 @@ EnsembleProblem(prob::DEProblem;
`rerun` was true this will be `2`, `3`, etc. counting the number of times
problem `i` has been repeated.
- `reduction`: This function determines how to reduce the data in each batch.
Defaults to appending the data from the batches. The second part of the output
determines whether the simulation has converged. If `true`, the simulation
will exit early. By default, this is always `false`.
Defaults to appending the `data` into `u`, initialised via `u_data`, from
the batches. `I` is a range of indices giving the trajectories corresponding
to the batches. The second part of the output determines whether the simulation
has converged. If `true`, the simulation will exit early. By default, this is
always `false`.
- `u_init`: The initial form of the object that gets updated in-place inside the
`reduction` function.
- `safetycopy`: Determines whether a safety `deepcopy` is called on the `prob`
before the `prob_func`. By default, this is true for any user-given `prob_func`,
as without this, modifying the arguments of something in the `prob_func`, such
Expand Down

0 comments on commit 881ee71

Please sign in to comment.