From 370b391d0cb4745b6a5d674f3dda2a634f694a14 Mon Sep 17 00:00:00 2001 From: "Daniel R. Reynolds" Date: Mon, 28 Oct 2024 17:03:19 -0500 Subject: [PATCH] Updated documentation to more clearly state when the MRIStepInnerGetAccumulatedError, MRIStepInnerResetAccumulatedError, and MRIStepInnerSetRTol functions are *required* --- .../Usage/MRIStep/Custom_Inner_Stepper/Description.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/arkode/guide/source/Usage/MRIStep/Custom_Inner_Stepper/Description.rst b/doc/arkode/guide/source/Usage/MRIStep/Custom_Inner_Stepper/Description.rst index 4076cb5b0e..21909cc5d8 100644 --- a/doc/arkode/guide/source/Usage/MRIStep/Custom_Inner_Stepper/Description.rst +++ b/doc/arkode/guide/source/Usage/MRIStep/Custom_Inner_Stepper/Description.rst @@ -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 @@ -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 @@ -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`.