StandardExceptions::ExcMPI Class Reference

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

Inheritance diagram for StandardExceptions::ExcMPI:

Public Member Functions
	ExcMPI (const int error_code)
virtual void	print_info (std::ostream &out) const override
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

Public Attributes
const int	error_code

Protected Attributes
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]

Private Member Functions
void	generate_message () const

Private Attributes
std::string	what_str

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(...);
AssertThrowMPI(ierr);

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.

Definition at line 1181 of file exceptions.h.

Constructor & Destructor Documentation

ExcMPI()

StandardExceptions::ExcMPI::ExcMPI

(

const int

error_code

)

Definition at line 372 of file exceptions.cc.

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 377 of file exceptions.cc.

set_fields()

void ExceptionBase::set_fields ( const char *  file, const int  line, const char *  function, const char *  cond, const char *  exc_name  )

inherited

Set the file name and line of where the exception appeared as well as the violated condition and the name of the exception as a char pointer. This function also populates the stacktrace.

Definition at line 128 of file exceptions.cc.

what()

const char * ExceptionBase::what ( ) const

overridevirtualnoexceptinherited

Override the standard function that returns the description of the error.

Definition at line 151 of file exceptions.cc.

get_exc_name()

const char * ExceptionBase::get_exc_name ( ) const

inherited

Get exception name.

Definition at line 174 of file exceptions.cc.

print_exc_data()

void ExceptionBase::print_exc_data ( std::ostream &  out ) const

inherited

Print out the general part of the error information.

Definition at line 182 of file exceptions.cc.

print_stack_trace()

void ExceptionBase::print_stack_trace ( std::ostream &  out ) const

inherited

Print a stacktrace, if one has been recorded previously, to the given stream.

Definition at line 222 of file exceptions.cc.

generate_message()

void ExceptionBase::generate_message ( ) const

privateinherited

Internal function that generates the c_string. Called by what().

Definition at line 311 of file exceptions.cc.

Member Data Documentation

error_code

const int StandardExceptions::ExcMPI::error_code

Definition at line 1189 of file exceptions.h.

file

const char* ExceptionBase::file

protectedinherited

Name of the file this exception happens in.

Definition at line 122 of file exceptions.h.

line

unsigned int ExceptionBase::line

protectedinherited

Line number in this file.

Definition at line 127 of file exceptions.h.

function

const char* ExceptionBase::function

protectedinherited

Name of the function, pretty printed.

Definition at line 132 of file exceptions.h.

cond

const char* ExceptionBase::cond

protectedinherited

The violated condition, as a string.

Definition at line 137 of file exceptions.h.

exc

const char* ExceptionBase::exc

protectedinherited

Name of the exception and call sequence.

Definition at line 142 of file exceptions.h.

stacktrace

char** ExceptionBase::stacktrace

mutableprotectedinherited

A backtrace to the position where the problem happened, if the system supports this.

Definition at line 148 of file exceptions.h.

n_stacktrace_frames

int ExceptionBase::n_stacktrace_frames

protectedinherited

The number of stacktrace frames that are stored in the previous variable. Zero if the system does not support stack traces.

Definition at line 154 of file exceptions.h.

raw_stacktrace

void* ExceptionBase::raw_stacktrace[25]

protectedinherited

array of pointers that contains the raw stack trace

Definition at line 160 of file exceptions.h.

what_str

std::string ExceptionBase::what_str

mutableprivateinherited

A pointer to the c_string that will be printed by what(). It is populated by generate_message()

Definition at line 174 of file exceptions.h.

---

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

• include/deal.II/base/exceptions.h
• source/base/exceptions.cc