From fbbf1614e9b3dcfa64dc7443d94372d57e532269 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Dennis=20Gl=C3=A4ser?= <dennis.glaeser@iws.uni-stuttgart.de>
Date: Thu, 28 Sep 2023 12:40:43 +0000
Subject: [PATCH] [pdesolver][doc] Improve documentation of apply
---
dumux/common/pdesolver.hh | 2 ++
1 file changed, 2 insertions(+)
diff --git a/dumux/common/pdesolver.hh b/dumux/common/pdesolver.hh
index fec64673e7..83f588d5b0 100644
--- a/dumux/common/pdesolver.hh
+++ b/dumux/common/pdesolver.hh
@@ -89,6 +89,8 @@ public:
* solution, defining primary and possibly secondary variables
* and information on the time level.
* \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;
--
GitLab