Document how we deal with errors in call-backs. #15146
Conversation
|
Since this seemed to find favor over in #15112, I would appreciate if it could be merged so that I can reference the glossary entry in the documentation of the classes in which I will implement this resolution. |
doc/doxygen/headers/glossary.h
Outdated
| * the problem such as the relative scaling of solution variables within the | ||
| * vector $\mathbf U$ that can be used to make the problem better conditioned. | ||
| * | ||
| * These functions are often called "call-backs" because the ODE or nonlinear |
There was a problem hiding this comment.
I think this spelling is more common.
| * These functions are often called "call-backs" because the ODE or nonlinear | |
| * These functions are often called "callbacks" because the ODE or nonlinear |
doc/doxygen/headers/glossary.h
Outdated
| * | ||
| * These functions are often called "call-backs" because the ODE or nonlinear | ||
| * solver libraries "call back" into user code. In code written in the C programming | ||
| * language, these call backs would often be described by pointers to user |
There was a problem hiding this comment.
| * language, these call backs would often be described by pointers to user | |
| * language, these callbacks would often be described by pointers to user |
|
I've standardized on "callback" as suggested. |
|
Hi @bangerth. Feel free to introduce the new exception but it would be great if we could wait with changing the return values of the interface until after @singima can post his PR. |
|
@tjhei For which interface is that pending patch? I played with the KINSOL interfaces so far, and will work my way through one library after the other. I can certainly push one to the back of the queue. |
This is a proposal to deal with #15112. I'm not actually implementing anything specific, but I think it's useful to first put a design out there and discuss it that we can then refine and ultimately implement.