]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Clarify the glossary entry.
authorWolfgang Bangerth <bangerth@colostate.edu>
Thu, 4 May 2023 16:00:02 +0000 (10:00 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Thu, 4 May 2023 23:43:06 +0000 (17:43 -0600)
doc/doxygen/headers/glossary.h

index 763b09da3301f6f00da9d8cb89f9699a3a8e354f..388f48bcc5160c4c718edc889d63b68d3c71e8f6 100644 (file)
  *     [line search algorithms](https://en.wikipedia.org/wiki/Line_search)
  *     where using a shorter step length might actually succeed.) In such
  *     cases, a user-provided callback function should throw an exception
- *     of type RecoverableCallBackError, which will then internally be translated
- *     into an appropriate code understandable by the underlying library.
+ *     of type RecoverableUserCallbackError, which will then internally be
+ *     translated into an appropriate code understandable by the underlying
+ *     library. It is worthwhile pointing out that a user callback throwing
+ *     a "recoverable" exception does not actually guarantee that the
+ *     underlying library can actually recover: For example, KINSOL will
+ *     eventually give up if for several shorter and shorter step lengths
+ *     the residual computation throws a "recoverable" exception, and
+ *     the nonlinear solver will then return to user space with an error
+ *     that the deal.II wrappers translate into an exception.
  *
  *   The purpose of these conventions is to provide a unified approach to user
  *   callbacks that is independent of how the underlying library likes to

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.