Skip to content

Aliasing API Docstring #1118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ChrisRackauckas merged 1 commit into from
Feb 16, 2025
Merged

Aliasing API Docstring #1118

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/solve.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading