From: Reza Rastak <rastak@stanford.edu>
Date: Wed, 6 May 2020 03:50:09 +0000 (-0700)
Subject: DiscreteTime is prefered over TimestepControl
X-Git-Tag: v9.2.0-rc1~118^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e1c2f6c0dabfe7d9cfe59b78b24111a3028be0f4;p=dealii.git

DiscreteTime is prefered over TimestepControl
---

diff --git a/include/deal.II/algorithms/timestep_control.h b/include/deal.II/algorithms/timestep_control.h
index 974e44f2ca..e38a881a5d 100644
--- a/include/deal.II/algorithms/timestep_control.h
+++ b/include/deal.II/algorithms/timestep_control.h
@@ -53,6 +53,10 @@ namespace Algorithms
    *
    * The variable @p print_step can be used to control the amount of output
    * generated by the timestepping scheme.
+   *
+   * @note Many of the features of this class are available in DiscreteTime
+   * with a more modern interface and better programming guarantees. Consider
+   * using DiscreteTime instead of TimestepControl.
    */
   class TimestepControl : public Subscriptor
   {
diff --git a/include/deal.II/base/discrete_time.h b/include/deal.II/base/discrete_time.h
index 86d3b475bb..b1f7ac291e 100644
--- a/include/deal.II/base/discrete_time.h
+++ b/include/deal.II/base/discrete_time.h
@@ -26,7 +26,9 @@ DEAL_II_NAMESPACE_OPEN
  * $T_{\text{start}}$ to an end time $T_{\text{end}}$. It also allows adjusting
  * the time step size during the simulation. This class provides the necessary
  * interface to be incorporated in any time-dependent simulation. As an
- * example, the usage of this class is demonstrated in step-21.
+ * example, the usage of this class is demonstrated in step-21. This class
+ * attempts to replace the usage of TimestepControl with a better and more
+ * modern interface.
  *
  * This class provides a number of invariants that are guaranteed to be
  * true at all times.