From: Timo Heister Date: Thu, 12 Feb 2015 15:42:44 +0000 (-0500) Subject: remove documentation of ConstraintMatrix:condense(big, small) X-Git-Tag: v8.3.0-rc1~476^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b40c9f337096159ec713368987661e33048eb067;p=dealii.git remove documentation of ConstraintMatrix:condense(big, small) --- diff --git a/doc/doxygen/headers/constraints.h b/doc/doxygen/headers/constraints.h index 637f54163b..3bad6e15b0 100644 --- a/doc/doxygen/headers/constraints.h +++ b/doc/doxygen/headers/constraints.h @@ -139,34 +139,14 @@ * - third, the global matrix is assembled; * - and fourth, the matrix is finally condensed. * - * To do these steps, you have (at least) two possibilities: - * - * - * - * The ConstraintMatrix class provides two sets of @p condense functions: - * those taking two arguments refer to the first possibility above, those - * taking only one do their job in-place and refer to the second possibility. * - * The condensation functions exist for different argument types. The - * in-place functions (i.e. those following the second way) exist for - * arguments of type SparsityPattern, SparseMatrix and + * The condensation functions exist for different argument types: SparsityPattern, + * SparseMatrix and * BlockSparseMatrix. Note that there are no versions for arguments of type * PETScWrappers::SparseMatrix() or any of the other PETSc or Trilinos * matrix wrapper classes. This is due to the fact that it is relatively * hard to get a representation of the sparsity structure of PETSc matrices, - * and to modify them; this holds in particular, if the matrix is actually + * and to modify them efficiently; this holds in particular, if the matrix is actually * distributed across a cluster of computers. If you want to use * PETSc/Trilinos matrices, you can either copy an already condensed deal.II * matrix, or assemble the PETSc/Trilinos matrix in the already condensed form, @@ -282,8 +256,8 @@ * leaves the values of constrained degrees of freedom undefined. To get the * correct values also for these degrees of freedom, you need to "distribute" * the unconstrained values also to their constrained colleagues. This is done - * by the two ConstraintMatrix::distribute() functions, one working with two - * vectors, one working in-place. The operation of distribution undoes the + * by the ConstraintMatrix::distribute() function. + * The operation of distribution undoes the * condensation process in some sense, but it should be noted that it is not * the inverse operation. Basically, distribution sets the values of the * constrained nodes to the value that is computed from the constraint given