Skip to content

Commit 705aae2

Browse files
committed
Add docs for SIR54 and Alshina methods
Signed-off-by: ErikQQY <2283984853@qq.com>
1 parent e1584b0 commit 705aae2

File tree

5 files changed

+14
-8
lines changed

5 files changed

+14
-8
lines changed

docs/src/features/ensemble.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ EnsembleProblem(prob::DEProblem;
3030
`rerun` was true this will be `2`, `3`, etc. counting the number of times
3131
problem `i` has been repeated.
3232
- `reduction`: This function determines how to reduce the data in each batch.
33-
Defaults to appending the `data` into `u`, initialised via `u_data`, from
34-
the batches. `I` is a range of indices giving the trajectories corresponding
35-
to the batches. The second part of the output determines whether the simulation
36-
has converged. If `true`, the simulation will exit early. By default, this is
33+
Defaults to appending the `data` into `u`, initialised via `u_data`, from
34+
the batches. `I` is a range of indices giving the trajectories corresponding
35+
to the batches. The second part of the output determines whether the simulation
36+
has converged. If `true`, the simulation will exit early. By default, this is
3737
always `false`.
38-
- `u_init`: The initial form of the object that gets updated in-place inside the
38+
- `u_init`: The initial form of the object that gets updated in-place inside the
3939
`reduction` function.
4040
- `safetycopy`: Determines whether a safety `deepcopy` is called on the `prob`
4141
before the `prob_func`. By default, this is true for any user-given `prob_func`,

docs/src/solvers/dae_solve.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,11 @@ extra options for the solvers, see the ODE solver page.
9393
- `ROS34PW3` - A 4th order strongly A-stable (Rinf~0.63) Rosenbrock-W method.
9494

9595
!!! note
96+
9697

97-
`Rosenbrock23` and `Rosenbrock32` have a stiff-aware interpolation but this interpolation is not safe for the algebraic variables.
98-
Thus use the interpolation (thus `saveat`) with caution if the default Hermite interpolation is used.
98+
`Rosenbrock23` and `Rosenbrock32` have a stiff-aware interpolation but this interpolation is not safe for the algebraic variables.
99+
Thus use the interpolation (thus `saveat`) with caution if the default Hermite interpolation is used.
99100

100-
101101
#### FIRK Methods
102102

103103
- `RadauIIA5` - An A-B-L stable fully implicit Runge-Kutta method with internal

docs/src/solvers/dynamical_solve.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ These correspond to partitioned equations of motion:
1919
```
2020

2121
or, for `SecondOrderODEProblem`,
22+
2223
```math
2324
\frac{d^2u}{dt^2} = f(u,p,t)
2425
```

docs/src/solvers/nonautonomous_linear_ode.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,7 @@ These methods can be used when ``A`` is dependent on the state variables, i.e. `
125125
- `RKMK4` - Fourth order Runge–Kutta–Munthe-Kaas method.
126126
- `LieRK4` - Fourth order Lie Runge-Kutta method.
127127
- `CG2` - Second order Crouch–Grossman method.
128+
- `CG4a` - Fourth order Crouch-Grossman method.
128129
- `MagnusAdapt4` - Fourth Order Adaptive Magnus method.
129130

130131
Example:

docs/src/solvers/ode_solve.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,10 @@ problems.
177177
- `MSRK5` - Stepanov 5th-order Runge-Kutta method.
178178
- `MSRK6` - Stepanov 6th-order Runge-Kutta method.
179179
- `Stepanov5` - Stepanov adaptive 5th-order Runge-Kutta method.
180+
- `SIR54` - 5th order explicit Runge-Kutta method suited for SIR-type epidemic models.
181+
- `Alshina2` - Alshina 2nd-order Runge-Kutta method.
182+
- `Alshina3` - Alshina 3rd-order Runge-Kutta method.
183+
- `Alshina6` - Alshina 6th-order Runge-Kutta method.
180184

181185
Example usage:
182186

0 commit comments

Comments
 (0)