]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Improve documentation of ArpackSolver::AdditionalData 5553/head
authorBruno Turcksin <bruno.turcksin@gmail.com>
Wed, 29 Nov 2017 19:33:28 +0000 (14:33 -0500)
committerBruno Turcksin <bruno.turcksin@gmail.com>
Wed, 29 Nov 2017 19:33:28 +0000 (14:33 -0500)
include/deal.II/lac/arpack_solver.h

index 2724a518232b891d9a1c9a70bc6a5fd2f426a7ec..f04eb19ca1549598bae2f354df7f556ad73169d8 100644 (file)
@@ -160,18 +160,36 @@ public:
   };
 
   /**
-   * Standardized data struct to pipe additional data to the solver, should it
-   * be needed.
+   * Standardized data struct to pipe additional data to the solver.
    */
   struct AdditionalData
   {
-    const unsigned int number_of_arnoldi_vectors;
-    const WhichEigenvalues eigenvalue_of_interest;
-    const bool symmetric;
-    AdditionalData(
+    /**
+     * Constructor. By default, set the number of Arnoldi vectors (Lanczos
+     * vectors if the problem is symmetric) to 15. Set the solver to find the
+     * eigenvalues of largest magnitude for a non-symmetric problem).
+     */
+    explicit AdditionalData(
       const unsigned int number_of_arnoldi_vectors = 15,
       const WhichEigenvalues eigenvalue_of_interest = largest_magnitude,
       const bool symmetric = false);
+
+    /**
+     * Number of Arnoldi/Lanczos vectors. This number should be less than the
+     * size of the problem but greater than 2 times the number of eigenvalues
+     * (or n_eigenvalues if it is set) plus one.
+     */
+    const unsigned int number_of_arnoldi_vectors;
+
+    /**
+     * Specify the eigenvalues of interest.
+     */
+    const WhichEigenvalues eigenvalue_of_interest;
+
+    /**
+     * Specify if the problem is symmetric or not.
+     */
+    const bool symmetric;
   };
 
   /**

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.