From 668dd5be6abdeefbc94c57144da4aa69c9d81635 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Mon, 16 Sep 2019 14:45:28 -0600 Subject: [PATCH] Update small pieces in TimestepControl. --- include/deal.II/algorithms/timestep_control.h | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) 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 ¶m); + /** * 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 ¶m); @@ -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. */ -- 2.39.5