Specify options for names in SolverSelector, PreconditionSelector

Fixes #3324

diff --git a/include/deal.II/lac/precondition_selector.h b/include/deal.II/lac/precondition_selector.h
index 164018c81dec1dcd0ce0e6fa50012eb96880711b..18da8d5cc4f6252d5839a1db2a95515c7d26d27f 100644 (file)
--- a/include/deal.II/lac/precondition_selector.h
+++ b/include/deal.II/lac/precondition_selector.h
@@ -143,7 +143,14 @@ public:
   virtual void Tvmult (VectorType &dst, const VectorType &src) const;
 
   /**
-   * Get the names of all implemented preconditionings.
+   * Get the names of all implemented preconditionings. The list of possible
+   * options includes:
+   * <ul>
+   * <li>  "none" </li>
+   * <li>  "jacobi" </li>
+   * <li>  "sor" </li>
+   * <li>  "ssor" </li>
+   * </ul>
    */
   static std::string get_precondition_names();
 

diff --git a/include/deal.II/lac/solver_selector.h b/include/deal.II/lac/solver_selector.h
index 99591e254bb8f10a8472277b1b8e1db395669064..c3d0691c926e827a37cee83a7cf2db95f2d6962d 100644 (file)
--- a/include/deal.II/lac/solver_selector.h
+++ b/include/deal.II/lac/solver_selector.h
@@ -172,7 +172,16 @@ public:
                 ::AdditionalData &data);
 
   /**
-   * Get the names of all implemented solvers.
+   * Get the names of all implemented solvers. The list of possible
+   * options includes:
+   * <ul>
+   * <li>  "richardson" </li>
+   * <li>  "cg" </li>
+   * <li>  "bicgstab" </li>
+   * <li>  "gmres" </li>
+   * <li>  "fgmres" </li>
+   * <li>  "minres" </li>
+   * </ul>
    */
   static std::string get_solver_names ();