From d6b7c2fc76560b9e5716d343af9ab84e021b6997 Mon Sep 17 00:00:00 2001
From: Wenqing Wang <wenqing.wang@ufz.de>
Date: Fri, 16 Feb 2018 13:35:21 +0100
Subject: [PATCH] [Doc] More detailed description of the new member function of
time steppers
---
.../TimeStepping/Algorithms/EvolutionaryPIDcontroller.h | 3 ++-
NumLib/TimeStepping/Algorithms/TimeStepAlgorithm.h | 8 +++++++-
2 files changed, 9 insertions(+), 2 deletions(-)
diff --git a/NumLib/TimeStepping/Algorithms/EvolutionaryPIDcontroller.h b/NumLib/TimeStepping/Algorithms/EvolutionaryPIDcontroller.h
index 961fb6df51f..9d18dfb6efc 100644
--- a/NumLib/TimeStepping/Algorithms/EvolutionaryPIDcontroller.h
+++ b/NumLib/TimeStepping/Algorithms/EvolutionaryPIDcontroller.h
@@ -91,7 +91,8 @@ public:
/// Get a flag to indicate that this algorithm need to compute
/// solution error.
bool isSolutionErrorComputationNeeded() override { return true; }
- /// Add specific times
+
+ /// \copydoc NumLib::TimeStepAlgorithm::addSpecifiedTimes
void addSpecifiedTimes(
std::vector<double> const& extra_specified_times) override;
diff --git a/NumLib/TimeStepping/Algorithms/TimeStepAlgorithm.h b/NumLib/TimeStepping/Algorithms/TimeStepAlgorithm.h
index 1ecfd586510..3dc899ab986 100644
--- a/NumLib/TimeStepping/Algorithms/TimeStepAlgorithm.h
+++ b/NumLib/TimeStepping/Algorithms/TimeStepAlgorithm.h
@@ -86,7 +86,13 @@ public:
/// solution error. The default return value is false.
virtual bool isSolutionErrorComputationNeeded() { return false; }
- /// Add specific times
+ /**
+ * Add specified times to the existing vector of the specified times.
+ * If there are specified times, they will be used as constraints in the
+ * computing of time step size such that the time step can exactly reach at
+ * the specified times. The function is mainly used to accept the specified
+ * times from the configuration of output.
+ */
virtual void addSpecifiedTimes(std::vector<double> const& /*specified_times*/)
{
}
--
GitLab