Skip to content

Commit 7642ae3

Browse files
authored
Merge pull request #162 from stan-dev/issue-document-ode-adams
add Adams-Moulton ODE solver doc
2 parents 344d3d2 + 18c7ee0 commit 7642ae3

File tree

2 files changed

+21
-2
lines changed

2 files changed

+21
-2
lines changed

src/functions-reference/higher-order_functions.Rmd

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,21 @@ control parameters for the solver.
211211
Deprecated. Solves the ODE system for the times provided with a
212212
non-stiff solver. This calls the Runge Kutta Dopri algorithm.
213213

214+
<!-- real[]; integrate_ode_adams; (function ode, real[] initial_state, real initial_time, real[] times, real[] theta, data real[] x_r, data int[] x_i); -->
215+
\index{{\tt \bfseries integrate\_ode\_adams }!{\tt (function ode, real[] initial\_state, real initial\_time, real[] times, real[] theta, data real[] x\_r, data int[] x\_i): real[]}|hyperpage}
216+
217+
`real[]` **`integrate_ode_adams`**`(function ode, real[] initial_state, real initial_time, real[] times, real[] theta, data real[] x_r, data int[] x_i)`<br>\newline
218+
Solves the ODE system for the times provided using the Adams-Moulton
219+
method with the implementation from CVODES.
220+
221+
<!-- real[]; integrate_ode_adams; (function ode, real[] initial_state, real initial_time, real[] times, real[] theta, data real[] x_r, data int[] x_i, data real rel_tol, data real abs_tol, dta int max_num_steps); -->
222+
\index{{\tt \bfseries integrate\_ode\_adams }!{\tt (function ode, real[] initial\_state, real initial\_time, real[] times, real[] theta, data real[] x\_r, data int[] x\_i, data real rel\_tol, data real abs\_tol, dta int max\_num\_steps): real[]}|hyperpage}
223+
224+
`real[]` **`integrate_ode_adams`**`(function ode, real[] initial_state, real initial_time, real[] times, real[] theta, data real[] x_r, data int[] x_i, data real rel_tol, data real abs_tol, dta int max_num_steps)`<br>\newline
225+
Solves the ODE system for the times provided using the Adams-Moulton
226+
method with the implementation from CVODES with additional control
227+
parameters for the CVODES solver.
228+
214229
### Stiff Solver
215230

216231
<!-- real[]; integrate_ode_bdf; (function ode, real[] initial_state, real initial_time, real[] times, real[] theta, data real[] x_r, data int[] x_i); -->

src/stan-users-guide/odes.Rmd

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
# Ordinary Differential Equations {#ode-solver.chapter}
22

33
Stan provides a built-in mechanism for specifying and solving systems
4-
of ordinary differential equations (ODEs). Stan provides two
5-
different integrators, one tuned for solving non-stiff systems and one
4+
of ordinary differential equations (ODEs). Stan provides three
5+
different integrators, tuned for solving non-stiff systems and
66
for stiff systems.
77

88
* `rk45`: a fourth and fifth order Runge-Kutta method for
99
non-stiff systems [@DormandPrince:1980; @AhnertMulansky:2011], and
1010

11+
* `adams`: a variable-step, variable-order,
12+
Adams-Moulton formula implementation for non-stiff systems
13+
[@CohenHindmarsh:1996; @SerbanHindmarsh:2005]
14+
1115
* `bdf`: a variable-step, variable-order,
1216
backward-differentiation formula implementation for stiff systems
1317
[@CohenHindmarsh:1996; @SerbanHindmarsh:2005]

0 commit comments

Comments
 (0)