Skip to content

Commit

Permalink
more alias explanation
Browse files Browse the repository at this point in the history
  • Loading branch information
jClugstor committed Dec 12, 2024
1 parent ead4d02 commit 02c6300
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/src/interfaces/Common_Keywords.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,10 @@ Note that if a method does not have adaptivity, the following rules apply:

- `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))`. The fields of
every `AbstractAliasSpecifier` default to `nothing`, which tells the solver to use its default behavior.
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.
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.
- `cache`: pass a solver cache to decrease the construction time. This is not implemented
for any of the problem interfaces at this moment.

Expand Down

0 comments on commit 02c6300

Please sign in to comment.