A specialization of the SolverException class for PETSc. More...

#include <petsc_solver_exception.h>

Inheritance diagram for libMesh::PetscSolverException:

Public Member Functions
	PetscSolverException (int error_code_in)

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 specialization of the SolverException class for PETSc.

Definition at line 50 of file petsc_solver_exception.h.

Constructor & Destructor Documentation

◆ PetscSolverException()

libMesh::PetscSolverException::PetscSolverException ( int error_code_in )

inline

Definition at line 53 of file petsc_solver_exception.h.

                                          :
    SolverException(error_code_in)
  {
    const char * text;
#if PETSC_VERSION_LESS_THAN(3,25,0)
    char * specific;
#else
    const char * specific;
#endif
    auto ierr = PetscErrorMessage(cast_int<PetscErrorCode>(error_code), &text, &specific);
    // This is one scenario where we ignore the error code
    // returned by a PETSc function :)
    libmesh_ignore(ierr);
 
    // Usually the "specific" error message string is more useful than
    // the generic text corresponding to the error_code, since many
    // SETERRQ calls just use error_code == 1
    if (specific)
      what_message = std::string(specific);
    else if (text)
      what_message = std::string(text);
  }

References libMesh::SolverException::error_code, libMesh::libmesh_ignore(), and libMesh::SolverException::what_message.

Member Function Documentation

◆ what()

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

inlineoverridevirtualnoexceptinherited

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

Definition at line 179 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();
  }