]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Random doc improvements. 10294/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Thu, 21 May 2020 18:30:19 +0000 (12:30 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Thu, 21 May 2020 18:30:19 +0000 (12:30 -0600)
Scenes from my frequent random walks through the library.

include/deal.II/lac/affine_constraints.templates.h
include/deal.II/lac/sparse_matrix_ez.h

index 397dd08de97a08f913f8423fb5333e366122ae6d..95b8188723fb422f62f144f804a0a0762a30ebae 100644 (file)
@@ -2869,8 +2869,8 @@ namespace internals
     {
     public:
       /**
-       * Constructor. Grabs a scratch data object on the current thread and
-       * mark it as used
+       * Constructor. Grabs the scratch data object on the current thread and
+       * marks it as used.
        */
       ScratchDataAccessor()
         : my_scratch_data(&AffineConstraintsData::scratch_data.get())
index c1607aca1724bd03cb2f2187325bb7b0985c2cff..a51eadcc313472bfe17b116bcaffb829099bf92b 100644 (file)
@@ -449,10 +449,11 @@ public:
    * away and only non-zero data is added. The default value is <tt>true</tt>,
    * i.e., zero values won't be added into the matrix.
    *
-   * If anyway a new element will be inserted and it does not exist, allocates
-   * the entry.
+   * If this function sets the value of an element that does not yet exist,
+   * then it allocates an entry for it. (Unless `elide_zero_values` is `true`
+   * as mentioned above.)
    *
-   * @note You may need to insert some zero elements to keep a symmetric
+   * @note You may need to insert zero elements if you want to keep a symmetric
    * sparsity pattern for the matrix.
    */
   void
@@ -462,9 +463,14 @@ public:
       const bool      elide_zero_values = true);
 
   /**
-   * Add @p value to the element <tt>(i,j)</tt>. Allocates the entry if it
-   * does not exist. Filters out zeroes automatically. If <tt>value</tt> is
-   * not a finite number an exception is thrown.
+   * Add @p value to the element <tt>(i,j)</tt>.
+   *
+   * If this function adds to the value of an element that does not yet exist,
+   * then it allocates an entry for it.
+   *
+   * The function filters out zeroes automatically, i.e., it does not create
+   * new entries when adding zero to a matrix element for which no entry
+   * currently exists.
    */
   void
   add(const size_type i, const size_type j, const number value);

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.