Skip to content

Commit

Permalink
More docs, changelog update.
Browse files Browse the repository at this point in the history
  • Loading branch information
bluescarni committed Apr 8, 2021
1 parent c09cbac commit 4137faf
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
7 changes: 7 additions & 0 deletions doc/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ Changelog
0.6.1 (unreleased)
------------------

Changes
~~~~~~~

- The event equations are now taken into account in the
determination of the adaptive timestep
(`#124 <https://github.com/bluescarni/heyoka/pull/124>`__).

Fix
~~~

Expand Down
17 changes: 17 additions & 0 deletions doc/tut_adaptive.rst
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,21 @@ then the timestep will be clamped to ``max_delta_t``:
Note that the integration outcome is now ``taylor_outcome::time_limit``, instead of ``taylor_outcome::success``.

Before moving on, we need to point out an important caveat when using the single
step functions:

.. warning::

If the exact solution of the ODE system can be expressed as a polynomial function
of time, the automatic timestep deduction algorithm may return a timestep of infinity.
This is the case, for instance, when integrating the rectilinear motion of a free
particle or the constant-gravity free-fall equation. In such cases, the step functions
should be called with a finite ``max_delta_t`` argument, in order to clamp the timestep
to a finite value.

Note that the ``propagate_*()`` functions (described :ref:`below <tlimited_prop>`)
are not affected by this issue.

Accessing state and time
------------------------

Expand All @@ -144,6 +159,8 @@ Note that ``get_state()`` returns a const reference to the ``std::vector``
holding the integrator state, while ``get_state_data()`` returns a naked pointer
to the state data. Only ``get_state_data()`` can be used to mutate the state.

.. _tlimited_prop:

Time-limited propagation
------------------------

Expand Down

0 comments on commit 4137faf

Please sign in to comment.