Create a control object for controlling the adaptive stepper for systems of ordinary differential equations (ODEs). The returned object can be passed into a continuous-time dust model on initialisation.
Usage
dust_ode_control(
max_steps = 10000,
atol = 1e-06,
rtol = 1e-06,
step_size_min = 0,
step_size_max = Inf,
critical_times = NULL,
debug_record_step_times = FALSE,
save_history = FALSE
)Arguments
- max_steps
Maximum number of steps to take. If the integration attempts to take more steps that this, it will throw an error, stopping the integration.
- atol
The per-step absolute tolerance.
- rtol
The per-step relative tolerance. The total accuracy will be less than this.
- step_size_min
The minimum step size. The actual minimum used will be the largest of the absolute value of this
step_size_minor.Machine$double.eps(or the single-precision equivalent once we supportfloat-based models). If the integration attempts to make a step smaller than this, it will throw an error, stopping the integration.- step_size_max
The largest step size. By default there is no maximum step size (
Inf) so the solver can take as large a step as it wants to. If you have short-lived fluctuations in your rhs that the solver may skip over by accident, then specify a smaller maximum step size here.- critical_times
Vector of critical times. These are times where we guarantee that the integration will stop, and which you can use for changes to parameters. This can avoid the solver jumping over short-lived departures from a smooth solution, and prevent the solver having to learn where a sharp change in your target function is.
- debug_record_step_times
Logical, indicating if the step times should be recorded. This should only be enabled for debugging. Step times can be retrieved via
dust_system_internals().- save_history
Logical, indicating if we should save history during running. This should only be enabled for debugging. Data can be retrieved via
dust_system_internals(), but the format is undocumented.