]> https://gitweb.dealii.org/ - dealii.git/commitdiff
DiscreteTime is prefered over TimestepControl 10044/head
authorReza Rastak <rastak@stanford.edu>
Wed, 6 May 2020 03:50:09 +0000 (20:50 -0700)
committerReza Rastak <rastak@stanford.edu>
Wed, 6 May 2020 03:50:09 +0000 (20:50 -0700)
include/deal.II/algorithms/timestep_control.h
include/deal.II/base/discrete_time.h

index 974e44f2ca883b0882c5fb9cf6caf885101ed25b..e38a881a5dd2da9c796bb1c89749ced7275e41f0 100644 (file)
@@ -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
   {
index 86d3b475bb40f2071df162c7127e5c2bddae0f4c..b1f7ac291e81c393048efb8fa544e5da0d36276b 100644 (file)
@@ -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.

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.