From: Guido Kanschat Date: Thu, 22 Mar 2001 21:44:17 +0000 (+0000) Subject: Documentation X-Git-Tag: v8.0.0~19507 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=840d56bb83f58098def19725345b2368507064fd;p=dealii.git Documentation git-svn-id: https://svn.dealii.org/trunk@4269 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/lac/include/lac/schur_matrix.h b/deal.II/lac/include/lac/schur_matrix.h index eb4434f4d2..dbd2140161 100644 --- a/deal.II/lac/include/lac/schur_matrix.h +++ b/deal.II/lac/include/lac/schur_matrix.h @@ -64,7 +64,14 @@ template 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& dst, const BlockVector& src) const;