ARKstepCreateSUNStepper -> ARKodeCreateSUNStepper

LLNL · Sep 28, 2024 · 319d899 · 319d899
1 parent 12e1c2b
commit 319d899
Show file tree

Hide file tree

Showing 14 changed files with 155 additions and 468 deletions.
diff --git a/external/CMakeLists.txt b/external/CMakeLists.txt
@@ -10,22 +10,23 @@
 # SUNDIALS Copyright End
 # ---------------------------------------------------------------
 
-# Steps to add an external addon to SUNDIALS:
-#   WARNING: external addons are not maintained by the SUNDIALS team
-#   and may come with their own license with different rules.
+# Steps to add an external addon to SUNDIALS: WARNING: external addons are not
+# maintained by the SUNDIALS team and may come with their own license with
+# different rules.
 #
-#   1. Clone/copy the addon into <sundials root>/external/
-#      (the same directory as this file you are reading).
-#   2. Copy the sundials-addon-example block for your own external project.
-#   3. When building SUNDIALS, set the CMake option SUNDIALS_ENABLE_EXTERNAL_ADDONS to ON
-#   4. Build SUNDIALS as usual.
+# 1. Clone/copy the addon into <sundials root>/external/ (the same directory as
+#    this file you are reading).
+# 2. Copy the sundials-addon-example block for your own external project.
+# 3. When building SUNDIALS, set the CMake option SUNDIALS_ENABLE_EXTERNAL_ADDONS
+#    to ON
+# 4. Build SUNDIALS as usual.
 
 include(FetchContent)
 
-# COPY THE FetchContent BLOCK BELOW FOR YOUR OWN EXTERNAL ADDON
-# COMMENT THESE LINES OUT TO DISABLE THE EXAMPLE ADDON
-FetchContent_Declare(sundials-addon-example
-  SOURCE_DIR ${PROJECT_SOURCE_DIR}/external/sundials-addon-example
-)
+# COPY THE FetchContent BLOCK BELOW FOR YOUR OWN EXTERNAL ADDON COMMENT THESE
+# LINES OUT TO DISABLE THE EXAMPLE ADDON
+FetchContent_Declare(
+  sundials-addon-example SOURCE_DIR
+                         ${PROJECT_SOURCE_DIR}/external/sundials-addon-example)
 FetchContent_MakeAvailable(sundials-addon-example)
 # COPY THE BLOCK ABOVE FOR YOUR OWN EXTERNAL ADDON
diff --git a/include/arkode/arkode.h b/include/arkode/arkode.h
@@ -31,6 +31,7 @@
 #include <arkode/arkode_butcher.h>
 #include <stdio.h>
 #include <sundials/sundials_core.h>
+#include <sundials/sundials_stepper.h>
 
 #ifdef __cplusplus /* wrapper to enable C++ usage */
 extern "C" {
@@ -412,6 +413,9 @@ SUNDIALS_EXPORT int ARKodeGetNumRelaxSolveFails(void* arkode_mem,
 SUNDIALS_EXPORT int ARKodeGetNumRelaxSolveIters(void* arkode_mem,
                                                 long int* iters);
 
+/* SUNStepper functions */
+SUNDIALS_EXPORT int ARKodeCreateSUNStepper(void* arkode_mem, SUNStepper* stepper);
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/include/arkode/arkode_arkstep.h b/include/arkode/arkode_arkstep.h
@@ -101,10 +101,6 @@ 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
  * -------------------------------------------------------------------------- */

diff --git a/include/sundials/sundials_stepper.h b/include/sundials/sundials_stepper.h
@@ -20,9 +20,9 @@ extern "C" {
 #endif
 
 /* TryStep step result flags */
-#define SUNSTEPPER_TRYSTEP_FAILED  -1
-#define SUNSTEPPER_TRYSTEP_SUCCESS +0
-#define SUNSTEPPER_TRYSTEP_ADAPT   +1
+// #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,
@@ -35,15 +35,15 @@ typedef _SUNDIALS_STRUCT_ SUNStepper_* SUNStepper;
 
 typedef SUNErrCode (*SUNStepperEvolveFn)(SUNStepper stepper, sunrealtype t0,
                                          sunrealtype tout, N_Vector y,
-                                         sunrealtype* tret, int* stop_reason);
+                                         sunrealtype* tret);
 
 typedef SUNErrCode (*SUNStepperOneStepFn)(SUNStepper stepper, sunrealtype t0,
                                           sunrealtype tout, N_Vector y,
-                                          sunrealtype* tret, int* stop_reason);
+                                          sunrealtype* tret);
 
 typedef SUNErrCode (*SUNStepperTryStepFn)(SUNStepper stepper, sunrealtype t0,
                                           sunrealtype tout, N_Vector y,
-                                          sunrealtype* tret, int* stop_reason);
+                                          sunrealtype* tret);
 
 typedef SUNErrCode (*SUNStepperFullRhsFn)(SUNStepper stepper, sunrealtype t,
                                           N_Vector y, N_Vector f, int mode);
@@ -54,6 +54,11 @@ typedef SUNErrCode (*SUNStepperResetFn)(SUNStepper stepper, sunrealtype tR,
 typedef SUNErrCode (*SUNStepperSetStopTimeFn)(SUNStepper stepper,
                                               sunrealtype tstop);
 
+typedef SUNErrCode (*SUNStepperSetForcingFn)(SUNStepper stepper,
+                                             sunrealtype tshift,
+                                             sunrealtype tscale,
+                                             N_Vector* forcing, int nforcing);
+
 SUNDIALS_EXPORT
 SUNErrCode SUNStepper_Create(SUNContext sunctx, SUNStepper* stepper);
 
@@ -85,37 +90,32 @@ 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_SetForcing(SUNStepper stepper, int count, N_Vector tmpl);
+SUNDIALS_EXPORT SUNErrCode SUNStepper_SetForcingFn(SUNStepper stepper,
+                                                   SUNStepperSetForcingFn fn);
 
 SUNDIALS_EXPORT
-SUNErrCode SUNStepper_Evolve(SUNStepper stepper, sunrealtype t0, sunrealtype tout,
-                             N_Vector y, sunrealtype* tret, int* stop_reason);
+SUNErrCode SUNStepper_Evolve(SUNStepper stepper, sunrealtype t0,
+                             sunrealtype tout, N_Vector y, sunrealtype* tret);
 
 SUNDIALS_EXPORT
 SUNErrCode SUNStepper_OneStep(SUNStepper stepper, sunrealtype t0,
-                              sunrealtype tout, N_Vector y, sunrealtype* tret,
-                              int* stop_reason);
+                              sunrealtype tout, N_Vector y, sunrealtype* tret);
 
 SUNDIALS_EXPORT
 SUNErrCode SUNStepper_TryStep(SUNStepper stepper, sunrealtype t0,
-                              sunrealtype tout, N_Vector y, sunrealtype* tret,
-                              int* stop_reason);
+                              sunrealtype tout, N_Vector y, sunrealtype* tret);
 
 SUNDIALS_EXPORT
 SUNErrCode SUNStepper_Reset(SUNStepper stepper, sunrealtype tR, N_Vector yR);
 
 SUNDIALS_EXPORT
 SUNErrCode SUNStepper_SetStopTime(SUNStepper stepper, sunrealtype tstop);
 
+SUNDIALS_EXPORT
+SUNErrCode SUNStepper_SetForcing(SUNStepper stepper, sunrealtype tshift,
+                                 sunrealtype tscale, N_Vector* forcing,
+                                 int nforcing);
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/src/arkode/CMakeLists.txt b/src/arkode/CMakeLists.txt
@@ -41,6 +41,7 @@ set(arkode_SOURCES
     arkode_sprkstep_io.c
     arkode_sprkstep.c
     arkode_sprk.c
+    arkode_sunstepper.c
     arkode_user_controller.c
     arkode.c)
 

diff --git a/src/arkode/arkode.c b/src/arkode/arkode.c
@@ -1436,11 +1436,13 @@ ARKodeMem arkCreate(SUNContext sunctx)
   ark_mem->step_getnumnonlinsolviters     = NULL;
   ark_mem->step_getnumnonlinsolvconvfails = NULL;
   ark_mem->step_getnonlinsolvstats        = NULL;
+  ark_mem->step_setforcing                = NULL;
   ark_mem->step_mem                       = NULL;
   ark_mem->step_supports_adaptive         = SUNFALSE;
   ark_mem->step_supports_implicit         = SUNFALSE;
   ark_mem->step_supports_massmatrix       = SUNFALSE;
   ark_mem->step_supports_relaxation       = SUNFALSE;
+  ark_mem->step_supports_forcing          = SUNFALSE;
 
   /* Initialize root finding variables */
   ark_mem->root_mem = NULL;