Reference documentation for deal.II version 9.1.1
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Member Functions | List of all members
StandardExceptions::ExcMPI Class Reference

#include <deal.II/base/exceptions.h>

Inheritance diagram for StandardExceptions::ExcMPI:
[legend]

Public Member Functions

virtual void print_info (std::ostream &out) const override
 
- Public Member Functions inherited from ExceptionBase
 ExceptionBase ()
 
 ExceptionBase (const ExceptionBase &exc)
 
virtual ~ExceptionBase () noexcept override
 
ExceptionBase operator= (const ExceptionBase &)=delete
 
void set_fields (const char *file, const int line, const char *function, const char *cond, const char *exc_name)
 
virtual const char * what () const noexcept override
 
const char * get_exc_name () const
 
void print_exc_data (std::ostream &out) const
 
void print_stack_trace (std::ostream &out) const
 

Additional Inherited Members

- Protected Attributes inherited from ExceptionBase
const char * file
 
unsigned int line
 
const char * function
 
const char * cond
 
const char * exc
 
char ** stacktrace
 
int n_stacktrace_frames
 
void * raw_stacktrace [25]
 

Detailed Description

Exception for MPI errors. This exception is only defined if deal.II is compiled with MPI support. This exception should be used with AssertThrow to check error codes of MPI functions. For example:

const int ierr = MPI_Isend(...);
AssertThrow(ierr == MPI_SUCCESS, ExcMPI(ierr));

or, using the convenience macro AssertThrowMPI,

const int ierr = MPI_Irecv(...);

If the assertion fails then the error code will be used to print a helpful message to the screen by utilizing the MPI_Error_string function.

Author
David Wells, 2016

Definition at line 1156 of file exceptions.h.

Member Function Documentation

◆ print_info()

void StandardExceptions::ExcMPI::print_info ( std::ostream &  out) const
overridevirtual

Print more specific information about the exception which occurred. Overload this function in your own exception classes.

Reimplemented from ExceptionBase.

Definition at line 358 of file exceptions.cc.


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