Skip to content

Commit cd9ab6a

Browse files
committed
add alias types to problem interface docs
1 parent 4e76d51 commit cd9ab6a

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

docs/src/interfaces/Problems.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,29 @@ defaults `Dict(:a => :(2b), :c => 0.1)`. Then:
130130
`3.0` for `:a`, `:b` and `:c` respectively. Note how the explicitly specified value for
131131
`:a` overrides the dependent default.
132132

133+
134+
### Aliasing Specification
135+
`AbstractAliasSpecifier` object holds fields specifying which variables to alias
136+
when solving. For example, to tell an ODE solver to alias the `u0` array, you can use an `ODEAliases` object,
137+
and the `alias_u0` keyword argument, e.g. `solve(prob,alias = ODEAliases(alias_u0 = true))`.
138+
For more information on what can be aliased for each problem type, see the documentation for the `AbstractAliasSpecifier`
139+
associated with that problem type. Set to `true` to alias every variable possible, or to `false` to disable aliasing.
140+
Defaults to an `AbstractAliasSpecifier` instance with `nothing` for all fields, which tells the solver to use the default behavior.
141+
142+
```@docs
143+
SciMLBase.AbstractAliasSpecifier
144+
SciMLBase.LinearAliasSpecifier
145+
SciMLBase.NonlinearAliasSpecifier
146+
SciMLBase.ODEAliasSpecifier
147+
SciMLBase.SDEAliasSpecifier
148+
SciMLBase.DDEAliasSpecifier
149+
SciMLBase.SDDEAliasSpecifier
150+
SciMLBase.BVPAliasSpecifier
151+
SciMLBase.OptimizationAliasSpecifier
152+
SciMLBase.IntegralAliasSpecifier
153+
SciMLBase.DiscreteAliasSpecifier
154+
```
155+
133156
## Problem Traits
134157

135158
```@docs

0 commit comments

Comments
 (0)