diffeqsolve¤
diffrax.diffeqsolve(terms: PyTree[AbstractTerm], solver: AbstractSolver, t0: Scalar, t1: Scalar, dt0: Optional[Scalar], y0: PyTree, args: Optional[PyTree] = None, *, saveat: SaveAt = SaveAt(t1=True), stepsize_controller: AbstractStepSizeController = ConstantStepSize(), adjoint: AbstractAdjoint = RecursiveCheckpointAdjoint(checkpoints=None), discrete_terminating_event: Optional[AbstractDiscreteTerminatingEvent] = None, max_steps: Optional[int] = 4096, throw: bool = True, solver_state: Optional[PyTree] = None, controller_state: Optional[PyTree] = None, made_jump: Optional[bool] = None) > Solution
¤
Solves a differential equation.
This function is the main entry point for solving all kinds of initial value problems, whether they are ODEs, SDEs, or CDEs.
The differential equation is integrated from t0
to t1
.
See the Getting started page for example usage.
Main arguments:
These are the arguments most commonly used daytoday.
terms
: The terms of the differential equation. This specifies the vector field. (For nonordinary differential equations (SDEs, CDEs), this also specifies the Brownian motion or the control.)solver
: The solver for the differential equation. See the guide on how to choose a solver.t0
: The start of the region of integration.t1
: The end of the region of integration.dt0
: The step size to use for the first step. If using fixed step sizes then this will also be the step size for all other steps. (Except the last one, which may be slightly smaller and clipped tot1
.) If set asNone
then the initial step size will be determined automatically.y0
: The initial value. This can be any PyTree of JAX arrays. (Or types that can be coerced to JAX arrays, like Python floats.)args
: Any additional arguments to pass to the vector field.saveat
: What times to save the solution of the differential equation. Seediffrax.SaveAt
. Defaults to just the last timet1
. (Keywordonly argument.)stepsize_controller
: How to change the step size as the integration progresses. See the list of stepsize controllers. Defaults to using a fixed constant step size. (Keywordonly argument.)
Other arguments:
These arguments are less frequently used, and for most purposes you shouldn't need to understand these. All of these are keywordonly arguments.

adjoint
: How to differentiatediffeqsolve
. Defaults to discretisethenoptimise, which is usually the best option for most problems. See the page on Adjoints for more information. 
discrete_terminating_event
: A discrete event at which to terminate the solve early. See the page on Events for more information. 
max_steps
: The maximum number of steps to take before quitting the computation unconditionally.Can also be set to
None
to allow an arbitrary number of steps, although this is incompatible withsaveat=SaveAt(steps=True)
orsaveat=SaveAt(dense=True)
. 
throw
: Whether to raise an exception if the integration fails for any reason.If
True
then an integration failure will raise an error. Note that the errors are only reliably raised on CPUs. If on GPUs then the error may only be printed to stderr, whilst on TPUs then the behaviour is undefined.If
False
then the returned solution object will have aresult
field indicating whether any failures occurred.Possible failures include for example hitting
max_steps
, or the problem becoming too stiff to integrate. (For most purposes these failures are unusual.)Note
When
jax.vmap
ing a differential equation solve, thenthrow=True
means that an exception will be raised if any batch element fails. You may prefer to setthrow=False
and inspect theresult
field of the returned solution object, to determine which batch elements succeeded and which failed. 
solver_state
: Some initial state for the solver. Generally obtained bySaveAt(solver_state=True)
from a previous solve. 
controller_state
: Some initial state for the step size controller. Generally obtained bySaveAt(controller_state=True)
from a previous solve. 
made_jump
: Whether a jump has just been made att0
. Used to updatesolver_state
(if passed). Generally obtained bySaveAt(made_jump=True)
from a previous solve.
Returns:
Returns a diffrax.Solution
object specifying the solution to the differential
equation.
Raises:
ValueError
for bad inputs.RuntimeError
ifthrow=True
and the integration fails (e.g. hitting the maximum number of steps).
Note
It is possible to have t1 < t0
, in which case integration proceeds backwards
in time.