Skip to content

Commit

Permalink
Updated documentation to more clearly state when the MRIStepInnerGetA…
Browse files Browse the repository at this point in the history 
…ccumulatedError, MRIStepInnerResetAccumulatedError, and MRIStepInnerSetRTol functions are *required*
  • Loading branch information
@drreynolds
drreynolds committed Oct 28, 2024
1 parent f806cdd commit 370b391
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/arkode/guide/source/Usage/MRIStep/Custom_Inner_Stepper/Description.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -462,7 +462,7 @@ following member functions:

.. note::

This function is only called when multirate temporal adaptivity has been enabled,
This function is required when multirate temporal adaptivity has been enabled,
using a :c:type:`SUNAdaptController` module having type :c:enumerator:`SUN_ADAPTCONTROLLER_MRI_H_TOL`.

If provided, the :c:type:`MRIStepInnerGetAccumulatedError` function will always
Expand All @@ -486,7 +486,7 @@ following member functions:

.. note::

This function is only called when multirate temporal adaptivity has been enabled,
This function is required when multirate temporal adaptivity has been enabled,
using a :c:type:`SUNAdaptController` module having type :c:enumerator:`SUN_ADAPTCONTROLLER_MRI_H_TOL`.

The :c:type:`MRIStepInnerResetAccumulatedError` function will always be called
Expand Down Expand Up @@ -514,5 +514,5 @@ following member functions:

.. note::

This function is only called when multirate temporal adaptivity has been enabled
This function is required when multirate temporal adaptivity has been enabled
using a :c:type:`SUNAdaptController` module having type :c:enumerator:`SUN_ADAPTCONTROLLER_MRI_H_TOL`.

0 comments on commit 370b391

Please sign in to comment.