Reference documentation for deal.II version GIT c9976103bc 2022-12-09 17:30:02+00:00
\(\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 | Protected Attributes | Private Member Functions | Private Attributes | List of all members
SolverControl::NoConvergence Class Reference

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

Inheritance diagram for SolverControl::NoConvergence:
[legend]

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
 
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
 

Protected Attributes

const char * file
 
unsigned int line
 
const char * function
 
const char * cond
 
const char * exc
 
int n_stacktrace_frames
 
void * raw_stacktrace [25]
 

Private Member Functions

void generate_message () const
 

Private Attributes

std::string what_str
 

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

Constructor & Destructor Documentation

◆ NoConvergence()

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

Definition at line 98 of file solver_control.h.

◆ ~NoConvergence()

virtual SolverControl::NoConvergence::~NoConvergence ( )
overridevirtualdefaultnoexcept

Member Function Documentation

◆ print_info()

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

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.

◆ 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 136 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 161 of file exceptions.cc.

◆ get_exc_name()

const char * ExceptionBase::get_exc_name ( ) const
inherited

Get exception name.

Definition at line 173 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 181 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 221 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 322 of file exceptions.cc.

Member Data Documentation

◆ last_step

const unsigned int SolverControl::NoConvergence::last_step

Iteration number of the last step.

Definition at line 130 of file solver_control.h.

◆ last_residual

const double SolverControl::NoConvergence::last_residual

Residual in the last step.

Definition at line 135 of file solver_control.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.

◆ n_stacktrace_frames

int ExceptionBase::n_stacktrace_frames
protectedinherited

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

Definition at line 148 of file exceptions.h.

◆ raw_stacktrace

void* ExceptionBase::raw_stacktrace[25]
protectedinherited

Array of pointers that contains the raw stack trace.

Definition at line 154 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 168 of file exceptions.h.


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