From: Wolfgang Bangerth <bangerth@colostate.edu>
Date: Wed, 21 Oct 2020 22:29:55 +0000 (-0600)
Subject: Better document where to find information about the SLEPc wrappers.
X-Git-Tag: v9.3.0-rc1~974^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=29e9c93cb61f1f67dc51583703da1f7c0a1d3208;p=dealii.git

Better document where to find information about the SLEPc wrappers.
---

diff --git a/include/deal.II/lac/slepc_solver.h b/include/deal.II/lac/slepc_solver.h
index a367d60ada..3e86081497 100644
--- a/include/deal.II/lac/slepc_solver.h
+++ b/include/deal.II/lac/slepc_solver.h
@@ -136,6 +136,12 @@ namespace SLEPcWrappers
    * basically all the actual solver calls happen in this class, and derived
    * classes simply set the right flags to select one solver or another, or to
    * set certain parameters for individual solvers.
+   *
+   * For examples of how this and its derived classes can be used, including
+   * how to provide preconditioners to the matrix of which eigenvalues are
+   * to be computed, see the documentation of the SolverBase class as well
+   * as the extensive discussions in the documentation of the SLEPcWrappers
+   * namespace.
    */
   class SolverBase
   {
@@ -369,10 +375,18 @@ namespace SLEPcWrappers
                      void *      solver_control);
   };
 
+
+
   /**
    * An implementation of the solver interface using the SLEPc Krylov-Schur
    * solver. Usage: All spectrum, all problem types, complex.
    *
+   * For examples of how this and its sibling classes can be used, including
+   * how to provide preconditioners to the matrix of which eigenvalues are
+   * to be computed, see the documentation of the SolverBase class as well
+   * as the extensive discussions in the documentation of the SLEPcWrappers
+   * namespace.
+   *
    * @ingroup SLEPcWrappers
    */
   class SolverKrylovSchur : public SolverBase
@@ -401,10 +415,18 @@ namespace SLEPcWrappers
     const AdditionalData additional_data;
   };
 
+
+
   /**
    * An implementation of the solver interface using the SLEPc Arnoldi solver.
    * Usage: All spectrum, all problem types, complex.
    *
+   * For examples of how this and its sibling classes can be used, including
+   * how to provide preconditioners to the matrix of which eigenvalues are
+   * to be computed, see the documentation of the SolverBase class as well
+   * as the extensive discussions in the documentation of the SLEPcWrappers
+   * namespace.
+   *
    * @ingroup SLEPcWrappers
    */
   class SolverArnoldi : public SolverBase
@@ -444,10 +466,18 @@ namespace SLEPcWrappers
     const AdditionalData additional_data;
   };
 
+
+
   /**
    * An implementation of the solver interface using the SLEPc Lanczos solver.
    * Usage: All spectrum, all problem types, complex.
    *
+   * For examples of how this and its sibling classes can be used, including
+   * how to provide preconditioners to the matrix of which eigenvalues are
+   * to be computed, see the documentation of the SolverBase class as well
+   * as the extensive discussions in the documentation of the SLEPcWrappers
+   * namespace.
+   *
    * @ingroup SLEPcWrappers
    */
   class SolverLanczos : public SolverBase
@@ -488,10 +518,18 @@ namespace SLEPcWrappers
     const AdditionalData additional_data;
   };
 
+
+
   /**
    * An implementation of the solver interface using the SLEPc Power solver.
    * Usage: Largest values of spectrum only, all problem types, complex.
    *
+   * For examples of how this and its sibling classes can be used, including
+   * how to provide preconditioners to the matrix of which eigenvalues are
+   * to be computed, see the documentation of the SolverBase class as well
+   * as the extensive discussions in the documentation of the SLEPcWrappers
+   * namespace.
+   *
    * @ingroup SLEPcWrappers
    */
   class SolverPower : public SolverBase
@@ -520,10 +558,18 @@ namespace SLEPcWrappers
     const AdditionalData additional_data;
   };
 
+
+
   /**
    * An implementation of the solver interface using the SLEPc Davidson
    * solver. Usage: All problem types.
    *
+   * For examples of how this and its sibling classes can be used, including
+   * how to provide preconditioners to the matrix of which eigenvalues are
+   * to be computed, see the documentation of the SolverBase class as well
+   * as the extensive discussions in the documentation of the SLEPcWrappers
+   * namespace.
+   *
    * @ingroup SLEPcWrappers
    */
   class SolverGeneralizedDavidson : public SolverBase
@@ -563,10 +609,18 @@ namespace SLEPcWrappers
     const AdditionalData additional_data;
   };
 
+
+
   /**
    * An implementation of the solver interface using the SLEPc Jacobi-Davidson
    * solver. Usage: All problem types.
    *
+   * For examples of how this and its sibling classes can be used, including
+   * how to provide preconditioners to the matrix of which eigenvalues are
+   * to be computed, see the documentation of the SolverBase class as well
+   * as the extensive discussions in the documentation of the SLEPcWrappers
+   * namespace.
+   *
    * @ingroup SLEPcWrappers
    */
   class SolverJacobiDavidson : public SolverBase
@@ -596,10 +650,17 @@ namespace SLEPcWrappers
   };
 
 
+
   /**
    * An implementation of the solver interface using the SLEPc LAPACK direct
    * solver.
    *
+   * For examples of how this and its sibling classes can be used, including
+   * how to provide preconditioners to the matrix of which eigenvalues are
+   * to be computed, see the documentation of the SolverBase class as well
+   * as the extensive discussions in the documentation of the SLEPcWrappers
+   * namespace.
+   *
    * @ingroup SLEPcWrappers
    */
   class SolverLAPACK : public SolverBase
@@ -628,6 +689,8 @@ namespace SLEPcWrappers
     const AdditionalData additional_data;
   };
 
+
+
   // --------------------------- inline and template functions -----------
   /**
    * This is declared here to make it possible to take a std::vector of