Skip to content
Snippets Groups Projects
Commit fbbf1614 authored by Dennis Gläser's avatar Dennis Gläser Committed by Timo Koch
Browse files

[pdesolver][doc] Improve documentation of apply

parent 6af174ba
No related branches found
No related tags found
1 merge request!3647[pdesolver] Add apply interface that returns converged result
...@@ -89,6 +89,8 @@ public: ...@@ -89,6 +89,8 @@ public:
* solution, defining primary and possibly secondary variables * solution, defining primary and possibly secondary variables
* and information on the time level. * and information on the time level.
* \return bool true if the solver converged * \return bool true if the solver converged
* \post If converged, the given `Variables` will represent the solution. If the solver
* does not converge, it may be the case that they are in some intermediate (implementation-dependent) state.
*/ */
virtual bool apply(Variables& vars) = 0; virtual bool apply(Variables& vars) = 0;
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment