]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Documentation
authorGuido Kanschat <dr.guido.kanschat@gmail.com>
Thu, 22 Mar 2001 21:44:17 +0000 (21:44 +0000)
committerGuido Kanschat <dr.guido.kanschat@gmail.com>
Thu, 22 Mar 2001 21:44:17 +0000 (21:44 +0000)
git-svn-id: https://svn.dealii.org/trunk@4269 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/lac/include/lac/schur_matrix.h

index eb4434f4d2cc2ea3fdf4b15274c3497867577ea7..dbd2140161806d5d8e50bf5009c8046c27a759d0 100644 (file)
@@ -64,7 +64,14 @@ template <typename> class BlockVector;
  * Since the Schur complement of a matrix corresponds to a Gaussian
  * block elimination, the right hand side of the condensed system must
  * be preprocessed. Furthermore, the eliminated variable must be
- * reconstructed after solving.The solution of the system above by a
+ * reconstructed after solving.
+ *
+ * \begin{verbatim}
+ *   g = g + B A-inverse f
+ *   u = A-inverse (f - D-transpose p)
+ * \end{verbatim}
+ *
+ * Applying these transformations, the solution of the system above by a
  * @p{SchurMatrix} @p{schur} is coded as follows:
  *
  * \begin{verbatim}
@@ -93,7 +100,17 @@ class SchurMatrix :
                                    * of the block system, this
                                    * function provides the right hand
                                    * side for the Schur complement.
-                                  */
+                                   *
+                                   * The result is stored in the
+                                   * first argument, which is also
+                                   * part of the input data. If it is
+                                   * necessary to conserve the data,
+                                   * @p{dst} must be copied before
+                                   * calling this function. This is
+                                   * reasonable, since in many cases,
+                                   * only the pre-processed right
+                                   * hand side is needed.
+                                   */
   void prepare_rhs (BlockVector<double>& dst,
                    const BlockVector<double>& src) const;
 

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.