A class representing an exception during a solve. More...

#include <libmesh_exceptions.h>

Inheritance diagram for libMesh::SolverException:

Public Member Functions
	SolverException (int error_code_in)

virtual	~SolverException ()=default
	Virtual destructor, gotta have one of those.

virtual const char *	what () const noexcept override
	Override the what() function to provide a generic error message.

Public Attributes
int	error_code
	The error code generated by the solver.

std::string	what_message
	string which holds the message built in the constructor.

Detailed Description

A class representing an exception during a solve.

Definition at line 160 of file libmesh_exceptions.h.

Constructor & Destructor Documentation

◆ SolverException()

libMesh::SolverException::SolverException ( int error_code_in )

inline

Definition at line 163 of file libmesh_exceptions.h.

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

References error_code, and what_message.

◆ ~SolverException()

virtual libMesh::SolverException::~SolverException ( )

virtualdefault

Virtual destructor, gotta have one of those.

Member Function Documentation

◆ what()

virtual const char * libMesh::SolverException::what ( ) const

inlineoverridevirtualnoexcept

Override the what() function to provide a generic error message.

Definition at line 180 of file libmesh_exceptions.h.

  {
    // 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();
  }