From: Wolfgang Bangerth <bangerth@colostate.edu>
Date: Mon, 16 Sep 2019 20:45:28 +0000 (-0600)
Subject: Update small pieces in TimestepControl.
X-Git-Tag: v9.2.0-rc1~1095^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F8763%2Fhead;p=dealii.git

Update small pieces in TimestepControl.
---

diff --git a/include/deal.II/algorithms/timestep_control.h b/include/deal.II/algorithms/timestep_control.h
index 8dfb70f555..1f0ce0340b 100644
--- a/include/deal.II/algorithms/timestep_control.h
+++ b/include/deal.II/algorithms/timestep_control.h
@@ -91,8 +91,13 @@ namespace Algorithms
      */
     static void
     declare_parameters(ParameterHandler &param);
+
     /**
      * Read the control parameters from a parameter handler.
+     *
+     * This function also calls restart() to reset all other internal
+     * parameters of this class to their appropriate values based on
+     * the parameters just read.
      */
     void
     parse_parameters(ParameterHandler &param);
@@ -174,16 +179,19 @@ namespace Algorithms
      */
     void
     restart();
+
     /**
      * Return true if this timestep should be written to disk.
      */
     bool
     print();
+
     /**
      * Set the output name template.
      */
     void
     file_name_format(const char *);
+
     /**
      * Return the output name template.
      */
@@ -195,49 +203,60 @@ namespace Algorithms
      * The beginning of the time interval.
      */
     double start_val;
+
     /**
      *The end of the time interval.
      */
     double final_val;
+
     /**
      * The tolerance value controlling the time steps.
      */
     double tolerance_val;
+
     /**
      * Time-stepping strategy.
      */
     Strategy strategy_val;
+
     /**
      * The size of the first step.
      */
     double start_step_val;
+
     /**
      * The maximum step size.
      */
     double max_step_val;
+
     /**
      * The minimum step size.
      */
     double min_step_val;
+
     /**
      * The size of the current time step. This may differ from @p step_val, if
      * we aim at @p final_val.
      */
     double current_step_val;
+
     /**
      * The size of the current time step determined by the strategy. This may
      * differ from @p current_step_val, if we aim at @p final_val.
      */
     double step_val;
+
     /**
      * The current time.
      */
     double now_val;
+
     /**
      * Determines the approximate time interval between generated outputs.
      * If negative, output will be generated at all time steps.
      */
     double print_step;
+
     /**
      * If current time exceeds this value, it is time to generate the output.
      */