]> https://gitweb.dealii.org/ - dealii.git/commitdiff
update documentation 502/head
authorTimo Heister <timo.heister@gmail.com>
Thu, 5 Feb 2015 14:30:34 +0000 (09:30 -0500)
committerTimo Heister <timo.heister@gmail.com>
Thu, 5 Feb 2015 14:30:34 +0000 (09:30 -0500)
include/deal.II/lac/sparse_mic.h

index aefa5923c7d393bd1f9eba635534d760e4268b99..50093282b73642b3559a5c1c03993a63e18bc75f 100644 (file)
@@ -26,17 +26,18 @@ DEAL_II_NAMESPACE_OPEN
  */
 
 /**
- * Modified incomplete Cholesky (MIC(0)) preconditioner.  This class conforms
- * to the state and usage specification in SparseLUDecomposition.
+ * Implementation of the Modified Incomplete Cholesky (MIC(0)) preconditioner
+ * for symmetric matrices. This class conforms to the state and usage
+ * specification in SparseLUDecomposition.
  *
  *
  * <h3>The decomposition</h3>
  *
- * Let a sparse matrix $A$ be in the form $A = - L - U + D$, where $-L$ and
- * $-U$ are strictly lower and upper triangular matrices. The MIC(0)
- * decomposition of the matrix $A$ is defined by $B = (X-L)X^(-1)(X-U)$, where
- * $X$ is a diagonal matrix, defined by the condition $\text{rowsum}(A) =
- * \text{rowsum}(B)$.
+ * Let a symmetric, positive-definite, sparse matrix $A$ be in the form $A = D
+ * - L - L^T$, where $D$ is the diagonal part of $A$ and $-L$ is a strictly
+ * lower triangular matrix. The MIC(0) decomposition of the matrix $A$ is
+ * defined by $B = (X-L)X^{-1}(X-L^T)$, where $X$ is a diagonal matrix
+ * defined by the condition $\text{rowsum}(A) = \text{rowsum}(B)$.
  *
  * @author Stephen "Cheffo" Kolaroff, 2002, unified interface: Ralf Hartmann
  * 2003.

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.