]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Improve documentation of MF::AD::cell_vectorization_category 14007/head
authorPeter Munch <peterrmuench@gmail.com>
Fri, 17 Jun 2022 17:20:37 +0000 (19:20 +0200)
committerPeter Munch <peterrmuench@gmail.com>
Fri, 17 Jun 2022 17:20:37 +0000 (19:20 +0200)
include/deal.II/matrix_free/matrix_free.h

index 68fb429be846a485bc6721e2b925d8cd4865a295..0b7d63bc540d1d2fddf7cd30538d29015c5800fa 100644 (file)
@@ -498,13 +498,18 @@ public:
     /**
      * This data structure allows to assign a fraction of cells to different
      * categories when building the information for vectorization. It is used
-     * implicitly when working with hp-adaptivity but can also be useful in
-     * other contexts, such as in local time stepping where one would like to
-     * control which elements together form a batch of cells.
+     * implicitly when working with hp-adaptivity (with each active index
+     * being a category) but can also be useful in other contexts where one
+     * would like to control which cells together can form a batch of cells.
+     * Such an example is "local time stepping", where cells of different
+     * caterogries progress with different time-step sizes and, as a
+     * consequence, can only processed together with cells with the same
+     * cateogry.
      *
      * This array is accessed by the number given by cell->active_cell_index()
-     * when working on the active cells with @p mg_level set to numbers::invalid_unsigned_int and
-     * by cell->index() for the level cells.
+     * when working on the active cells (with
+     * @p mg_level set to numbers::invalid_unsigned_int) and by cell->index()
+     * for the level cells.
      *
      * @note This field is empty upon construction of AdditionalData. It is
      * the responsibility of the user to resize this field to

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.