From: Jean-Paul Pelteret <jppelteret@gmail.com>
Date: Mon, 31 Oct 2016 06:44:04 +0000 (+0100)
Subject: Specify options for names in SolverSelector, PreconditionSelector
X-Git-Tag: v8.5.0-rc1~516^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F3325%2Fhead;p=dealii.git

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 164018c81d..18da8d5cc4 100644
--- 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 99591e254b..c3d0691c92 100644
--- 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 ();