From: Timo Heister Date: Mon, 19 Nov 2018 14:42:51 +0000 (-0500) Subject: FGMRES: deprecate AdditionalData constructor, cleanup doc X-Git-Tag: v9.1.0-rc1~552^2~1 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7497ece553d76b06bd5f0ebd170dfe9a6770bfcb;p=dealii.git FGMRES: deprecate AdditionalData constructor, cleanup doc --- diff --git a/include/deal.II/lac/solver_gmres.h b/include/deal.II/lac/solver_gmres.h index e45306b99b..7c846bb58e 100644 --- a/include/deal.II/lac/solver_gmres.h +++ b/include/deal.II/lac/solver_gmres.h @@ -456,9 +456,6 @@ private: * 2*SolverFGMRES::AdditionalData::max_basis_size+1 auxiliary * vectors. * - * Caveat: Documentation of this class is not up to date. There are also a few - * parameters of GMRES we would like to introduce here. - * * @author Guido Kanschat, 2003 */ template > @@ -473,13 +470,24 @@ public: /** * Constructor. By default, set the maximum basis size to 30. */ - explicit AdditionalData(const unsigned int max_basis_size = 30, - const bool /*use_default_residual*/ = true) + explicit AdditionalData(const unsigned int max_basis_size = 30) : max_basis_size(max_basis_size) {} /** - * Maximum number of tmp vectors. + * @deprecated: use the other constructor as the second argument is + unused. + */ + DEAL_II_DEPRECATED + AdditionalData(const unsigned int max_basis_size, + const bool use_default_residual) + : max_basis_size(max_basis_size) + { + (void)use_default_residual; + } + + /** + * Maximum basis size. */ unsigned int max_basis_size; };