libmesh_exceptions.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2026 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.

// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef LIBMESH_LIBMESH_EXCEPTIONS_H
#define LIBMESH_LIBMESH_EXCEPTIONS_H

#include "libmesh/libmesh_config.h"

#include "libmesh/libmesh_abort.h"

#include <stdexcept>
#include <string>
#include <sstream>

namespace libMesh {

void libmesh_terminate_handler();

void enableFPE(bool on);

void enableSEGV(bool on);

void enableSIGINT(bool on);

class LogicError : public std::logic_error
{
public:
  LogicError() : std::logic_error( "Error in libMesh internal logic" ) {}
  LogicError(const std::string & msg) : std::logic_error( msg ) {}
};


class NotImplemented : public std::logic_error
{
public:
  NotImplemented(std::string msg="") : std::logic_error( "Error: feature not implemented!\n" + msg ) {}
};


class FileError : public std::runtime_error
{
public:
  FileError(const std::string & filename, const std::string msg="") :
    std::runtime_error("Error with file `" + filename + "'\n" + std::move(msg)) {}
};


class DegenerateMap : public std::runtime_error
{
public:
  DegenerateMap(std::string msg="") :
    std::runtime_error( "Degenerate map, e.g. negative Jacobian or singular matrix.\n" + msg ) {}
};


class ConvergenceFailure : public std::runtime_error
{
public:
  ConvergenceFailure(const std::string & err_msg="Unrecoverable failure to converge") : std::runtime_error( err_msg ) {}
};


class DynamicCastFailure:  public std::runtime_error
{
public:
  DynamicCastFailure() : std::runtime_error( "Failed dynamic cast!" ) {}
};

class FloatingPointException: public std::runtime_error
{
public:
  FloatingPointException() : std::runtime_error( "libmesh FPE!" ) {}
};

class SolverException: public std::exception
{
public:
  SolverException(int error_code_in) :
    std::exception(),
    error_code(error_code_in)
  {
    std::ostringstream oss;
    oss << "Error code " << error_code << " during solve." << std::endl;
    what_message = oss.str();
  }

  virtual ~SolverException() = default;

  virtual const char * what() const noexcept override
  {
    // std::string::c_str() is noexcept in C++11, so it's safe to call
    // in what() because it can't throw.
    return what_message.c_str();
  }

  int error_code;

  std::string what_message;
};

class TerminationException
{
public:
  TerminationException() {}

  const char * what() const noexcept { return "libMesh termination requested"; }
};

}

#ifdef LIBMESH_ENABLE_EXCEPTIONS
#define libmesh_noexcept noexcept

#define LIBMESH_THROW(e) do { throw e; } while (0)
#define libmesh_rethrow throw
#define libmesh_try try
#define libmesh_catch(e) catch(e)

#else

#define LIBMESH_THROW(e) do { libMesh::err << e.what(); libMesh::libmesh_abort(); } while (0)
#define libmesh_rethrow
#define libmesh_try
#define libmesh_catch(e) if (0)

#endif // LIBMESH_ENABLE_EXCEPTIONS

#endif // LIBMESH_LIBMESH_EXCEPTIONS_H