From 77f7280b4be8e4402b660adb56b1ac68e122bb27 Mon Sep 17 00:00:00 2001 From: kanschat Date: Wed, 11 Jun 2014 16:53:59 +0000 Subject: [PATCH] documentation and formatting git-svn-id: https://svn.dealii.org/trunk@33033 0785d39b-7218-0410-832d-ea1e28bc413d --- .../deal.II/algorithms/timestep_control.h | 46 ++++++------------- deal.II/include/deal.II/meshworker/loop.h | 4 +- 2 files changed, 18 insertions(+), 32 deletions(-) diff --git a/deal.II/include/deal.II/algorithms/timestep_control.h b/deal.II/include/deal.II/algorithms/timestep_control.h index 551caadb27..c3e19792ac 100644 --- a/deal.II/include/deal.II/algorithms/timestep_control.h +++ b/deal.II/include/deal.II/algorithms/timestep_control.h @@ -98,14 +98,11 @@ namespace Algorithms double max_step = 1.); /** - * Declare the control - * parameters for parameter - * handler. + * Declare the control parameters for parameter handler. */ static void declare_parameters (ParameterHandler ¶m); /** - * Read the control parameters - * from a parameter handler. + * Read the control parameters from a parameter handler. */ void parse_parameters (ParameterHandler ¶m); @@ -114,21 +111,16 @@ namespace Algorithms */ double start () const; /** - * The right end of the time - * interval. The control - * mechanism ensures that the - * final time step ends at this - * point. + * The right end of the time interval. The control mechanism + * ensures that the final time step ends at this point. */ double final () const; /** - * The tolerance value - * controlling the time steps. + * The tolerance value controlling the time steps. */ double tolerance () const; /** - * The size of the current time - * step. + * The size of the current time step. */ double step () const; @@ -138,12 +130,9 @@ namespace Algorithms double now () const; /** - * Compute the size of the next - * step size and return true if - * it differs from the current - * step size. Advance the - * current time by the new step - * size. + * Compute the size of the next step and return true if it differs + * from the current step size. Advance the current time by the new + * step size. */ bool advance (); @@ -165,28 +154,23 @@ namespace Algorithms void strategy (Strategy); /** - * Set size of the first - * step. This may be overwritten - * by the time stepping strategy. + * Set size of the first step. This may be overwritten by the time + * stepping strategy. */ void start_step (double); /** - * Set size of the maximum - * step size. + * Set size of the maximum step size. */ void max_step (double); /** - * Set now() equal to - * start(). Initialize step() and - * print() to their initial - * values. + * Set now() equal to start(). Initialize step() and print() to + * their initial values. */ void restart (); /** - * Return true if this timestep - * should be written to disk. + * Return true if this timestep should be written to disk. */ bool print (); /** diff --git a/deal.II/include/deal.II/meshworker/loop.h b/deal.II/include/deal.II/meshworker/loop.h index cebc7916ae..911f0435c9 100644 --- a/deal.II/include/deal.II/meshworker/loop.h +++ b/deal.II/include/deal.II/meshworker/loop.h @@ -448,7 +448,9 @@ namespace MeshWorker { LoopControl lctrl; lctrl.cells_first = cells_first; - lctrl.own_faces = (unique_faces_only)?LoopControl::one:LoopControl::both; + lctrl.own_faces = (unique_faces_only) + ? LoopControl::one + : LoopControl::both; loop(begin, end, dinfo, info, cell_worker, boundary_worker, face_worker, assembler, lctrl); } -- 2.39.5