Skip to content

Commit 2893973

Browse files
add more transformations to the documentation
1 parent 09ed5bc commit 2893973

File tree

5 files changed

+25
-3
lines changed

5 files changed

+25
-3
lines changed

docs/src/systems/ControlSystem.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ControlSystem
88

99
## Composition and Accessor Functions
1010

11-
- `get_eqs(sys` or `equations(sys)`: The equations that define the system.
11+
- `get_eqs(sys)` or `equations(sys)`: The equations that define the system.
1212
- `get_states(sys)` or `states(sys)`: The set of states in the system.
1313
- `get_ps(sys)` or `parameters(sys)`: The parameters of the system.
1414
- `get_controls(sys)` or `controls(sys)`: The control variables of the system

docs/src/systems/NonlinearSystem.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ NonlinearSystem
1616

1717
```@docs
1818
structural_simplify
19+
alias_elimination
20+
tearing
1921
```
2022

2123
## Applicable Calculation and Generation Functions
@@ -31,3 +33,9 @@ jacobian_sparsity
3133
```@docs
3234
NonlinearProblem
3335
```
36+
37+
## Torn Problem Constructors
38+
39+
```@docs
40+
BlockNonlinearProblem
41+
```

docs/src/systems/ODESystem.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,10 @@ ODESystem
1818
```@docs
1919
structural_simplify
2020
ode_order_lowering
21+
dae_index_lowering
2122
liouville_transform
23+
alias_elimination
24+
tearing
2225
```
2326

2427
## Applicable Calculation and Generation Functions
@@ -33,9 +36,15 @@ generate_factorized_W
3336
jacobian_sparsity
3437
```
3538

36-
## Problem Constructors
39+
## Standard Problem Constructors
3740

3841
```@docs
3942
ODEFunction
4043
ODEProblem
4144
```
45+
46+
## Torn Problem Constructors
47+
48+
```@docs
49+
ODAEProblem
50+
```

docs/src/systems/ReactionSystem.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# ReactionSystem
22

3-
A `ReactionSystem` represents a system of chemical reactions. Conversions are provided to generate corresponding chemical reaction ODE models, chemical Langevin equation SDE models, and stochastic chemical kinetics jump process models. As a simple example, the code below creates a SIR model, and solves the corresponding ODE, SDE, and jump process models.
3+
A `ReactionSystem` represents a system of chemical reactions. Conversions are
4+
provided to generate corresponding chemical reaction ODE models, chemical
5+
Langevin equation SDE models, and stochastic chemical kinetics jump process
6+
models. As a simple example, the code below creates a SIR model, and solves
7+
the corresponding ODE, SDE, and jump process models.
48

59
```julia
610
using ModelingToolkit, OrdinaryDiffEq, StochasticDiffEq, DiffEqJump

docs/src/systems/SDESystem.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ SDESystem
1717

1818
```@docs
1919
structural_simplify
20+
alias_elimination
2021
```
2122

2223
## Applicable Calculation and Generation Functions

0 commit comments

Comments
 (0)