]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
fix documentation.
authorheister <heister@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 22 Sep 2010 16:05:32 +0000 (16:05 +0000)
committerheister <heister@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 22 Sep 2010 16:05:32 +0000 (16:05 +0000)
git-svn-id: https://svn.dealii.org/trunk@22120 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/lac/include/lac/sparsity_tools.h

index 442ac45bf70589d2e9ee4176f95aa6430aa8b447..dabf7e35e655177f93a266b539d1a149512c50a8 100644 (file)
@@ -199,20 +199,21 @@ namespace SparsityTools
 #ifdef DEAL_II_COMPILER_SUPPORTS_MPI
                                   /**
                                    * Communciate rows in a compressed
-                                   * sparsity pattern over MPI. The @param
-                                   * csp is modified inline. All entries in
-                                   * rows that belong to a different
+                                   * sparsity pattern over MPI. The parameter
+                                   * @p csp is modified inline. All entries
+                                   * in rows that belong to a different
                                    * processor are send to them and added
                                    * there. The ownership is determined by
-                                   * parameter @param rows_per_cpu. The
-                                   * IndexSet @param myrange should be the
-                                   * one used in the constructor of the
-                                   * CompressedSimpleSparsityPattern. All
-                                   * rows contained in @param myrange are
-                                   * checked in @param csp.  This function
-                                   * needs to be used with
+                                   * the parameter @p rows_per_cpu. The
+                                   * IndexSet @p myrange should be the one
+                                   * used in the constructor of the
+                                   * CompressedSimpleSparsityPattern. Only
+                                   * the rows in @p csp contained in @p
+                                   * myrange are checked for transfer. This
+                                   * function needs to be used with
                                    * PETScWrappers::MPI::SparseMatrix for it
-                                   * to work correctly.
+                                   * to work correctly in a parallel
+                                   * calculation.
                                    */
   template <class CSP_t>
   void distribute_sparsity_pattern(CSP_t & csp,

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.