]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fix doxygen formatting of hyphenated lists.
authorDavid Wells <wellsd2@rpi.edu>
Fri, 20 May 2016 20:17:54 +0000 (16:17 -0400)
committerDavid Wells <wellsd2@rpi.edu>
Sat, 21 May 2016 20:21:35 +0000 (16:21 -0400)
examples/step-22/step-22.cc
include/deal.II/base/parameter_handler.h
include/deal.II/distributed/tria.h
include/deal.II/grid/tria.h
include/deal.II/lac/solver.h

index b5adc57a5a806007ec1b3f9cc5754208d512cca2..4f9910360e0a20b6031828489d05dd2095d76904 100644 (file)
@@ -595,16 +595,15 @@ namespace Step22
     const FEValuesExtractors::Vector velocities (0);
     const FEValuesExtractors::Scalar pressure (dim);
 
-    // As an extension over step-20 and step-21, we include a few
-    // optimizations that make assembly much faster for this particular
-    // problem.  The improvements are based on the observation that we do a
-    // few calculations too many times when we do as in step-20: The symmetric
-    // gradient actually has <code>dofs_per_cell</code> different values per
-    // quadrature point, but we extract it
-    // <code>dofs_per_cell*dofs_per_cell</code> times from the FEValues object
-    // - for both the loop over <code>i</code> and the inner loop over
-    // <code>j</code>. In 3d, that means evaluating it $89^2=7921$ instead of
-    // $89$ times, a not insignificant difference.
+    // As an extension over step-20 and step-21, we include a few optimizations
+    // that make assembly much faster for this particular problem. The
+    // improvements are based on the observation that we do a few calculations
+    // too many times when we do as in step-20: The symmetric gradient actually
+    // has <code>dofs_per_cell</code> different values per quadrature point, but
+    // we extract it <code>dofs_per_cell*dofs_per_cell</code> times from the
+    // FEValues object - for both the loop over <code>i</code> and the inner
+    // loop over <code>j</code>. In 3d, that means evaluating it $89^2=7921$
+    // instead of $89$ times, a not insignificant difference.
     //
     // So what we're going to do here is to avoid such repeated calculations
     // by getting a vector of rank-2 tensors (and similarly for the divergence
index c540812e7f6ea0d9542596dc988148795c720d53..32dc6be868eb8983afa782a62804572317fd6e19 100644 (file)
@@ -1417,15 +1417,19 @@ namespace Patterns
  * We can think of the parameters so arranged as a file system in which every
  * parameter is a directory. The name of this directory is the name of the
  * parameter, and in this directory lie files that describe the parameter.
- * These files are: - <code>value</code>: The content of this file is the
- * current value of this parameter; initially, the content of the file equals
- * the default value of the parameter. - <code>default_value</code>: The
- * content of this file is the default value value of the parameter. -
- * <code>pattern</code>: A textual representation of the pattern that
- * describes the parameter's possible values. - <code>pattern_index</code>: A
- * number that indexes the Patterns::PatternBase object that is used to
- * describe the parameter. - <code>documentation</code>: The content of this
- * file is the documentation given for a parameter as the last argument of the
+ * These files are:
+ *
+ * - <code>value</code>: The content of this file is the current value of this
+ * parameter; initially, the content of the file equals the default value of
+ * the parameter.
+ * - <code>default_value</code>: The content of this file is the default value
+ * value of the parameter.
+ * - <code>pattern</code>: A textual representation of the pattern that
+ * describes the parameter's possible values.
+ * - <code>pattern_index</code>: A number that indexes the Patterns::PatternBase
+ * object that is used to describe the parameter.
+ * - <code>documentation</code>: The content of this file is the documentation
+ * given for a parameter as the last argument of the
  * ParameterHandler::declare_entry call. With the exception of the
  * <code>value</code> file, the contents of files are never changed after
  * declaration of a parameter.
index 3a12ebf34f0ab757dc1d785e98309fe67c03a9ce..4f397b6094eabacb750be580c3387ca3cfc64c30 100644 (file)
@@ -699,10 +699,11 @@ namespace parallel
        * is
        *
        * - CELL_PERIST: the cell won't be refined/coarsened, but might be
-       * moved to a different processor - CELL_REFINE: this cell will be
-       * refined into 4/8 cells, you can not access the children (because they
-       * don't exist yet) - CELL_COARSEN: the children of this cell will be
-       * coarsened into the given cell (you can access the active children!)
+       * moved to a different processor
+       * - CELL_REFINE: this cell will be refined into 4/8 cells, you can not
+       * access the children (because they don't exist yet)
+       * - CELL_COARSEN: the children of this cell will be coarsened into the
+       * given cell (you can access the active children!)
        *
        * When unpacking the data with notify_ready_to_unpack() you can access
        * the children of the cell if the status is CELL_REFINE but not for
index 7ecbe2acf942e91f62c881219fa72f0ee2d2ce1e..7b9684280c31620a79b92dcd76d7a7e0e85e9b43 100644 (file)
@@ -135,10 +135,11 @@ struct CellData
   types::manifold_id manifold_id;
 
   /**
-   * Default constructor. Sets the member variables to the following values: -
-   * vertex indices to invalid values - boundary or material id zero (the
-   * default for boundary or material ids) - manifold id to
-   * numbers::invalid_manifold_id
+   * Default constructor. Sets the member variables to the following values:
+   *
+   * - vertex indices to invalid values
+   * - boundary or material id zero (the default for boundary or material ids)
+   * - manifold id to numbers::invalid_manifold_id
    */
   CellData ();
 };
index f0851e8b24cee39aa307a0f84e60efebe69f35c6..9e0b06a539a65e98b2fbf15f1005035d71ec5363 100644 (file)
@@ -405,9 +405,11 @@ private:
   /**
    * A class whose operator() combines two states indicating whether we should
    * continue iterating or stop, and returns a state that dominates. The rules
-   * are: - If one of the two states indicates failure, return failure. -
-   * Otherwise, if one of the two states indicates to continue iterating, then
-   * continue iterating. - Otherwise, return success.
+   * are:
+   * - If one of the two states indicates failure, return failure.
+   * - Otherwise, if one of the two states indicates to continue iterating, then
+   * continue iterating.
+   * - Otherwise, return success.
    */
   struct StateCombiner
   {

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.