From 9b4c471983b1b87d8f7695318a0ea6dbcb773e68 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Sun, 28 Jun 2020 19:03:52 -0600 Subject: [PATCH] Leave references to step-19 in a variety of places. --- include/deal.II/base/discrete_time.h | 9 +++++---- include/deal.II/grid/tria.h | 4 ++-- include/deal.II/numerics/data_postprocessor.h | 4 +++- include/deal.II/particles/particle_handler.h | 2 ++ 4 files changed, 12 insertions(+), 7 deletions(-) diff --git a/include/deal.II/base/discrete_time.h b/include/deal.II/base/discrete_time.h index a656f77138..f56584cfe2 100644 --- a/include/deal.II/base/discrete_time.h +++ b/include/deal.II/base/discrete_time.h @@ -25,10 +25,8 @@ DEAL_II_NAMESPACE_OPEN * time-dependent simulation. It manages stepping forward from a start time * $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. This class - * attempts to replace the usage of TimestepControl with a better and more - * modern interface. + * interface to be incorporated in any time-dependent simulation. + * The usage of this class is demonstrated in step-19 and step-21. * * This class provides a number of invariants that are guaranteed to be * true at all times. @@ -227,6 +225,9 @@ DEAL_II_NAMESPACE_OPEN * // } end snapshot stage * } * @endcode + * The `run()` function in step-19 shows a very similar example where the call + * to advance_time() ends the update stage and is followed by generating + * graphical output with the then-current time. */ class DiscreteTime { diff --git a/include/deal.II/grid/tria.h b/include/deal.II/grid/tria.h index ba6d59837a..8f0f284ccb 100644 --- a/include/deal.II/grid/tria.h +++ b/include/deal.II/grid/tria.h @@ -1795,9 +1795,9 @@ public: * the geometry of the domain, and in this case ignoring the exception is * probably unwise. * - * @note This function is used in step-14 . + * @note This function is used in step-14 and step-19. * - * @note This function triggers the create signal after doing its work. See + * @note This function triggers the "create" signal after doing its work. See * the section on signals in the general documentation of this class. * * @note The check for distorted cells is only done if dim==spacedim, as diff --git a/include/deal.II/numerics/data_postprocessor.h b/include/deal.II/numerics/data_postprocessor.h index d106530061..5ecbcdf466 100644 --- a/include/deal.II/numerics/data_postprocessor.h +++ b/include/deal.II/numerics/data_postprocessor.h @@ -696,7 +696,9 @@ private: *

An example

* * A common example of what one wants to do with postprocessors is to visualize - * not just the value of the solution, but the gradient. Let's, for simplicity, + * not just the value of the solution, but the gradient. This is, in fact, + * precisely what step-19 needs, and it consequently uses the code below almost + * verbatim. Let's, for simplicity, * assume that you have only a scalar solution. In fact, because it's readily * available, let us simply take the step-6 solver to produce such a scalar * solution. The gradient is a vector (with exactly @p dim components), so the diff --git a/include/deal.II/particles/particle_handler.h b/include/deal.II/particles/particle_handler.h index 4038da69bd..892927dea6 100644 --- a/include/deal.II/particles/particle_handler.h +++ b/include/deal.II/particles/particle_handler.h @@ -733,6 +733,8 @@ namespace Particles * * The connected function receives an iterator to the particle in * question, and its last known cell association. + * + * This signal is used in step-19. */ boost::signals2::signal &particle, -- 2.39.5