Enumerate the rest of the components

ddemidov · Dec 20, 2020 · cb9730b · cb9730b
1 parent 515230f
commit cb9730b
Show file tree

Hide file tree

Showing 7 changed files with 95 additions and 4 deletions.
diff --git a/docs/components.rst b/docs/components.rst
@@ -11,6 +11,6 @@ AMGCL defines the following algorithmic components:
     components/adapters
     components/iter_solvers
     components/preconditioners
-    components/coupled_solvers
     components/relaxation
     components/coarsening
+    components/coupled_solvers
diff --git a/docs/components/adapters.rst b/docs/components/adapters.rst
@@ -6,3 +6,27 @@ formats. Internally, the CRS_ format is used, but it is easy to adapt any
 matrix format that allows row-wise iteration over its non-zero elements.
 
 .. _CRS: http://netlib.org/linalg/html_templates/node91.html
+
+Tuple of CRS arrays
+-------------------
+
+Zero copy
+---------
+
+Block matrix
+------------
+
+Scaled system
+-------------
+
+Reordered system
+----------------
+
+Eigen matrix
+------------
+
+Epetra matrix
+-------------
+
+uBlas matrix
+------------
diff --git a/docs/components/backends.rst b/docs/components/backends.rst
@@ -42,7 +42,7 @@ OpenMP (builtin) backend
 
     This is the bultin backend that does not have any external dependencies and
     uses OpenMP_-parallelization for its primitives. As with any backend in
-    AMGCL, it is defined with a :doc:`value type <valuetypes>` template
+    AMGCL, it is defined with a :doc:`value type <value_types>` template
     parameter, which specifies the type of the system matrix elements. The
     backend is also used internally by AMGCL during construction phase, and so
     moving the constructed datatypes (matrices and vectors) to the backend has

diff --git a/docs/components/coarsening.rst b/docs/components/coarsening.rst
@@ -5,3 +5,15 @@ A coarsening strategy defines various options for creating coarse systems in
 the AMG hierarchy. A coarsening strategy takes the system matrix :math:`A` at
 the current level, and returns prolongation operator :math:`P` and the
 corresponding restriction operator :math:`R`.
+
+Ruge-Stuben
+-----------
+
+Aggregation
+-----------
+
+Smoothed Aggregation
+--------------------
+
+Smoothed Aggregation with Energy Minimization
+---------------------------------------------
diff --git a/docs/components/coupled_solvers.rst b/docs/components/coupled_solvers.rst
@@ -1,2 +1,11 @@
-Coupling Solvers and Preconditioners
-====================================
+Coupling Solvers with Preconditioners
+=====================================
+
+make_solver
+-----------
+
+make_block_solver
+-----------------
+
+deflated_solver
+---------------
diff --git a/docs/components/preconditioners.rst b/docs/components/preconditioners.rst
@@ -7,3 +7,23 @@ preconditioner for Navie-Stokes type problems, or CPR preconditioner for
 reservoir simulations. Also, it is possible to use single level relaxation
 method as a preconditioner.
 
+AMG
+---
+
+Schur Pressure Correction
+-------------------------
+
+Simple
+------
+
+CPR
+---
+
+CPR (DRS)
+---------
+
+Single-level relaxation
+-----------------------
+
+Dummy
+-----
diff --git a/docs/components/relaxation.rst b/docs/components/relaxation.rst
@@ -4,3 +4,29 @@ Relaxation
 A relaxation method or a smoother is used on each level of the AMG hierarchy
 during solution phase.
 
+Chebyshev
+---------
+
+Damped Jacobi
+-------------
+
+Gauss-Seidel
+------------
+
+ILU0
+----
+
+ILUK
+----
+
+ILUP
+----
+
+ILUT
+----
+
+SPAI0
+-----
+
+SPAI1
+-----