dftefe::linearAlgebra::LinearSolverErrorMsg Class Reference

A class to map Error to a message. More...

#include <LinearAlgebraTypes.h>

Static Public Member Functions
static LinearSolverError	isSuccessAndMsg (const LinearSolverErrorCode &errorCode)

Static Private Attributes
static const std::map< LinearSolverErrorCode, std::string >	d_errToMsgMap

Detailed Description

A class to map Error to a message.

Note

: This class only has static const data members.

Member Function Documentation

isSuccessAndMsg()

LinearSolverError dftefe::linearAlgebra::LinearSolverErrorMsg::isSuccessAndMsg ( const LinearSolverErrorCode &  errorCode )

static

Member Data Documentation

d_errToMsgMap

const std::map< LinearSolverErrorCode, std::string > dftefe::linearAlgebra::LinearSolverErrorMsg::d_errToMsgMap

staticprivate

Initial value:

= {
        {LinearSolverErrorCode::SUCCESS, "Success. "},
        {LinearSolverErrorCode::FAILED_TO_CONVERGE, "Failed to converge. "},
        {LinearSolverErrorCode::RESIDUAL_DIVERGENCE, "Residual diverged. "},
        {LinearSolverErrorCode::DIVISON_BY_ZERO,
         "Division by zero encountered. "},
        {LinearSolverErrorCode::OTHER_ERROR, "Other error encountered. "}}

---

The documentation for this class was generated from the following files:

• src/linearAlgebra/LinearAlgebraTypes.h
• src/linearAlgebra/LinearAlgebraTypes.cpp