runtime

amgcl/runtime.hpp

@@ -71,10 +71,10 @@ namespace runtime {
 /// Coarsening kinds.
 namespace coarsening {
 enum type {
-    ruge_stuben,
-    aggregation,
-    smoothed_aggregation,
-    smoothed_aggr_emin
+    ruge_stuben,            ///< Ruge-Stueben coarsening
+    aggregation,            ///< Aggregation
+    smoothed_aggregation,   ///< Smoothed aggregation
+    smoothed_aggr_emin      ///< Smoothed aggregation with energy minimization
 };
 
 inline std::ostream& operator<<(std::ostream &os, type c) {
@@ -116,15 +116,15 @@ inline std::istream& operator>>(std::istream &in, type &c)
 /// Relaxation schemes.
 namespace relaxation {
 enum type {
-    gauss_seidel,
-    multicolor_gauss_seidel,
-    ilu0,
-    parallel_ilu0,
-    ilut,
-    damped_jacobi,
-    spai0,
-    spai1,
-    chebyshev
+    gauss_seidel,               ///< Gauss-Seidel smoothing
+    multicolor_gauss_seidel,    ///< Multicolor Gauss-seidel
+    ilu0,                       ///< Incoplete LU with zero fill-in
+    parallel_ilu0,              ///< Parallel version of ILU(0)
+    ilut,                       ///< Incomplete LU with thresholding
+    damped_jacobi,              ///< Damped Jacobi
+    spai0,                      ///< Sparse approximate inverse of 0th order
+    spai1,                      ///< Sparse approximate inverse of 1st order
+    chebyshev                   ///< Chebyshev relaxation
 };
 
 inline std::ostream& operator<<(std::ostream &os, type r)
@@ -584,10 +584,10 @@ class amg : boost::noncopyable {
 /// Iterative solvers.
 namespace solver {
 enum type {
-    cg,
-    bicgstab,
-    bicgstabl,
-    gmres
+    cg,         ///< Conjugate gradients method
+    bicgstab,   ///< BiConjugate Gradient Stabilized
+    bicgstabl,  ///< BiCGStab(ell)
+    gmres       ///< GMRES
 };
 
 inline std::ostream& operator<<(std::ostream &os, type s)