Skip to content

Commit

Permalink
add docs on Jacobian caching (#1561)
Browse files Browse the repository at this point in the history
  • Loading branch information
zingale authored May 24, 2024
1 parent bc1bdda commit 4d8c2e5
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions sphinx_docs/source/ode_integrators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,15 @@ the allowed options are:
* ``VODE``: the VODE :cite:`vode` integration package. We ported this
integrator to C++ and removed the non-stiff integration code paths.

.. note::

The VODE integrator uses Jacobian caching when run on a CPU by default. This
can be disabled at runtime by setting ``integrator.use_jacobian_caching = 0``.

On GPUs, we disable Jacobian caching due to the increased memory
needs. Jacobian caching on GPUs can be enabled by explicitly
setting the build parameter ``USE_JACOBIAN_CACHING=TRUE``.

We recommend that you use the VODE solver, as it is the most
robust.

Expand Down

0 comments on commit 4d8c2e5

Please sign in to comment.