From 4ecf600473246225f959c11666e08666fd0bb281 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christoph=20Gr=C3=BCninger?= <gruenich@dune-project.org>
Date: Sun, 14 Jan 2024 13:15:43 +0100
Subject: [PATCH] [doxygen] Improve formatting in arpackpp.hh
Add line breaks.
Remove indentation as Doxygen treats it as <pre>.
---
dune/istl/eigenvalue/arpackpp.hh | 30 +++++++++++++++---------------
1 file changed, 15 insertions(+), 15 deletions(-)
diff --git a/dune/istl/eigenvalue/arpackpp.hh b/dune/istl/eigenvalue/arpackpp.hh
index 7ae30bdc9..cc8930adf 100644
--- a/dune/istl/eigenvalue/arpackpp.hh
+++ b/dune/istl/eigenvalue/arpackpp.hh
@@ -204,17 +204,17 @@ namespace Dune
/**
* \brief Wrapper to use a range of ARPACK++ eigenvalue solvers
*
- * A class template for performing some eigenvalue algorithms
- * provided by the ARPACK++ library which is based on the implicitly
- * restarted Arnoldi/Lanczos method (IRAM/IRLM), a synthesis of the
- * Arnoldi/Lanczos process with the implicitily shifted QR technique.
- * The method is designed to compute eigenvalue-eigenvector pairs of
- * large scale sparse nonsymmetric/symmetric matrices. This class
- * template uses the algorithms to compute the dominant (i.e. largest
- * magnitude) and least dominant (i.e. smallest magnitude) eigenvalue
- * as well as the spectral condition number of square, symmetric
- * matrices and to compute the largest and smallest singular value as
- * well as the spectral condition number of nonsymmetric matrices.
+ * A class template for performing some eigenvalue algorithms
+ * provided by the ARPACK++ library which is based on the implicitly
+ * restarted Arnoldi/Lanczos method (IRAM/IRLM), a synthesis of the
+ * Arnoldi/Lanczos process with the implicitily shifted QR technique.
+ * The method is designed to compute eigenvalue-eigenvector pairs of
+ * large scale sparse nonsymmetric/symmetric matrices. This class
+ * template uses the algorithms to compute the dominant (i.e. largest
+ * magnitude) and least dominant (i.e. smallest magnitude) eigenvalue
+ * as well as the spectral condition number of square, symmetric
+ * matrices and to compute the largest and smallest singular value as
+ * well as the spectral condition number of nonsymmetric matrices.
*
* \note For a recent version of the ARPACK++ library working with recent
* compiler versions see "http://reuter.mit.edu/software/arpackpatch/"
@@ -256,13 +256,13 @@ namespace Dune
* update iterations allowed; depending on the
* algorithm, c*nIterationsMax iterations may
* be performed, where c is a natural number.
- * \param[in] verbosity_level Verbosity setting;
- * the final result,
- * the problem solved using ARPACK++,
- * the approximated eigenvector,
+ * \param[in] verbosity_level Verbosity setting;<br>
* \>= 1: algorithms print a preamble and
+ * the final result,<br>
* \>= 2: algorithms print information about
+ * the problem solved using ARPACK++,<br>
* \>= 3: the final result output includes
+ * the approximated eigenvector,<br>
* \>= 4: sets the ARPACK(++) verbosity mode.
*/
ArPackPlusPlus_Algorithms (const BCRSMatrix& m,
--
GitLab