Reference documentation for deal.II version 8.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
Public Member Functions | Public Attributes | List of all members
SolverControl::NoConvergence Class Reference

#include <solver_control.h>

Inheritance diagram for SolverControl::NoConvergence:
[legend]

Public Member Functions

 NoConvergence (const unsigned int last_step, const double last_residual)
 
virtual void print_info (std::ostream &out) const
 
- Public Member Functions inherited from ExceptionBase
 ExceptionBase ()
 
 ExceptionBase (const ExceptionBase &exc)
 
virtual ~ExceptionBase () throw ()
 
void set_fields (const char *file, const int line, const char *function, const char *cond, const char *exc_name)
 
virtual const char * what () const throw ()
 
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 unsigned int last_step
 
const double last_residual
 

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
 

Detailed Description

Class to be thrown upon failing convergence of an iterative solver, when either the number of iterations exceeds the limit or the residual fails to reach the desired limit, e.g. in the case of a break-down.

The residual in the last iteration, as well as the iteration number of the last step are stored in this object and can be recovered upon catching an exception of this class.

Definition at line 96 of file solver_control.h.

Member Function Documentation

virtual void SolverControl::NoConvergence::print_info ( std::ostream &  out) const
inlinevirtual

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

Reimplemented from ExceptionBase.

Definition at line 106 of file solver_control.h.

Member Data Documentation

const unsigned int SolverControl::NoConvergence::last_step

Iteration number of the last step.

Definition at line 115 of file solver_control.h.

const double SolverControl::NoConvergence::last_residual

Residual in the last step.

Definition at line 120 of file solver_control.h.


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