Add macro for consistent sunrealtype formatting

include/sundials/sundials_linearsolver.h

@@ -226,18 +226,6 @@ SUNErrCode SUNLinSolFree(SUNLinearSolver S);
 #define SUNLS_QRFACT_FAIL      807 /* QRfact found singular matrix  */
 #define SUNLS_LUFACT_FAIL      808 /* LUfact found singular matrix  */
 
-/* -----------------------------------------------------------------------------
- * SUNLinearSolver messages
- * ---------------------------------------------------------------------------*/
-
-#if defined(SUNDIALS_EXTENDED_PRECISION)
-#define SUNLS_MSG_RESIDUAL "\t\tlin. iteration %ld, lin. residual: %Lg\n"
-#elif defined(SUNDIALS_DOUBLE_PRECISION)
-#define SUNLS_MSG_RESIDUAL "\t\tlin. iteration %ld, lin. residual: %g\n"
-#else
-#define SUNLS_MSG_RESIDUAL "\t\tlin. iteration %ld, lin. residual: %g\n"
-#endif
-
 #ifdef __cplusplus
 }
 #endif

include/sundials/sundials_nonlinearsolver.h

@@ -192,18 +192,6 @@ SUNErrCode SUNNonlinSolGetNumConvFails(SUNNonlinearSolver NLS,
 #define SUN_NLS_CONTINUE   +901 /* not converged, keep iterating      */
 #define SUN_NLS_CONV_RECVR +902 /* convergece failure, try to recover */
 
-/* -----------------------------------------------------------------------------
- * SUNNonlinearSolver messages
- * ---------------------------------------------------------------------------*/
-
-#if defined(SUNDIALS_EXTENDED_PRECISION)
-#define SUN_NLS_MSG_RESIDUAL "\tnonlin. iteration %ld, nonlin. residual: %Lg\n"
-#elif defined(SUNDIALS_DOUBLE_PRECISION)
-#define SUN_NLS_MSG_RESIDUAL "\tnonlin. iteration %ld, nonlin. residual: %g\n"
-#else
-#define SUN_NLS_MSG_RESIDUAL "\tnonlin. iteration %ld, nonlin. residual: %g\n"
-#endif
-
 #ifdef __cplusplus
 }
 #endif

include/sundials/sundials_types.h

@@ -84,13 +84,19 @@ extern "C" {
  *------------------------------------------------------------------
  */
 
+#define SUN_STRING_HELPER(x) #x
+#define SUN_STRING(x)        SUN_STRING_HELPER(x)
+
 #if defined(SUNDIALS_SINGLE_PRECISION)
 
 typedef float sunrealtype;
 #define SUN_RCONST(x)     x##F
 #define SUN_BIG_REAL      FLT_MAX
 #define SUN_SMALL_REAL    FLT_MIN
 #define SUN_UNIT_ROUNDOFF FLT_EPSILON
+// TODO(SBR): In C11, FLT_DECIMAL_DIGITS would be a better choice
+#define SUN_FORMAT_E "% ." SUN_STRING(FLT_DIG) "e"
+#define SUN_FORMAT_G "%." SUN_STRING(FLT_DIG) "g"
 
 #elif defined(SUNDIALS_DOUBLE_PRECISION)
 
@@ -99,6 +105,8 @@ typedef double sunrealtype;
 #define SUN_BIG_REAL      DBL_MAX
 #define SUN_SMALL_REAL    DBL_MIN
 #define SUN_UNIT_ROUNDOFF DBL_EPSILON
+#define SUN_FORMAT_E      "% ." SUN_STRING(DBL_DIG) "e"
+#define SUN_FORMAT_G      "%." SUN_STRING(DBL_DIG) "g"
 
 #elif defined(SUNDIALS_EXTENDED_PRECISION)
 
@@ -107,6 +115,8 @@ typedef long double sunrealtype;
 #define SUN_BIG_REAL      LDBL_MAX
 #define SUN_SMALL_REAL    LDBL_MIN
 #define SUN_UNIT_ROUNDOFF LDBL_EPSILON
+#define SUN_FORMAT_E      "% ." SUN_STRING(LDBL_DIG) "Le"
+#define SUN_FORMAT_G      "%." SUN_STRING(LDBL_DIG) "Lg"
 
 #endif
 

src/arkode/arkode.c

@@ -886,8 +886,8 @@ int ARKodeEvolve(void* arkode_mem, sunrealtype tout, N_Vector yout,
       }
 
       SUNLogInfo(ARK_LOGGER, "begin-step-attempt",
-                 "step = %li, tn = %" RSYM ", h = %" RSYM, ark_mem->nst + 1,
-                 ark_mem->tn, ark_mem->h);
+                 "step = %li, tn = " SUN_FORMAT_G ", h = " SUN_FORMAT_G,
+                 ark_mem->nst + 1, ark_mem->tn, ark_mem->h);
 
       /* Call time stepper module to attempt a step:
             0 => step completed successfully
@@ -951,7 +951,8 @@ int ARKodeEvolve(void* arkode_mem, sunrealtype tout, N_Vector yout,
         kflag = arkCheckTemporalError(ark_mem, &nflag, &nef, dsm);
 
         SUNLogInfoIf(kflag != ARK_SUCCESS, ARK_LOGGER, "end-step-attempt",
-                     "status = failed error test, dsm = %" RSYM ", kflag = %i",
+                     "status = failed error test, dsm = " SUN_FORMAT_G
+                     ", kflag = %i",
                      dsm, kflag);
 
         if (kflag < 0) { break; }
@@ -970,7 +971,7 @@ int ARKodeEvolve(void* arkode_mem, sunrealtype tout, N_Vector yout,
       if (kflag == ARK_SUCCESS)
       {
         SUNLogInfo(ARK_LOGGER, "end-step-attempt",
-                   "status = success, dsm = %" RSYM, dsm);
+                   "status = success, dsm = " SUN_FORMAT_G, dsm);
         break;
       }
 
@@ -1296,17 +1297,17 @@ void ARKodePrintMem(void* arkode_mem, FILE* outfile)
   fprintf(outfile, "user_efun = %i\n", ark_mem->user_efun);
   fprintf(outfile, "tstopset = %i\n", ark_mem->tstopset);
   fprintf(outfile, "tstopinterp = %i\n", ark_mem->tstopinterp);
-  fprintf(outfile, "tstop = %" RSYM "\n", ark_mem->tstop);
+  fprintf(outfile, "tstop = " SUN_FORMAT_G "\n", ark_mem->tstop);
   fprintf(outfile, "VabstolMallocDone = %i\n", ark_mem->VabstolMallocDone);
   fprintf(outfile, "MallocDone = %i\n", ark_mem->MallocDone);
   fprintf(outfile, "initsetup = %i\n", ark_mem->initsetup);
   fprintf(outfile, "init_type = %i\n", ark_mem->init_type);
   fprintf(outfile, "firststage = %i\n", ark_mem->firststage);
-  fprintf(outfile, "uround = %" RSYM "\n", ark_mem->uround);
-  fprintf(outfile, "reltol = %" RSYM "\n", ark_mem->reltol);
-  fprintf(outfile, "Sabstol = %" RSYM "\n", ark_mem->Sabstol);
+  fprintf(outfile, "uround = " SUN_FORMAT_G "\n", ark_mem->uround);
+  fprintf(outfile, "reltol = " SUN_FORMAT_G "\n", ark_mem->reltol);
+  fprintf(outfile, "Sabstol = " SUN_FORMAT_G "\n", ark_mem->Sabstol);
   fprintf(outfile, "fixedstep = %i\n", ark_mem->fixedstep);
-  fprintf(outfile, "tolsf = %" RSYM "\n", ark_mem->tolsf);
+  fprintf(outfile, "tolsf = " SUN_FORMAT_G "\n", ark_mem->tolsf);
   fprintf(outfile, "call_fullrhs = %i\n", ark_mem->call_fullrhs);
 
   /* output counters */
@@ -1317,18 +1318,18 @@ void ARKodePrintMem(void* arkode_mem, FILE* outfile)
   fprintf(outfile, "netf = %li\n", ark_mem->netf);
 
   /* output time-stepping values */
-  fprintf(outfile, "hin = %" RSYM "\n", ark_mem->hin);
-  fprintf(outfile, "h = %" RSYM "\n", ark_mem->h);
-  fprintf(outfile, "hprime = %" RSYM "\n", ark_mem->hprime);
-  fprintf(outfile, "next_h = %" RSYM "\n", ark_mem->next_h);
-  fprintf(outfile, "eta = %" RSYM "\n", ark_mem->eta);
-  fprintf(outfile, "tcur = %" RSYM "\n", ark_mem->tcur);
-  fprintf(outfile, "tretlast = %" RSYM "\n", ark_mem->tretlast);
-  fprintf(outfile, "hmin = %" RSYM "\n", ark_mem->hmin);
-  fprintf(outfile, "hmax_inv = %" RSYM "\n", ark_mem->hmax_inv);
-  fprintf(outfile, "h0u = %" RSYM "\n", ark_mem->h0u);
-  fprintf(outfile, "tn = %" RSYM "\n", ark_mem->tn);
-  fprintf(outfile, "hold = %" RSYM "\n", ark_mem->hold);
+  fprintf(outfile, "hin = " SUN_FORMAT_G "\n", ark_mem->hin);
+  fprintf(outfile, "h = " SUN_FORMAT_G "\n", ark_mem->h);
+  fprintf(outfile, "hprime = " SUN_FORMAT_G "\n", ark_mem->hprime);
+  fprintf(outfile, "next_h = " SUN_FORMAT_G "\n", ark_mem->next_h);
+  fprintf(outfile, "eta = " SUN_FORMAT_G "\n", ark_mem->eta);
+  fprintf(outfile, "tcur = " SUN_FORMAT_G "\n", ark_mem->tcur);
+  fprintf(outfile, "tretlast = " SUN_FORMAT_G "\n", ark_mem->tretlast);
+  fprintf(outfile, "hmin = " SUN_FORMAT_G "\n", ark_mem->hmin);
+  fprintf(outfile, "hmax_inv = " SUN_FORMAT_G "\n", ark_mem->hmax_inv);
+  fprintf(outfile, "h0u = " SUN_FORMAT_G "\n", ark_mem->h0u);
+  fprintf(outfile, "tn = " SUN_FORMAT_G "\n", ark_mem->tn);
+  fprintf(outfile, "hold = " SUN_FORMAT_G "\n", ark_mem->hold);
   fprintf(outfile, "maxnef = %i\n", ark_mem->maxnef);
   fprintf(outfile, "maxncf = %i\n", ark_mem->maxncf);
 
@@ -2739,9 +2740,10 @@ int arkHandleFailure(ARKodeMem ark_mem, int flag)
                     MSG_ARK_MASSSOLVE_FAIL);
     break;
   case ARK_NLS_SETUP_FAIL:
-    arkProcessError(ark_mem, ARK_NLS_SETUP_FAIL, __LINE__, __func__,
-                    __FILE__, "At t = %Lg the nonlinear solver setup failed unrecoverably",
-                    (long double)ark_mem->tcur);
+    arkProcessError(ark_mem, ARK_NLS_SETUP_FAIL, __LINE__, __func__, __FILE__,
+                    "At t = " SUN_FORMAT_G
+                    " the nonlinear solver setup failed unrecoverably",
+                    ark_mem->tcur);
     break;
   case ARK_VECTOROP_ERR:
     arkProcessError(ark_mem, ARK_VECTOROP_ERR, __LINE__, __func__, __FILE__,
@@ -2769,17 +2771,18 @@ int arkHandleFailure(ARKodeMem ark_mem, int flag)
     break;
   case ARK_INTERP_FAIL:
     arkProcessError(ark_mem, ARK_INTERP_FAIL, __LINE__, __func__, __FILE__,
-                    "At t = %Lg the interpolation module failed unrecoverably",
-                    (long double)ark_mem->tcur);
+                    "At t = " SUN_FORMAT_G
+                    " the interpolation module failed unrecoverably",
+                    ark_mem->tcur);
     break;
   case ARK_INVALID_TABLE:
     arkProcessError(ark_mem, ARK_INVALID_TABLE, __LINE__, __func__, __FILE__,
                     "ARKODE was provided an invalid method table");
     break;
   case ARK_RELAX_FAIL:
     arkProcessError(ark_mem, ARK_RELAX_FAIL, __LINE__, __func__, __FILE__,
-                    "At t = %Lg the relaxation module failed",
-                    (long double)ark_mem->tcur);
+                    "At t = " SUN_FORMAT_G " the relaxation module failed",
+                    ark_mem->tcur);
     break;
   case ARK_RELAX_MEM_NULL:
     arkProcessError(ark_mem, ARK_RELAX_MEM_NULL, __LINE__, __func__, __FILE__,

src/arkode/arkode_adapt.c

@@ -54,17 +54,25 @@ void arkPrintAdaptMem(ARKodeHAdaptMem hadapt_mem, FILE* outfile)
 {
   if (hadapt_mem != NULL)
   {
-    fprintf(outfile, "ark_hadapt: etamax = %" RSYM "\n", hadapt_mem->etamax);
-    fprintf(outfile, "ark_hadapt: etamx1 = %" RSYM "\n", hadapt_mem->etamx1);
-    fprintf(outfile, "ark_hadapt: etamxf = %" RSYM "\n", hadapt_mem->etamxf);
-    fprintf(outfile, "ark_hadapt: etamin = %" RSYM "\n", hadapt_mem->etamin);
+    fprintf(outfile, "ark_hadapt: etamax = " SUN_FORMAT_G "\n",
+            hadapt_mem->etamax);
+    fprintf(outfile, "ark_hadapt: etamx1 = " SUN_FORMAT_G "\n",
+            hadapt_mem->etamx1);
+    fprintf(outfile, "ark_hadapt: etamxf = " SUN_FORMAT_G "\n",
+            hadapt_mem->etamxf);
+    fprintf(outfile, "ark_hadapt: etamin = " SUN_FORMAT_G "\n",
+            hadapt_mem->etamin);
     fprintf(outfile, "ark_hadapt: small_nef = %i\n", hadapt_mem->small_nef);
-    fprintf(outfile, "ark_hadapt: etacf = %" RSYM "\n", hadapt_mem->etacf);
-    fprintf(outfile, "ark_hadapt: cfl = %" RSYM "\n", hadapt_mem->cfl);
-    fprintf(outfile, "ark_hadapt: safety = %" RSYM "\n", hadapt_mem->safety);
-    fprintf(outfile, "ark_hadapt: growth = %" RSYM "\n", hadapt_mem->growth);
-    fprintf(outfile, "ark_hadapt: lbound = %" RSYM "\n", hadapt_mem->lbound);
-    fprintf(outfile, "ark_hadapt: ubound = %" RSYM "\n", hadapt_mem->ubound);
+    fprintf(outfile, "ark_hadapt: etacf = " SUN_FORMAT_G "\n", hadapt_mem->etacf);
+    fprintf(outfile, "ark_hadapt: cfl = " SUN_FORMAT_G "\n", hadapt_mem->cfl);
+    fprintf(outfile, "ark_hadapt: safety = " SUN_FORMAT_G "\n",
+            hadapt_mem->safety);
+    fprintf(outfile, "ark_hadapt: growth = " SUN_FORMAT_G "\n",
+            hadapt_mem->growth);
+    fprintf(outfile, "ark_hadapt: lbound = " SUN_FORMAT_G "\n",
+            hadapt_mem->lbound);
+    fprintf(outfile, "ark_hadapt: ubound = " SUN_FORMAT_G "\n",
+            hadapt_mem->ubound);
     fprintf(outfile, "ark_hadapt: nst_acc = %li\n", hadapt_mem->nst_acc);
     fprintf(outfile, "ark_hadapt: nst_exp = %li\n", hadapt_mem->nst_exp);
     fprintf(outfile, "ark_hadapt: pq = %i\n", hadapt_mem->pq);
@@ -144,7 +152,7 @@ int arkAdapt(ARKodeMem ark_mem, ARKodeHAdaptMem hadapt_mem, N_Vector ycur,
   if (h_cfl <= ZERO) { h_cfl = SUN_RCONST(1.0e30) * SUNRabs(hcur); }
 
   SUNLogDebug(ARK_LOGGER, "new-step-before-bounds",
-              "h_acc = %" RSYM ", h_cfl = %" RSYM, h_acc, h_cfl);
+              "h_acc = " SUN_FORMAT_G ", h_cfl = " SUN_FORMAT_G, h_acc, h_cfl);
 
   /* enforce safety factors */
   h_acc *= hadapt_mem->safety;
@@ -157,7 +165,7 @@ int arkAdapt(ARKodeMem ark_mem, ARKodeHAdaptMem hadapt_mem, N_Vector ycur,
   h_acc = int_dir * SUNMAX(SUNRabs(h_acc), SUNRabs(hadapt_mem->etamin * hcur));
 
   SUNLogDebug(ARK_LOGGER, "new-step-after-max-min-bounds",
-              "h_acc = %" RSYM ", h_cfl = %" RSYM, h_acc, h_cfl);
+              "h_acc = " SUN_FORMAT_G ", h_cfl = " SUN_FORMAT_G, h_acc, h_cfl);
 
   /* increment the relevant step counter, set desired step */
   if (SUNRabs(h_acc) < SUNRabs(h_cfl)) { hadapt_mem->nst_acc++; }
@@ -183,7 +191,7 @@ int arkAdapt(ARKodeMem ark_mem, ARKodeHAdaptMem hadapt_mem, N_Vector ycur,
   /* enforce maximum time step size */
   ark_mem->eta /= SUNMAX(ONE, SUNRabs(hcur) * ark_mem->hmax_inv * ark_mem->eta);
 
-  SUNLogDebug(ARK_LOGGER, "new-step-eta", "eta = %" RSYM, ark_mem->eta);
+  SUNLogDebug(ARK_LOGGER, "new-step-eta", "eta = " SUN_FORMAT_G, ark_mem->eta);
 
   return (retval);
 }

src/arkode/arkode_arkstep.c

@@ -686,15 +686,15 @@ void arkStep_PrintMem(ARKodeMem ark_mem, FILE* outfile)
     fprintf(outfile, "ARKStep: implicit Butcher table:\n");
     ARKodeButcherTable_Write(step_mem->Bi, outfile);
   }
-  fprintf(outfile, "ARKStep: gamma = %" RSYM "\n", step_mem->gamma);
-  fprintf(outfile, "ARKStep: gammap = %" RSYM "\n", step_mem->gammap);
-  fprintf(outfile, "ARKStep: gamrat = %" RSYM "\n", step_mem->gamrat);
-  fprintf(outfile, "ARKStep: crate = %" RSYM "\n", step_mem->crate);
-  fprintf(outfile, "ARKStep: eRNrm = %" RSYM "\n", step_mem->eRNrm);
-  fprintf(outfile, "ARKStep: nlscoef = %" RSYM "\n", step_mem->nlscoef);
-  fprintf(outfile, "ARKStep: crdown = %" RSYM "\n", step_mem->crdown);
-  fprintf(outfile, "ARKStep: rdiv = %" RSYM "\n", step_mem->rdiv);
-  fprintf(outfile, "ARKStep: dgmax = %" RSYM "\n", step_mem->dgmax);
+  fprintf(outfile, "ARKStep: gamma = " SUN_FORMAT_G "\n", step_mem->gamma);
+  fprintf(outfile, "ARKStep: gammap = " SUN_FORMAT_G "\n", step_mem->gammap);
+  fprintf(outfile, "ARKStep: gamrat = " SUN_FORMAT_G "\n", step_mem->gamrat);
+  fprintf(outfile, "ARKStep: crate = " SUN_FORMAT_G "\n", step_mem->crate);
+  fprintf(outfile, "ARKStep: eRNrm = " SUN_FORMAT_G "\n", step_mem->eRNrm);
+  fprintf(outfile, "ARKStep: nlscoef = " SUN_FORMAT_G "\n", step_mem->nlscoef);
+  fprintf(outfile, "ARKStep: crdown = " SUN_FORMAT_G "\n", step_mem->crdown);
+  fprintf(outfile, "ARKStep: rdiv = " SUN_FORMAT_G "\n", step_mem->rdiv);
+  fprintf(outfile, "ARKStep: dgmax = " SUN_FORMAT_G "\n", step_mem->dgmax);
 
 #ifdef SUNDIALS_DEBUG_PRINTVEC
   /* output vector quantities */
@@ -1765,8 +1765,8 @@ int arkStep_TakeStep_Z(ARKodeMem ark_mem, sunrealtype* dsmPtr, int* nflagPtr)
                          step_mem->mass_type != MASS_TIMEDEP;
 
   SUNLogInfoIf(is_start == 1, ARK_LOGGER, "begin-stage",
-               "stage = %i, implicit = %i, tcur = %" RSYM, 0, implicit_stage,
-               ark_mem->tcur);
+               "stage = %i, implicit = %i, tcur = " SUN_FORMAT_G, 0,
+               implicit_stage, ark_mem->tcur);
   SUNLogExtraDebugVecIf(is_start == 1, ARK_LOGGER, "explicit stage",
                         ark_mem->yn, "z_0(:) =");
 
@@ -1880,8 +1880,8 @@ int arkStep_TakeStep_Z(ARKodeMem ark_mem, sunrealtype* dsmPtr, int* nflagPtr)
     else { ark_mem->tcur = ark_mem->tn + step_mem->Be->c[is] * ark_mem->h; }
 
     SUNLogInfo(ARK_LOGGER, "begin-stage",
-               "stage = %i, implicit = %i, tcur = %" RSYM, is, implicit_stage,
-               ark_mem->tcur);
+               "stage = %i, implicit = %i, tcur = " SUN_FORMAT_G, is,
+               implicit_stage, ark_mem->tcur);
 
     /* setup time-dependent mass matrix */
     if ((step_mem->mass_type == MASS_TIMEDEP) && (step_mem->msetup != NULL))