From b5bf1b6b57a01757e5c7cb42d17f2cebd547a88a Mon Sep 17 00:00:00 2001
From: Norihiro Watanabe <norihiro.watanabe@ufz.de>
Date: Fri, 4 Nov 2016 07:25:28 +0100
Subject: [PATCH] [Num/ODE] add documentation
---
NumLib/ODESolver/ConvergenceCriterionPerComponentResidual.h | 2 ++
1 file changed, 2 insertions(+)
diff --git a/NumLib/ODESolver/ConvergenceCriterionPerComponentResidual.h b/NumLib/ODESolver/ConvergenceCriterionPerComponentResidual.h
index 2c7c36a4343..03139af1ed3 100644
--- a/NumLib/ODESolver/ConvergenceCriterionPerComponentResidual.h
+++ b/NumLib/ODESolver/ConvergenceCriterionPerComponentResidual.h
@@ -36,6 +36,8 @@ public:
bool hasDeltaXCheck() const override { return true; }
bool hasResidualCheck() const override { return true; }
+ /// The function will only do diagnostic output and no actual check of the
+ /// solution increment is made
void checkDeltaX(const GlobalVector& minus_delta_x,
GlobalVector const& x) override;
void checkResidual(const GlobalVector& residual) override;
--
GitLab