Skip to content

Commit 7b2e43d

Browse files
committed
aliasing_API docstring for diffeqbase
1 parent ad17258 commit 7b2e43d

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

src/solve.jl

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -946,8 +946,12 @@ explanations of the timestepping algorithms, see the
946946
Note that this is only required if the algorithm doesn't have
947947
a free or lazy interpolation (`DP8()`). If `calck = false`, `saveat` cannot be used.
948948
The rare keyword `calck` can be useful in event handling.
949-
* `alias_u0`: allows the solver to alias the initial condition array that is contained
950-
in the problem struct. Defaults to false.
949+
* `alias`: an `AbstractAliasSpecifier` object that holds fields specifying which variables to alias
950+
when solving. For example, to tell an ODE solver to alias the `u0` array, you can use an `ODEAliases` object,
951+
and the `alias_u0` keyword argument, e.g. `solve(prob,alias = ODEAliases(alias_u0 = true))`.
952+
For more information on what can be aliased for each problem type, see the documentation for the `AbstractAliasSpecifier`
953+
associated with that problem type. Set to `true` to alias every variable possible, or to `false` to disable aliasing.
954+
Defaults to an `AbstractAliasSpecifier` instance with `nothing` for all fields, which tells the solver to use the default behavior.
951955

952956
### Miscellaneous
953957

0 commit comments

Comments
 (0)