]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Improve CellWeights documentation 9861/head
authorDaniel Arndt <arndtd@ornl.gov>
Wed, 8 Apr 2020 19:25:27 +0000 (15:25 -0400)
committerDaniel Arndt <arndtd@ornl.gov>
Wed, 8 Apr 2020 19:25:55 +0000 (15:25 -0400)
include/deal.II/distributed/cell_weights.h

index 924d6fc7f1ca0bae4d9d49dde06b5f36ff2ed1c9..50dd53b954e124e388226b911cb6152e092ca498 100644 (file)
@@ -197,19 +197,27 @@ namespace parallel
     CellWeights(const hp::DoFHandler<dim, spacedim> &dof_handler);
 
     /**
-     * @copydoc CellWeights::constant_weighting()
+     * Choose a constant weight @p factor on each cell.
+     *
+     * @deprecated Use CellWeights::constant_weighting() instead.
      */
     DEAL_II_DEPRECATED void
     register_constant_weighting(const unsigned int factor = 1000);
 
     /**
-     * @copydoc CellWeights::ndofs_weighting()
+     * Choose a weight for each cell that is proportional to its number of
+     * degrees of freedom with a factor @p factor.
+     *
+     * @deprecated Use CellWeights::ndofs_weighting() instead.
      */
     DEAL_II_DEPRECATED void
     register_ndofs_weighting(const unsigned int factor = 1000);
 
     /**
-     * @copydoc CellWeights::ndofs_squared_weighting()
+     * Choose a weight for each cell that is proportional to its number of
+     * degrees of freedom <i>squared</i> with a factor @p factor.
+     *
+     * @deprecated Use CellWeights::ndofs_weighting() instead.
      */
     DEAL_II_DEPRECATED void
     register_ndofs_squared_weighting(const unsigned int factor = 1000);

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.