]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update SparsityPattern/SparseMatrix::copy_from() documentation. 11696/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Sat, 6 Feb 2021 00:25:12 +0000 (17:25 -0700)
committerWolfgang Bangerth <bangerth@colostate.edu>
Sat, 6 Feb 2021 00:25:12 +0000 (17:25 -0700)
include/deal.II/lac/sparse_matrix.h
include/deal.II/lac/sparsity_pattern.h

index d49b7db9ff0446b7fdf7a64cbe28009d8368ca63..2d61224122cf03104daca8b4243cf1d9289a3d9d 100644 (file)
@@ -973,8 +973,12 @@ public:
 
   /**
    * Copy the nonzero entries of a full matrix into this object. Previous
-   * content is deleted. Note that the underlying sparsity pattern must be
-   * appropriate to hold the nonzero entries of the full matrix.
+   * content is deleted.
+   *
+   * Note that the underlying sparsity pattern must be appropriate to
+   * hold the nonzero entries of the full matrix. This can be achieved
+   * using that version of SparsityPattern::copy_from() that takes a
+   * FullMatrix as argument.
    */
   template <typename somenumber>
   void
index 5d318174adf0c5cbe732f5f9b25c19139961abd9..e1fe0a68370ea19eb8c48c9a4e191881a41354b5 100644 (file)
@@ -1138,6 +1138,13 @@ public:
    *
    * Previous content of this object is lost, and the sparsity pattern is in
    * compressed mode afterwards.
+   *
+   * Once you have built a sparsity pattern with this function, you
+   * probably want to attach a SparseMatrix object to it. The original
+   * `matrix` object can then be copied into this SparseMatrix object
+   * using the version of SparseMatrix::copy_from() that takes a
+   * FullMatrix object as argument. Through this procedure, you can
+   * convert a FullMatrix into a SparseMatrix.
    */
   template <typename number>
   void

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.