View Source Integrator (Integrator v0.1.3)
A library for solving non-stiff ordinary differential equations (ODEs).
Integrator
uses either the Dormand-Prince 4/5 Runge Kutta algorithm, or the Bogacki-Shampine 2/3
Runge Kutta algorithm. It is intended that the user only needs to call Integrator.integrate/4
, and
the Integrator.AdaptiveStepsize
and Integrator.RungeKutta
modules are only exposed for advanced
users who want to use the underlying algorithms directly.
Summary
Functions
Integrates an ODE function using either the Dormand-Prince45 method or the Bogacki-Shampine23 method.
Functions
@spec integrate( ode_fn :: Integrator.RungeKutta.ode_fn_t(), t_start_t_end :: Nx.t() | [float() | Nx.t()], x0 :: Nx.t(), opts :: Keyword.t() ) :: Integrator.AdaptiveStepsize.t()
Integrates an ODE function using either the Dormand-Prince45 method or the Bogacki-Shampine23 method.
Options
:initial_step
- The initial stepsize. If not provided, a stepsize will be chosen automatically. Can be a float or a Nx tensor.:integrator
- The integrator to use. Currently only :ode45 and :ode23 are supported, which correspond toIntegrator.RungeKutta.DormandPrince45
andIntegrator.RungeKutta.BogackiShampine23
, respectively. The default value is:ode45
.
Additional Options
Also see the options for these functions which are passed through: