From: Wolfgang Bangerth Date: Fri, 30 Sep 2016 19:08:37 +0000 (-0600) Subject: Update the description of ConstraintMatrix::print(). X-Git-Tag: v8.5.0-rc1~617^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0bd1f08284fc066c2e9fa5280b5771315ac16048;p=dealii.git Update the description of ConstraintMatrix::print(). --- diff --git a/include/deal.II/lac/constraint_matrix.h b/include/deal.II/lac/constraint_matrix.h index 75bcce9398..cb00bd2d1a 100644 --- a/include/deal.II/lac/constraint_matrix.h +++ b/include/deal.II/lac/constraint_matrix.h @@ -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 row col : value. 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