Reference documentation for deal.II version Git 06d359936b 2020-09-19 18:16:22 -0400
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Member Functions | Public Attributes | List of all members
SolverControl::NoConvergence Class Reference

#include <deal.II/lac/solver_control.h>

Inheritance diagram for SolverControl::NoConvergence:

Public Member Functions

 NoConvergence (const unsigned int last_step, const double last_residual)
virtual ~NoConvergence () noexcept override=default
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

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
void * raw_stacktrace [25]

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 94 of file solver_control.h.

Constructor & Destructor Documentation

◆ NoConvergence()

SolverControl::NoConvergence::NoConvergence ( const unsigned int  last_step,
const double  last_residual 

Definition at line 97 of file solver_control.h.

◆ ~NoConvergence()

virtual SolverControl::NoConvergence::~NoConvergence ( )

Member Function Documentation

◆ print_info()

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

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

Reimplemented from ExceptionBase.

Definition at line 105 of file solver_control.h.

Member Data Documentation

◆ last_step

const unsigned int SolverControl::NoConvergence::last_step

Iteration number of the last step.

Definition at line 129 of file solver_control.h.

◆ last_residual

const double SolverControl::NoConvergence::last_residual

Residual in the last step.

Definition at line 134 of file solver_control.h.

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