From 7b2e43d3b7330a6f9df56dcd3aabb0a3543b35bc Mon Sep 17 00:00:00 2001 From: jClugstor Date: Sat, 15 Feb 2025 14:08:47 -0500 Subject: [PATCH] aliasing_API docstring for diffeqbase --- src/solve.jl | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/solve.jl b/src/solve.jl index 722442696..33ac4513c 100644 --- a/src/solve.jl +++ b/src/solve.jl @@ -946,8 +946,12 @@ explanations of the timestepping algorithms, see the Note that this is only required if the algorithm doesn't have a free or lazy interpolation (`DP8()`). If `calck = false`, `saveat` cannot be used. The rare keyword `calck` can be useful in event handling. -* `alias_u0`: allows the solver to alias the initial condition array that is contained - in the problem struct. Defaults to false. +* `alias`: an `AbstractAliasSpecifier` object that holds fields specifying which variables to alias + when solving. For example, to tell an ODE solver to alias the `u0` array, you can use an `ODEAliases` object, + and the `alias_u0` keyword argument, e.g. `solve(prob,alias = ODEAliases(alias_u0 = true))`. + For more information on what can be aliased for each problem type, see the documentation for the `AbstractAliasSpecifier` + associated with that problem type. Set to `true` to alias every variable possible, or to `false` to disable aliasing. + Defaults to an `AbstractAliasSpecifier` instance with `nothing` for all fields, which tells the solver to use the default behavior. ### Miscellaneous