Skip to content

Commit c568c0e

Browse files
Merge pull request #942 from jClugstor/alias_API_docs
Add alias types to problem interface docs
2 parents 9c376ac + 8b03276 commit c568c0e

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/src/interfaces/Problems.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,26 @@ 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+
An `AbstractAliasSpecifier` is associated with each SciMLProblem type. Each 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+
139+
```@docs
140+
SciMLBase.AbstractAliasSpecifier
141+
SciMLBase.LinearAliasSpecifier
142+
SciMLBase.NonlinearAliasSpecifier
143+
SciMLBase.ODEAliasSpecifier
144+
SciMLBase.SDEAliasSpecifier
145+
SciMLBase.DDEAliasSpecifier
146+
SciMLBase.SDDEAliasSpecifier
147+
SciMLBase.BVPAliasSpecifier
148+
SciMLBase.OptimizationAliasSpecifier
149+
SciMLBase.IntegralAliasSpecifier
150+
SciMLBase.DiscreteAliasSpecifier
151+
```
152+
133153
## Problem Traits
134154

135155
```@docs

0 commit comments

Comments
 (0)