SUNStepper basics based on MRIStepInnerStepper

include/arkode/arkode_arkstep.h

@@ -23,6 +23,7 @@
 #include <arkode/arkode_ls.h>
 #include <sunadaptcontroller/sunadaptcontroller_imexgus.h>
 #include <sunadaptcontroller/sunadaptcontroller_soderlind.h>
+#include <sundials/sundials_stepper.h>
 
 #ifdef __cplusplus /* wrapper to enable C++ usage */
 extern "C" {
@@ -100,6 +101,10 @@ SUNDIALS_EXPORT int ARKStepGetTimestepperStats(
 SUNDIALS_EXPORT int ARKStepCreateMRIStepInnerStepper(void* arkode_mem,
                                                      MRIStepInnerStepper* stepper);
 
+/* SUNStepper interface functions */
+SUNDIALS_EXPORT int ARKStepCreateSUNStepper(void* arkode_mem,
+                                            SUNStepper* stepper);
+
 /* --------------------------------------------------------------------------
  * Deprecated Functions -- all are superseded by shared ARKODE-level routines
  * -------------------------------------------------------------------------- */

include/arkode/arkode_mristep.h

@@ -22,6 +22,7 @@
 #include <arkode/arkode_butcher_dirk.h>
 #include <arkode/arkode_butcher_erk.h>
 #include <arkode/arkode_ls.h>
+#include <sundials/sundials_stepper.h>
 
 #ifdef __cplusplus /* wrapper to enable C++ usage */
 extern "C" {
@@ -169,6 +170,10 @@ SUNDIALS_EXPORT int MRIStepGetLastInnerStepFlag(void* arkode_mem, int* flag);
 /* Custom inner stepper functions */
 SUNDIALS_EXPORT int MRIStepInnerStepper_Create(SUNContext sunctx,
                                                MRIStepInnerStepper* stepper);
+
+SUNDIALS_EXPORT int MRIStepInnerStepper_CreateFromSUNStepper(
+  SUNStepper sunstepper, MRIStepInnerStepper* stepper);
+
 SUNDIALS_EXPORT int MRIStepInnerStepper_Free(MRIStepInnerStepper* stepper);
 SUNDIALS_EXPORT int MRIStepInnerStepper_SetContent(MRIStepInnerStepper stepper,
                                                    void* content);

include/sundials/sundials_stepper.h

@@ -0,0 +1,125 @@
+/* -----------------------------------------------------------------
+ * SUNDIALS Copyright Start
+ * Copyright (c) 2002-2024, Lawrence Livermore National Security
+ * and Southern Methodist University.
+ * All rights reserved.
+ *
+ * See the top-level LICENSE and NOTICE files for details.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ * SUNDIALS Copyright End
+ * -----------------------------------------------------------------*/
+
+#ifndef _SUNDIALS_STEPPER_H
+#define _SUNDIALS_STEPPER_H
+
+#include <sundials/sundials_core.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* TryStep step result flags */
+#define SUNSTEPPER_TRYSTEP_FAILED  -1
+#define SUNSTEPPER_TRYSTEP_SUCCESS +0
+#define SUNSTEPPER_TRYSTEP_ADAPT   +1
+
+typedef int (*SUNJacFn)(sunrealtype t, N_Vector y, N_Vector fy, SUNMatrix Jac,
+                        void* user_data, N_Vector tmp1, N_Vector tmp2,
+                        N_Vector tmp3);
+
+typedef int (*SUNJacTimesFn)(N_Vector v, N_Vector Jv, sunrealtype t, N_Vector y,
+                             N_Vector fy, void* user_data, N_Vector tmp);
+
+typedef _SUNDIALS_STRUCT_ SUNStepper_* SUNStepper;
+
+typedef SUNErrCode (*SUNStepperEvolveFn)(SUNStepper stepper, sunrealtype t0,
+                                         sunrealtype tout, N_Vector y,
+                                         N_Vector yp, sunrealtype* tret,
+                                         int* stop_reason);
+
+typedef SUNErrCode (*SUNStepperOneStepFn)(SUNStepper stepper, sunrealtype t0,
+                                          sunrealtype tout, N_Vector y,
+                                          N_Vector yp, sunrealtype* tret,
+                                          int* stop_reason);
+
+typedef SUNErrCode (*SUNStepperTryStepFn)(SUNStepper stepper, sunrealtype t0,
+                                          sunrealtype tout, N_Vector y,
+                                          N_Vector yp, sunrealtype* tret,
+                                          int* stop_reason);
+
+typedef SUNErrCode (*SUNStepperFullRhsFn)(SUNStepper stepper, sunrealtype t,
+                                          N_Vector y, N_Vector f, int mode);
+
+typedef SUNErrCode (*SUNStepperResetFn)(SUNStepper stepper, sunrealtype tR,
+                                        N_Vector yR, N_Vector ypR);
+
+typedef SUNErrCode (*SUNStepperSetStopTimeFn)(SUNStepper stepper,
+                                              sunrealtype tstop);
+
+SUNDIALS_EXPORT
+SUNErrCode SUNStepper_Create(SUNContext sunctx, SUNStepper* stepper);
+
+SUNDIALS_EXPORT
+SUNErrCode SUNStepper_Destroy(SUNStepper* stepper);
+
+SUNDIALS_EXPORT
+SUNErrCode SUNStepper_SetContent(SUNStepper stepper, void* content);
+
+SUNDIALS_EXPORT
+SUNErrCode SUNStepper_GetContent(SUNStepper stepper, void** content);
+
+SUNDIALS_EXPORT
+SUNErrCode SUNStepper_SetEvolveFn(SUNStepper stepper, SUNStepperEvolveFn fn);
+
+SUNDIALS_EXPORT
+SUNErrCode SUNStepper_SetOneStepFn(SUNStepper stepper, SUNStepperOneStepFn fn);
+
+SUNDIALS_EXPORT
+SUNErrCode SUNStepper_SetTryStepFn(SUNStepper stepper, SUNStepperTryStepFn fn);
+
+SUNDIALS_EXPORT
+SUNErrCode SUNStepper_SetFullRhsFn(SUNStepper stepper, SUNStepperFullRhsFn fn);
+
+SUNDIALS_EXPORT
+SUNErrCode SUNStepper_SetResetFn(SUNStepper stepper, SUNStepperResetFn fn);
+
+SUNDIALS_EXPORT
+SUNErrCode SUNStepper_SetStopTimeFn(SUNStepper stepper,
+                                    SUNStepperSetStopTimeFn fn);
+
+SUNDIALS_EXPORT
+SUNErrCode SUNStepper_AddForcing(SUNStepper stepper, sunrealtype t, N_Vector f);
+
+SUNDIALS_EXPORT
+SUNErrCode SUNStepper_GetForcingData(SUNStepper stepper, sunrealtype* tshift,
+                                     sunrealtype* tscale, N_Vector** forcing,
+                                     int* nforcing);
+
+SUNDIALS_EXPORT
+SUNErrCode SUNStepper_Advance(SUNStepper stepper, sunrealtype t0,
+                              sunrealtype tout, N_Vector y, N_Vector yp,
+                              sunrealtype* tret, int* stop_reason);
+
+SUNDIALS_EXPORT
+SUNErrCode SUNStepper_OneStep(SUNStepper stepper, sunrealtype t0,
+                              sunrealtype tout, N_Vector y, N_Vector yp,
+                              sunrealtype* tret, int* stop_reason);
+
+SUNDIALS_EXPORT
+SUNErrCode SUNStepper_TryStep(SUNStepper stepper, sunrealtype t0,
+                              sunrealtype tout, N_Vector y, N_Vector yp,
+                              sunrealtype* tret, int* stop_reason);
+
+SUNDIALS_EXPORT
+SUNErrCode SUNStepper_Reset(SUNStepper stepper, sunrealtype tR, N_Vector yR,
+                            N_Vector ypR);
+
+SUNDIALS_EXPORT
+SUNErrCode SUNStepper_SetStopTime(SUNStepper stepper, sunrealtype tstop);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _SUNDIALS_STEPPER_H */