From: Martin Kronbichler Date: Wed, 13 Mar 2024 11:51:19 +0000 (+0100) Subject: Clean up documentation X-Git-Tag: v9.6.0-rc1~482^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F16745%2Fhead;p=dealii.git Clean up documentation --- diff --git a/include/deal.II/lac/solver_gmres.h b/include/deal.II/lac/solver_gmres.h index 55407b287f..4601d0ded7 100644 --- a/include/deal.II/lac/solver_gmres.h +++ b/include/deal.II/lac/solver_gmres.h @@ -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;