]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Add to documentation
authorbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Tue, 4 Mar 2008 22:34:44 +0000 (22:34 +0000)
committerbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Tue, 4 Mar 2008 22:34:44 +0000 (22:34 +0000)
git-svn-id: https://svn.dealii.org/trunk@15850 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/lac/include/lac/block_sparsity_pattern.h
deal.II/lac/include/lac/compressed_set_sparsity_pattern.h
deal.II/lac/include/lac/compressed_sparsity_pattern.h

index ee345c8fe0abfcb81d190e4997f408013931c5af..8f54ee5cee0409776b1c6df4825859292359283f 100644 (file)
@@ -536,12 +536,20 @@ class BlockSparsityPattern : public BlockSparsityPatternBase<SparsityPattern>
  *
  * This class is an example of the "dynamic" type of @ref Sparsity.
  *
+ * <b>Note:</b> This class inherits the same tradeoffs regarding its
+ * efficiency as CompressedSparsityPattern and as opposed to
+ * CompressedSetSparsity. Since the two classes (and consequently
+ * BlockCompressedSparsityPattern and
+ * BlockCompressedSetSparsityPattern) are interface-compatible it is
+ * frequently worth checking which version is more efficient.
+ *
  * <b>Note:</b> This class used to be called
  * CompressedBlockSparsityPattern. However, since it's a block wrapper around
  * the CompressedSparsityPattern class, this is a misnomer and the class has
  * been renamed.
  *
  * <h3>Example</h3>
+ *
  * Usage of this class is very similar to CompressedSparsityPattern,
  * but since the use of block indices causes some additional
  * complications, we give a short example.
@@ -660,6 +668,13 @@ typedef BlockCompressedSparsityPattern CompressedBlockSparsityPattern;
  *
  * This class is an example of the "dynamic" type of @ref Sparsity.
  *
+ * <b>Note:</b> This class inherits the same tradeoffs regarding its
+ * efficiency as CompressedSparsityPattern and as opposed to
+ * CompressedSetSparsity. Since the two classes (and consequently
+ * BlockCompressedSparsityPattern and
+ * BlockCompressedSetSparsityPattern) are interface-compatible it is
+ * frequently worth checking which version is more efficient.
+ *
  * @author Wolfgang Bangerth, 2007
  */
 class BlockCompressedSetSparsityPattern : public BlockSparsityPatternBase<CompressedSetSparsityPattern>
index 977dfdf758d2efd33225cfb7e86f9abe6b2ea6eb..544b6ae0d5514c6452dd58e1e43b446386a275a2 100644 (file)
@@ -2,7 +2,7 @@
 //    $Id: compressed_sparsity_pattern.h 14038 2006-10-23 02:46:34Z bangerth $
 //    Version: $Name$
 //
-//    Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007 by the deal.II authors
+//    Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 by the deal.II authors
 //
 //    This file is subject to QPL and may not be  distributed
 //    without copyright and license information. Please refer
@@ -50,8 +50,9 @@ template <typename number> class SparseMatrix;
  * of sparsity patterns can be found in the documentation of the @ref Sparsity
  * module.
  *
- * This class is an example of the "dynamic" type of @ref Sparsity. It is
- * discussed in the @ref step_27 "step-27" tutorial program.
+ * This class is an example of the "dynamic" type of @ref Sparsity. It
+ * is discussed in the @ref step_27 "step-27" and @ref step_31
+ * "step-31" tutorial programs.
  *
  * <h3>Interface</h3>
  *
@@ -84,15 +85,18 @@ template <typename number> class SparseMatrix;
  * This class is a variation of the CompressedSparsityPattern class.
  * Instead of using sorted vectors together with a caching algorithm
  * for storing the column indices of nonzero entries, the std::set
- * container is used. This solution might not be the fastest in
- * all situations, but seems to work much better than the
- * CompressedSparsityPattern in the context of hp-adaptivity.
- * On the other hand, a benchmark where nonzero entries were randomly inserted
- * into the sparsity pattern revealed that this class is slower
- * by a factor 4-6 in this situation. Hence, currently the suggestion
- * is to carefully analyze which of the CompressedSparsityPattern
- * classes works best in a certain setting. An algorithm which
- * performs equally well in all situations still has to be found.
+ * container is used. This solution might not be the fastest in all
+ * situations, but seems to work much better than the
+ * CompressedSparsityPattern in the context of hp-adaptivity (see for
+ * example @ref step_27 "step-27"), or generally when there are many
+ * nonzero entries in each row of a matrix (see @ref step_31
+ * "step-31").  On the other hand, a benchmark where nonzero entries
+ * were randomly inserted into the sparsity pattern revealed that this
+ * class is slower by a factor 4-6 in this situation. Hence, currently
+ * the suggestion is to carefully analyze which of the
+ * CompressedSparsityPattern classes works best in a certain
+ * setting. An algorithm which performs equally well in all situations
+ * still has to be found.
  *
  *
  * @author Oliver Kayser-Herold, 2007
index ed0d3dda378b1b3c648b9502a62f8c3346c39626..f40410e422f0db8ffe7e3627f319167de44761e5 100644 (file)
@@ -2,7 +2,7 @@
 //    $Id$
 //    Version: $Name$
 //
-//    Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007 by the deal.II authors
+//    Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 by the deal.II authors
 //
 //    This file is subject to QPL and may not be  distributed
 //    without copyright and license information. Please refer
@@ -79,10 +79,11 @@ template <typename number> class SparseMatrix;
  *
  * <h3>Notes</h3>
  *
- * A variation of this class is the CompressedSetSparsityPattern class that
- * appears to be more efficient in some situations, in particular when using
- * hp finite elements. See for example the @ref step_27 "step-27" tutorial
- * program.
+ * A variation of this class is the CompressedSetSparsityPattern class
+ * that appears to be more efficient in some situations, in particular
+ * when using hp finite elements or, more generally, in cases with
+ * many nonzero entries. See for example the @ref step_27 "step-27"
+ * and @ref step_31 "step-31" tutorial programs.
  *
  * @author Wolfgang Bangerth, 2001
  */

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.