Deprecated ARKStepWriteButcher

LLNL · Apr 27, 2024 · e0814d3 · e0814d3
1 parent 24e7e8f
commit e0814d3
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/doc/arkode/guide/source/Usage/ARKStep_c_interface/User_callable.rst b/doc/arkode/guide/source/Usage/ARKStep_c_interface/User_callable.rst
@@ -4030,8 +4030,10 @@ General usability functions
       for this pointer, since tables for all processes would be
       identical.
 
+   .. deprecated:: x.y.z
 
-
+      Use :c:func:`ARKStepGetCurrentButcherTables` and :c:func:`ARKodeButcherTable_Write`
+      instead.
 
 
 

diff --git a/include/arkode/arkode_arkstep.h b/include/arkode/arkode_arkstep.h
@@ -331,7 +331,8 @@ char* ARKStepGetReturnFlagName(long int flag);
 SUNDIALS_DEPRECATED_EXPORT_MSG("use ARKodeWriteParameters instead")
 int ARKStepWriteParameters(void* arkode_mem, FILE* fp);
 
-SUNDIALS_EXPORT int ARKStepWriteButcher(void* arkode_mem, FILE* fp);
+SUNDIALS_DEPRECATED_EXPORT_MSG("use ARKStepGetCurrentButcherTables and ARKodeButcherTable_Write instead")
+int ARKStepWriteButcher(void* arkode_mem, FILE* fp);
 
 /* Grouped optional output functions */
 SUNDIALS_EXPORT int ARKStepGetTimestepperStats(