]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update the description of ConstraintMatrix::print(). 3172/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Fri, 30 Sep 2016 19:08:37 +0000 (13:08 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Fri, 30 Sep 2016 19:08:37 +0000 (13:08 -0600)
include/deal.II/lac/constraint_matrix.h

index 75bcce93987d5090176f66365ae1bcc673c600c9..cb00bd2d1a03684bde6741fe4f7846df1f31c0b6 100644 (file)
@@ -475,14 +475,26 @@ public:
   double get_inhomogeneity (const size_type line) const;
 
   /**
-   * Print the constraint lines. Mainly for debugging purposes.
+   * Print the constraints represented by the current object to the
+   * given stream.
+   *
+   * For each constraint of the form
+   * @f[
+   *  x_{42} = 0.5 x_2 + 0.25 x_{14} + 2.75
+   * @f]
+   * this function will write a sequence of lines that look like this:
+   * @code
+   *   42 2 : 0.5
+   *   42 14 : 0.25
+   *   42 : 2.75
+   * @endcode
+   * The last line is only shown if the inhomogeneity (here: 2.75) is
+   * nonzero.
    *
-   * This function writes out all entries in the constraint matrix lines with
-   * their value in the form <tt>row col : value</tt>. Unconstrained lines
-   * containing only one identity entry are not stored in this object and are
-   * not printed.
+   * A block of lines such as the one above is repeated for each
+   * constrained degree of freedom.
    */
-  void print (std::ostream &) const;
+  void print (std::ostream &out) const;
 
   /**
    * Write the graph of constraints in 'dot' format. 'dot' is a program that

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.