braincell.quad.diffrax_bosh3_step

braincell.quad.diffrax_bosh3_step#

braincell.quad.diffrax_bosh3_step(target, *args)[source]#

Advance one step with diffrax’s Bogacki-Shampine 3(2) solver.

Wraps diffrax.Bosh3, the third-order Bogacki-Shampine explicit Runge-Kutta method (the fixed-step BS23 solver familiar from MATLAB’s ode23). Note that braincell drives diffrax with a fixed step, so the embedded error estimator that the original BS23 uses for adaptive stepping is discarded here.

Parameters:
  • target (DiffEqModule) – Module whose differential states will be advanced.

  • *args – Extra positional arguments forwarded to target’s integration hooks.

Returns:

target’s state is updated in place.

Return type:

None

Raises:

ModuleNotFoundError – If diffrax is not installed.

See also

rk3_step, ssprk3_step