check_flag_sundials.hpp

Go to the documentation of this file.

#ifndef STAN_MATH_PRIM_ERR_CHECK_FLAG_SUNDIALS_HPP
#define STAN_MATH_PRIM_ERR_CHECK_FLAG_SUNDIALS_HPP
 
#include <stan/math/prim/meta.hpp>
#include <stan/math/prim/err/domain_error.hpp>
#include <kinsol/kinsol.h>
#include <cvodes/cvodes.h>
#include <array>
 
namespace stan {
namespace math {
 
#define CHECK_CVODES_CALL(call) cvodes_check(call, #call)
#define CHECK_IDAS_CALL(call) idas_check(call, #call)
#define CHECK_KINSOL_CALL(call) kinsol_check(call, #call)
 
inline std::array<std::string, 2> cvodes_flag_msg(int flag) {
  std::array<std::string, 2> msg;
  switch (flag) {
    case -1:
      msg = {"CV_TOO_MUCH_WORK",
             "The solver took mxstep internal steps but could not reach tout"};
      break;  // NOLINT
    case -2:
      msg = {"CV_TOO_MUCH_ACC",
             "The solver could not satisfy the accuracy demanded by the user "
             "for some internal step"};
      break;  // NOLINT
    case -3:
      msg = {"CV_ERR_FAILURE",
             "Error test failures occurred too many times during one internal "
             "time step or minimum step size was reached"};
      break;  // NOLINT
    case -4:
      msg = {"CV_CONV_FAILURE",
             "Convergence test failures occurred too many times during one "
             "internal time step or minimum step size was reached"};
      break;  // NOLINT
    case -8:
      msg = {"CV_RHSFUNC_FAIL",
             "The right-hand side function failed in an unrecoverable manner"};
      break;  // NOLINT
    case -9:
      msg = {"CV_FIRST_RHSFUNC_ERR",
             "The right-hand side function failed at the first call"};
      break;  // NOLINT
    case -10:
      msg = {"CV_REPTD_RHSFUNC_ERR",
             "The right-hand side function had repetead recoverable errors"};
      break;  // NOLINT
    case -11:
      msg = {"CV_UNREC_RHSFUNC_ERR",
             "The right-hand side function had a recoverable error, but no "
             "recovery is possible"};
      break;  // NOLINT
    case -27:
      msg = {"CV_TOO_CLOSE",
             "The output and initial times are too close to each other"};
      break;  // NOLINT
    default:
      switch (flag) {
        case -5:
          msg = {"CV_LINIT_FAIL",
                 "The linear solver's initialization function failed"};
          break;  // NOLINT
        case -6:
          msg = {"CV_LSETUP_FAIL",
                 "The linear solver's setup function failed in an "
                 "unrecoverable manner"};
          break;  // NOLINT
        case -7:
          msg = {"CV_LSOLVE_FAIL",
                 "The linear solver's solve function failed in an "
                 "unrecoverable manner"};
          break;  // NOLINT
        case -20:
          msg = {"CV_MEM_FAIL", "A memory allocation failed"};
          break;  // NOLINT
        case -21:
          msg = {"CV_MEM_NULL", "The cvode_mem argument was NULL"};
          break;  // NOLINT
        case -22:
          msg = {"CV_ILL_INPUT", "One of the function inputs is illegal"};
          break;  // NOLINT
        case -23:
          msg = {"CV_NO_MALLOC",
                 "The CVODE memory block was not allocated by a call to "
                 "CVodeMalloc"};
          break;  // NOLINT
        case -24:
          msg = {"CV_BAD_K",
                 "The derivative order k is larger than the order used"};
          break;  // NOLINT
        case -25:
          msg = {"CV_BAD_T", "The time t s outside the last step taken"};
          break;  // NOLINT
        case -26:
          msg = {"CV_BAD_DKY", "The output derivative vector is NULL"};
          break;  // NOLINT
        case -40:
          msg = {"CV_BAD_IS",
                 "The sensitivity index is larger than the number of "
                 "sensitivities computed"};
          break;  // NOLINT
        case -41:
          msg = {"CV_NO_SENS",
                 "Forward sensitivity integration was not activated"};
          break;  // NOLINT
        case -42:
          msg = {"CV_SRHSFUNC_FAIL",
                 "The sensitivity right-hand side function failed in an "
                 "unrecoverable manner"};
          break;  // NOLINT
        case -43:
          msg = {"CV_FIRST_SRHSFUNC_ER",
                 "The sensitivity right-hand side function failed at the first "
                 "call"};
          break;  // NOLINT
        case -44:
          msg = {"CV_REPTD_SRHSFUNC_ER",
                 "The sensitivity ight-hand side function had repetead "
                 "recoverable errors"};
          break;  // NOLINT
        case -45:
          msg = {"CV_UNREC_SRHSFUNC_ER",
                 "The sensitivity right-hand side function had a recoverable "
                 "error, but no recovery is possible"};
          break;  // NOLINT
        case -101:
          msg = {"CV_ADJMEM_NULL", "The cvadj_mem argument was NULL"};
          break;  // NOLINT
        case -103:
          msg = {"CV_BAD_TB0",
                 "The final time for the adjoint problem is outside the "
                 "interval over which the forward problem was solved"};
          break;  // NOLINT
        case -104:
          msg = {"CV_BCKMEM_NULL",
                 "The cvodes memory for the backward problem was not created"};
          break;  // NOLINT
        case -105:
          msg = {"CV_REIFWD_FAIL",
                 "Reinitialization of the forward problem failed at the first "
                 "checkpoint"};
          break;  // NOLINT
        case -106:
          msg = {
              "CV_FWD_FAIL",
              "An error occured during the integration of the forward problem"};
          break;  // NOLINT
        case -107:
          msg = {"CV_BAD_ITASK", "Wrong task for backward integration"};
          break;  // NOLINT
        case -108:
          msg = {"CV_BAD_TBOUT",
                 "The desired output time is outside the interval over which "
                 "the forward problem was solved"};
          break;  // NOLINT
        case -109:
          msg = {"CV_GETY_BADT", "Wrong time in interpolation function"};
          break;  // NOLINT
      }
  }
  return msg;
}
 
inline void cvodes_check(int flag, const char* func_name) {
  if (flag < 0) {
    std::ostringstream ss;
    ss << func_name << " failed with error flag " << flag << ": \n"
       << cvodes_flag_msg(flag).at(1) << ".";
    throw std::domain_error(ss.str());
  }
}
 
inline std::array<std::string, 2> idas_flag_msg(int flag) {
  std::array<std::string, 2> msg;
  switch (flag) {
    case -1:
      msg = {"IDA_TOO_MUCH_WORK",
             "The solver took mxstep internal steps but could not reach tout."};
      break;  // NOLINT
    case -2:
      msg = {"IDA_TOO_MUCH_ACC",
             "The solver could not satisfy the accuracy demanded by the user "
             "for some internal step."};
      break;  // NOLINT
    case -3:
      msg = {"IDA_ERR_FAIL",
             "Error test failures occurred too many times during one internal "
             "time step or minimum step size was reached."};
      break;  // NOLINT
    case -4:
      msg = {"IDA_CONV_FAIL",
             "Convergence test failures occurred too many times during one "
             "internal time step or minimum step size was reached."};
      break;  // NOLINT
    case -5:
      msg = {"IDA_LINIT_FAIL",
             "The linear solver’s initialization function failed."};
      break;  // NOLINT
    case -6:
      msg = {"IDA_LSETUP_FAIL",
             "The linear solver’s setup function failed in an unrecoverable "
             "manner."};
      break;  // NOLINT
    case -7:
      msg = {"IDA_LSOLVE_FAIL",
             "The linear solver’s solve function failed in an unrecoverable "
             "manner."};
      break;  // NOLINT
    case -8:
      msg = {"IDA_RES_FAIL",
             "The user-provided residual function failed in an unrecoverable "
             "manner."};
      break;  // NOLINT
    case -9:
      msg = {"IDA_REP_RES_FAIL",
             "The user-provided residual function repeatedly returned a "
             "recoverable error flag, but the solver was unable to recover."};
      break;  // NOLINT
    case -10:
      msg = {"IDA_RTFUNC_FAIL",
             "The rootfinding function failed in an unrecoverable manner."};
      break;  // NOLINT
    case -11:
      msg = {"IDA_CONSTR_FAIL",
             "The inequality constraints were violated and the solver was "
             "unable to recover."};
      break;  // NOLINT
    case -12:
      msg = {"IDA_FIRST_RES_FAIL",
             "The user-provided residual function failed recoverably on the "
             "first call."};
      break;  // NOLINT
    case -13:
      msg = {"IDA_LINESEARCH_FAIL", "The line search failed."};
      break;  // NOLINT
    default:
      switch (flag) {
        case -14:
          msg = {"IDA_NO_RECOVERY",
                 "The residual function, linear solver setup function, or "
                 "linear solver solve function had a recoverable failure, but "
                 "IDACalcIC could not recover."};
          break;  // NOLINT
        case -15:
          msg = {"IDA_NLS_INIT_FAIL",
                 "The nonlinear solver’s init routine failed."};
          break;  // NOLINT
        case -16:
          msg = {"IDA_NLS_SETUP_FAIL",
                 "The nonlinear solver’s setup routine failed."};
          break;  // NOLINT
        case -20:
          msg = {"IDA_MEM_NULL", "The ida mem argument was NULL."};
          break;  // NOLINT
        case -21:
          msg = {"IDA_MEM_FAIL", "A memory allocation failed."};
          break;  // NOLINT
        case -22:
          msg = {"IDA_ILL_INPUT", "One of the function inputs is illegal."};
          break;  // NOLINT
        case -23:
          msg = {"IDA_NO_MALLOC",
                 "The idas memory was not allocated by a call to IDAInit."};
          break;  // NOLINT
        case -24:
          msg = {"IDA_BAD_EWT", "Zero value of some error weight component."};
          break;  // NOLINT
        case -25:
          msg = {"IDA_BAD_K", "The k-th derivative is not available."};
          break;  // NOLINT
        case -26:
          msg = {"IDA_BAD_T", "The time t is outside the last step taken."};
          break;  // NOLINT
        case -27:
          msg = {
              "IDA_BAD_DKY",
              "The vector argument where derivative should be stored is NULL."};
          break;  // NOLINT
        case -30:
          msg = {"IDA_NO_QUAD", "Quadratures were not initialized."};
          break;  // NOLINT
        case -31:
          msg = {"IDA_QRHS_FAIL",
                 "The user-provided right-hand side function for quadratures "
                 "failed in an unrecoverable manner."};
          break;  // NOLINT
        case -32:
          msg = {"IDA_FIRST_QRHS_ERR",
                 "The user-provided right-hand side function for quadratures "
                 "failed -in an unrecoverable manner on the first call."};
          break;  // NOLINT
        case -33:
          msg = {"IDA_REP_QRHS_ERR",
                 "The user-provided right-hand side repeatedly returned a re- "
                 "coverable error flag, but the solver was unable to recover."};
          break;  // NOLINT
        case -40:
          msg = {"IDA_NO_SENS", "Sensitivities were not initialized."};
          break;  // NOLINT
        case -41:
          msg = {"IDA_SRES_FAIL",
                 "The user-provided sensitivity residual function failed in an "
                 "unrecoverable manner."};
          break;  // NOLINT
        case -42:
          msg = {"IDA_REP_SRES_ERR",
                 "The user-provided sensitivity residual function repeatedly "
                 "re- turned a recoverable error flag, but the solver was "
                 "unable to recover."};
          break;  // NOLINT
        case -43:
          msg = {"IDA_BAD_IS", "The sensitivity identifier is not valid."};
          break;  // NOLINT
        case -50:
          msg = {"IDA_NO_QUADSENS",
                 "Sensitivity-dependent quadratures were not initialized."};
          break;  // NOLINT
        case -51:
          msg = {"IDA_QSRHS_FAIL",
                 "The user-provided sensitivity-dependent quadrature right- "
                 "hand side function failed in an unrecoverable manner."};
          break;  // NOLINT
        case -52:
          msg = {"IDA_FIRST_QSRHS_ERR",
                 "The user-provided sensitivity-dependent quadrature right- "
                 "hand side function failed in an unrecoverable manner on the "
                 "first call."};
          break;  // NOLINT
        case -53:
          msg = {"IDA_REP_QSRHS_ERR",
                 "The user-provided sensitivity-dependent quadrature right- "
                 "hand side repeatedly returned a recoverable error flag, but "
                 "the solver was unable to recover."};
          break;  // NOLINT
      }
  }
  return msg;
}
 
inline void idas_check(int flag, const char* func_name) {
  if (flag < 0) {
    std::ostringstream ss;
    ss << func_name << " failed with error flag " << flag << ": \n"
       << idas_flag_msg(flag).at(1);
    throw std::domain_error(ss.str());
  }
}
 
inline void kinsol_check(int flag, const char* func_name) {
  if (flag < 0) {
    std::ostringstream ss;
    ss << "algebra_solver failed with error flag " << flag << ".";
    throw std::runtime_error(ss.str());
  }
}
 
inline void kinsol_check(int flag, const char* func_name,
                         long int max_num_steps) {  // NOLINT(runtime/int)
  std::ostringstream ss;
  if (flag == -6) {
    domain_error("algebra_solver", "maximum number of iterations",
                 max_num_steps, "(", ") was exceeded in the solve.");
  } else if (flag == -11) {
    ss << "The linear solver’s setup function failed "
       << "in an unrecoverable manner.";
    throw std::runtime_error(ss.str());
  } else if (flag < 0) {
    ss << "algebra_solver failed with error flag " << flag << ".";
    throw std::runtime_error(ss.str());
  }
}
 
}  // namespace math
}  // namespace stan
#endif