From: Martin Kronbichler <kronbichler@lnm.mw.tum.de>
Date: Fri, 12 Jun 2015 16:21:28 +0000 (+0200)
Subject: Improve documentation
X-Git-Tag: v8.3.0-rc1~118^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F1003%2Fhead;p=dealii.git

Improve documentation
---

diff --git a/include/deal.II/lac/block_matrix_base.h b/include/deal.II/lac/block_matrix_base.h
index 3239df5e68..4115c7eb38 100644
--- a/include/deal.II/lac/block_matrix_base.h
+++ b/include/deal.II/lac/block_matrix_base.h
@@ -583,6 +583,10 @@ public:
    * pattern of the calling matrix does not contain all the elements in the
    * sparsity pattern of the input matrix, this function will throw an
    * exception.
+   *
+   * Depending on MatrixType, however, additional restrictions might
+   * arise. Some sparse matrix formats require <tt>matrix</tt> to be based on
+   * the same sparsity pattern as the calling matrix.
    */
   void add (const value_type                   factor,
             const BlockMatrixBase<MatrixType> &matrix);