From: Wolfgang Bangerth Date: Thu, 21 May 2020 18:30:19 +0000 (-0600) Subject: Random doc improvements. X-Git-Tag: v9.3.0-rc1~1600^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c5462c199afc12966a7f480c99d9c3b9d076b1a6;p=dealii.git Random doc improvements. Scenes from my frequent random walks through the library. --- diff --git a/include/deal.II/lac/affine_constraints.templates.h b/include/deal.II/lac/affine_constraints.templates.h index 397dd08de9..95b8188723 100644 --- a/include/deal.II/lac/affine_constraints.templates.h +++ b/include/deal.II/lac/affine_constraints.templates.h @@ -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()) diff --git a/include/deal.II/lac/sparse_matrix_ez.h b/include/deal.II/lac/sparse_matrix_ez.h index c1607aca17..a51eadcc31 100644 --- a/include/deal.II/lac/sparse_matrix_ez.h +++ b/include/deal.II/lac/sparse_matrix_ez.h @@ -449,10 +449,11 @@ public: * away and only non-zero data is added. The default value is true, * 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 (i,j). Allocates the entry if it - * does not exist. Filters out zeroes automatically. If value is - * not a finite number an exception is thrown. + * Add @p value to the element (i,j). + * + * 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);