]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Leave references to step-19 in a variety of places.
authorWolfgang Bangerth <bangerth@colostate.edu>
Mon, 29 Jun 2020 01:03:52 +0000 (19:03 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Mon, 29 Jun 2020 01:04:01 +0000 (19:04 -0600)
include/deal.II/base/discrete_time.h
include/deal.II/grid/tria.h
include/deal.II/numerics/data_postprocessor.h
include/deal.II/particles/particle_handler.h

index a656f7713860b5d45b05db415ca5332a6c8cf0ce..f56584cfe26f87005df23015ce146ffe67c8b1af 100644 (file)
@@ -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
 {
index ba6d59837ae35705860f33065b165327a888a421..8f0f284ccb020f7010699408dd65951590acd7ff 100644 (file)
@@ -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
index d1065300617b432730d4b1bd9cc0c72d680d02ba..5ecbcdf466af5312dc09d918a538673ea5a210fd 100644 (file)
@@ -696,7 +696,9 @@ private:
  * <h3> An example </h3>
  *
  * 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
index 4038da69bdcecd9018c0072519ee47c8a4fe94a2..892927dea6abe44da6e77a0613c3bca9ec371fc5 100644 (file)
@@ -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<void(
         const typename Particles::ParticleIterator<dim, spacedim> &particle,

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.