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

[newton] Improve doc of apply

parent fbbf1614
No related branches found
No related tags found
1 merge request!3647[pdesolver] Add apply interface that returns converged result
Pipeline #36633 passed
+3
...@@ -369,6 +369,8 @@ public: ...@@ -369,6 +369,8 @@ public:
* The solver is responsible for all the strategic decisions. * The solver is responsible for all the strategic decisions.
* \param vars The variables object representing the current state of the * \param vars The variables object representing the current state of the
* numerical solution (primary and possibly secondary variables). * numerical solution (primary and possibly secondary variables).
* \post If converged, the `Variables` will represent the solution. If convergence
* fails, they are in some intermediate, undefined state.
*/ */
bool apply(Variables& vars) override bool apply(Variables& vars) override
{ {
......
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