remove abort_on_failure (#1174)

it is now the responsibility of the application code to check
the success flag in burn_t.  This is because we were not aborting
when on GPUs, so it is better if the application code makes these
decisions.

Author: zingale

CHANGES.md

@@ -1,3 +1,7 @@
+# 23.05
+
+  * The abort_on_failure runtime parameter has been removed (#1174)
+
 # 23.04
 
   * added preliminary CMake support (#1151, #1164, #1166)

integration/_parameters

@@ -28,9 +28,6 @@ rtol_enuc                real      1.d-6
 atol_spec                real      1.d-8
 atol_enuc                real      1.d-6
 
-# Should we abort the run when the burn fails?
-abort_on_failure         logical   .true.
-
 # Whether to renormalize the mass fractions at each step in the evolution
 # so that they sum to unity.
 renormalize_abundances   logical   .false.

integration/integrator.H

@@ -11,20 +11,6 @@ AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
 void integrator (burn_t& state, Real dt)
 {
     actual_integrator(state, dt);
-
-#ifndef NSE_TABLE
-    // optionally abort here if we don't have retries in the driver.
-    // Note, for NSE we get a second chance if the state entered NSE,
-    // in burner()
-    if (!state.success && abort_on_failure) {
-#ifndef AMREX_USE_GPU
-        std::cout << "failure: \n";
-        std::cout << state << std::endl;
-        amrex::Error("integration failed in burner");
-#endif
-    }
-#endif
-
 }
 
 #endif

interfaces/burner.H

@@ -77,12 +77,6 @@ void burner (burn_t& state, Real dt)
             sdc_nse_burn(state, dt_remaining);
 #else
             nse_burn(state, dt_remaining);
-#endif
-        } else if (state.success == false && abort_on_failure) {
-#ifndef AMREX_USE_GPU
-            std::cout << "failure \n";
-            std::cout << state << std::endl;
-            amrex::Error("integration failed in burner");
 #endif
         }
     }

sphinx_docs/source/integrators.rst

@@ -75,7 +75,7 @@ The input is a ``burn_t``.
 .. note::
 
    For the thermodynamic state, only the density, temperature, and
-   mass fractions -- we explicitly compute the internal energy
+   mass fractions are used directly—we compute the internal energy
    corresponding to this input state through the equation of state
    before integrating.
 
@@ -335,8 +335,8 @@ Stiff ODE Solvers
 =================
 
 We use a high-order implicit ODE solver for integrating the reaction
-system.  As an alternative, a first order explicit integrator is also
-provided.  Internally, the integrators uses different data structures
+system.  A few alternatives, including first order implicit and explicit integrators are also
+provided.  Internally, the integrators use different data structures
 to store the integration progress, and each integrator needs to
 provide a routine to convert from the integrator’s internal
 representation to the ``burn_t`` type required by the ``actual_rhs``
@@ -366,6 +366,11 @@ the allowed options are:
 We recommend that you use the VODE solver, as it is the most
 robust.
 
+.. important::
+
+   The integrator will not abort if it encounters trouble.  Instead it will
+   set ``burn_t burn_state.success = false`` on exit.  It is up to the 
+   application code to handle the failure.
 
 Tolerances
 ----------