Interface DopriControlParam

Control over the integration, passed into Dopri or DDE

Hierarchy

  • DopriControlParam

Properties

atol: number

Per-step absolute tolerance. Reducing this (or rtol) will decrease the step size taken by the solver and increase the number of steps taken, while inreasing the accuracy of the solution.

maxSteps: number

Maximum number of steps to take before refusing to integrate further. The default of 10000 may need increasing for some large problems or long integrations

rtol: number

Per-step relative tolerance. Reducing this (or atol) will decrease the step size taken by the solver and increase the number of steps taken, while inreasing the accuracy of the solution.

stepSizeMax: number

The maximum allowed step size. If not given we allow arbitrarily large step sizes. For some problems it may be useful to prevent overly large steps as even when the accuracy criteria are satisfied (atol and rtol) too-large steps can result in variables that must be positive going negative and causing problems with the solution.

stepSizeMin: number

The minimum allowed step size. If not given then we allow steps to reduce close to the limit of machine precision. If the integration attempts to make a step smaller than this, it will throw an error by default, stopping the integration. See stepSizeMinAllow to change this behaviour.

stepSizeMinAllow: boolean

Allow the integration to continue even where the step size has reduced to stepSizeMin? If we continue then the accuracy requested by atol and rtol is not likely to be satisfied.

stiffCheck: number

How often to perform the check for the system becoming stiff, in terms of steps

tcrit: number[]

An array of critical times that the solver must stop at. Use this if your system has a singularity that it must not step past (typically at the end of the simulation), or discontinuities in any derivatives.

Generated using TypeDoc