Exceptions.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright (c) 2021.                                                        *
 * The Regents of the University of Michigan and DFT-EFE developers.          *
 *                                                                            *
 * This file is part of the DFT-EFE code.                                     *
 *                                                                            *
 * DFT-EFE is free software: you can redistribute it and/or modify            *
 *   it under the terms of the Lesser GNU General Public License as           *
 *   published by the Free Software Foundation, either version 3 of           *
 *   the License, or (at your option) any later version.                      *
 *                                                                            *
 * DFT-EFE is distributed in the hope that it will be useful, but             *
 *   WITHOUT ANY WARRANTY; without even the implied warranty                  *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                     *
 *   See the Lesser GNU General Public License for more details.              *
 *                                                                            *
 * You should have received a copy of the GNU Lesser General Public           *
 *   License at the top level of DFT-EFE distribution.  If not, see           *
 *   <https://www.gnu.org/licenses/>.                                         *
 ******************************************************************************/
 
/*
 * @author Bikash Kanungo
 */
#ifndef dftefeExceptions_h
#define dftefeExceptions_h
 
#include <string>
#include <stdexcept>
#undef DFTEFE_Assert
#undef DFTEFE_AssertWithMsg
 
#if defined(DFTEFE_DISABLE_ASSERT) || \
  (!defined(DFTEFE_ENABLE_ASSERT) && defined(NDEBUG))
#  include <assert.h> // .h to support old libraries w/o <cassert> - effect is the same
#  define DFTEFE_Assert(expr) ((void)0)
#  define DFTEFE_AssertWithMsg(expr, msg) ((void)0)
 
#elif defined(DFTEFE_ENABLE_ASSERT) && defined(NDEBUG)
#  undef NDEBUG // disabling NDEBUG to forcibly enable assert for sources that
                // set DFTEFE_ENABLE_ASSERT even when in release mode (with
                // NDEBUG)
#  include <assert.h> // .h to support old libraries w/o <cassert> - effect is the same
#  include <iostream>
#  define DFTEFE_Assert(expr) assert(expr)
#  define DFTEFE_AssertWithMsg(expr, msg)    \
    do                                       \
      {                                      \
        if (!(expr))                         \
          {                                  \
            std::cerr << (msg) << std::endl; \
            assert(false);                   \
          }                                  \
      }                                      \
    while (0)
 
#else
#  include <assert.h> // .h to support old libraries w/o <cassert> - effect is the same
#  include <iostream>
#  define DFTEFE_Assert(expr) assert(expr)
#  define DFTEFE_AssertWithMsg(expr, msg)    \
    do                                       \
      {                                      \
        if (!(expr))                         \
          {                                  \
            std::cerr << (msg) << std::endl; \
            assert(false);                   \
          }                                  \
      }                                      \
    while (0)
 
#endif
 
#if defined(DFTEFE_WITH_DEVICE)
#  ifdef DFTEFE_WITH_DEVICE_LANG_CUDA
#    include <utils/DeviceExceptions.cu.h>
#  elif DFTEFE_WITH_DEVICE_LANG_HIP
#    include <utils/DeviceExceptions.hip.h>
#  elif DFTEFE_WITH_DEVICE_LANG_SYCL
#    include <utils/DeviceExceptions.sycl.h>
#  endif
#endif
 
namespace dftefe
{
  namespace utils
  {
    typedef std::logic_error      LogicError;
    typedef std::invalid_argument InvalidArgument;
    typedef std::domain_error     DomainError;
    typedef std::length_error     LengthError;
    typedef std::out_of_range     OutOfRangeError;
    typedef std::runtime_error    RuntimeError;
    typedef std::overflow_error   OverflowError;
    typedef std::underflow_error  UnderflowError;
 
    void
    throwException(bool condition, std::string msg = "");
 
    template <class T>
    void
    throwException(bool condition, std::string msg = "");
 
  } // namespace utils
} // namespace dftefe
#include "Exceptions.t.cpp"
#endif // dftefeExceptions_h