Skip to content

Commit ead4d02

Browse files
committed
better docs for AliasSpecifiers
1 parent b420a7b commit ead4d02

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/src/interfaces/Common_Keywords.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,12 @@ Note that if a method does not have adaptivity, the following rules apply:
101101

102102
## Memory Optimizations
103103

104-
- `alias`: an `ODEAliases` object that holds the field `alias_u0`, which allows the solver to alias the
105-
initial condition array that is contained in the problem struct. For example, tell the solver to alias `u0`,
106-
`solve(prob,alias = ODEAliases(alias_u0 = true))`. Defaults to `ODEAliases(alias_u0 = false)`.
104+
- `alias`: an `AbstractAliasSpecifier` object that holds fields specifying which variables to alias
105+
when solving. For example, to tell an ODE solver to alias the `u0` array, you can use an `ODEAliases` object,
106+
and the `alias_u0` keyword argument, e.g. `solve(prob,alias = ODEAliases(alias_u0 = true))`. The fields of
107+
every `AbstractAliasSpecifier` default to `nothing`, which tells the solver to use its default behavior.
108+
For more information on what can be aliased for each problem type, see the documentation for the `AbstractAliasSpecifier`
109+
associated with that problem type.
107110
- `cache`: pass a solver cache to decrease the construction time. This is not implemented
108111
for any of the problem interfaces at this moment.
109112

0 commit comments

Comments
 (0)