Reference documentation for deal.II version Git 0491297983 2019-09-23 09:31:59 +0200
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Enumerations | Functions | Variables
deal_II_exceptions::internals Namespace Reference

Enumerations

enum  ExceptionHandling { abort_or_throw_on_exception, throw_on_exception }
 

Functions

void abort (const ExceptionBase &exc) noexcept
 
template<class ExceptionType >
void issue_error_noreturn (ExceptionHandling handling, const char *file, int line, const char *function, const char *cond, const char *exc_name, ExceptionType e)
 
void do_issue_error_nothrow (const ExceptionBase &e) noexcept
 
template<class ExceptionType >
void issue_error_nothrow (const char *file, int line, const char *function, const char *cond, const char *exc_name, ExceptionType e) noexcept
 
std::string get_cusparse_error_string (const cusparseStatus_t error_code)
 
std::string get_cusolver_error_string (const cusolverStatus_t error_code)
 

Variables

bool allow_abort_on_exception = true
 

Detailed Description

The functions in this namespace are in connection with the Assert and AssertThrow mechanism but are solely for internal purposes and are not for use outside the exception handling and throwing mechanism.

Enumeration Type Documentation

◆ ExceptionHandling

An enum describing how to treat an exception in issue_error_noreturn.

Enumerator
abort_or_throw_on_exception 

Abort the program by calling std::abort unless deal_II_exceptions::disable_abort_on_exception has been called: in that case the program will throw an exception.

throw_on_exception 

Throw the exception normally.

Definition at line 1260 of file exceptions.h.

Function Documentation

◆ abort()

void deal_II_exceptions::internals::abort ( const ExceptionBase exc)
noexcept

Abort the program by printing the error message provided by exc and calling std::abort().

Definition at line 408 of file exceptions.cc.

◆ issue_error_noreturn()

template<class ExceptionType >
void deal_II_exceptions::internals::issue_error_noreturn ( ExceptionHandling  handling,
const char *  file,
int  line,
const char *  function,
const char *  cond,
const char *  exc_name,
ExceptionType  e 
)

This routine does the main work for the exception generation mechanism used in the Assert and AssertThrow macros: as the name implies, this function either ends by throwing an exception (if handling is throw_on_exception, or handling is try_abort_exception and deal_II_exceptions::disable_abort_on_exception is false) or with a call to abort (if handling is try_abort_exception and deal_II_exceptions::disable_abort_on_exception is true).

The actual exception object (the last argument) is typically an unnamed object created in place; because we modify it, we can't take it by const reference, and temporaries don't bind to non-const references. So take it by value (=copy it) with a templated type to avoid slicing – the performance implications are pretty minimal anyway.

ExceptionBase

Definition at line 1293 of file exceptions.h.

◆ do_issue_error_nothrow()

void deal_II_exceptions::internals::do_issue_error_nothrow ( const ExceptionBase e)
noexcept

Internal function that does the work of issue_error_nothrow.

Definition at line 454 of file exceptions.cc.

◆ issue_error_nothrow()

template<class ExceptionType >
void deal_II_exceptions::internals::issue_error_nothrow ( const char *  file,
int  line,
const char *  function,
const char *  cond,
const char *  exc_name,
ExceptionType  e 
)
noexcept

Exception generation mechanism in case we must not throw.

ExceptionBase

Note
This function is defined with a template for the same reasons as issue_error_noreturn().

Definition at line 1341 of file exceptions.h.

◆ get_cusparse_error_string()

std::string deal_II_exceptions::internals::get_cusparse_error_string ( const cusparseStatus_t  error_code)

Return a string given an error code. This is similar to the cudaGetErrorString function but there is no equivalent function for cuSPARSE.

Definition at line 471 of file exceptions.cc.

◆ get_cusolver_error_string()

std::string deal_II_exceptions::internals::get_cusolver_error_string ( const cusolverStatus_t  error_code)

Return a string given an error code. This is similar to the cudaGetErrorString function but there is no equivalent function for cuSOLVER.

Definition at line 517 of file exceptions.cc.

Variable Documentation

◆ allow_abort_on_exception

bool deal_II_exceptions::internals::allow_abort_on_exception = true

Setting this variable to false will disable deal.II's exception mechanism to abort the problem. The Assert() macro will throw the exception instead and the AssertNothrow() macro will just print the error message. This variable should not be changed directly. Use disable_abort_on_exception() instead.

Definition at line 55 of file exceptions.cc.