]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Clean up documentation 16745/head
authorMartin Kronbichler <martin.kronbichler@rub.de>
Wed, 13 Mar 2024 11:51:19 +0000 (12:51 +0100)
committerMartin Kronbichler <martin.kronbichler@rub.de>
Thu, 14 Mar 2024 09:38:13 +0000 (10:38 +0100)
include/deal.II/lac/solver_gmres.h

index 55407b287f43560a630b4431135fe3ddad25d6bf..4601d0ded7c8d4de848e3c221145540b8aa39b6a 100644 (file)
@@ -219,15 +219,15 @@ public:
           LinearAlgebra::OrthogonalizationStrategy::modified_gram_schmidt);
 
     /**
-     * Maximum number of temporary vectors. Together with #max_basis_size,
-     * this parameter controls the size of the Arnoldi basis, which for
-     * historical reasons is #max_n_tmp_vectors-2. SolverGMRES assumes that
-     * there are at least three temporary vectors, so this value must be
-     * greater than or equal to three. If both this variable and
-     * #max_basis_size are set to a non-zero value, the choice in
-     * #max_basis_size takes precedence.
+     * Maximum number of temporary vectors. Together with max_basis_size, this
+     * parameter controls the size of the Arnoldi basis, which corresponds to
+     * max_n_tmp_vectors-2 as used in previous versions of the deal.II
+     * library. SolverGMRES assumes that there are at least three temporary
+     * vectors, so this value must be greater than or equal to three. If both
+     * this variable and max_basis_size are set to a non-zero value, the
+     * choice in max_basis_size takes precedence.
      *
-     * @deprecated Use #max_basis_size instead.
+     * @deprecated Use max_basis_size instead.
      */
     unsigned int max_n_tmp_vectors;
 
@@ -236,7 +236,7 @@ public:
      * least one vector in the Arnoldi basis, so this value must be greater
      * than or equal to one. Note that whenever this variable is set to a
      * non-zero value, including the value set by the default constructor,
-     * this variable takes precedence over #max_n_tmp_vectors.
+     * this variable takes precedence over max_n_tmp_vectors.
      */
     unsigned int max_basis_size;
 

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.