]> https://gitweb.dealii.org/ - dealii.git/commitdiff
fix up more files
authorTimo Heister <timo.heister@gmail.com>
Thu, 25 Dec 2014 20:10:23 +0000 (15:10 -0500)
committerMatthias Maier <tamiko@kyomu.43-1.org>
Fri, 26 Dec 2014 12:52:57 +0000 (13:52 +0100)
include/deal.II/base/graph_coloring.h
include/deal.II/base/iterator_range.h
include/deal.II/grid/grid_tools.h
include/deal.II/hp/dof_handler.h
include/deal.II/lac/block_matrix_array.h

index c0977418738b1a0883eecefb74bab9588e4fcd08..3745f4c170db4ad478e35dcaa19f5c449593564f 100644 (file)
@@ -42,7 +42,8 @@ namespace GraphColoring
      * whether they will have a nonempty intersection. The actual intersection
      * is not computed.
      * @param indices1 A set of indices, assumed sorted.
-     * @param indices2 A set of indices, assumed sorted. @return Whether the
+     * @param indices2 A set of indices, assumed sorted.
+     * @return Whether the
      * two sets of indices do have a nonempty intersection.
      */
     inline
@@ -95,7 +96,8 @@ namespace GraphColoring
      * @param[in] end The element past the end of the range of iterators.
      * @param[in] get_conflict_indices A user defined function object
      * returning a set of indicators that are descriptive of what represents a
-     * conflict. See above for a more thorough discussion. @return A set of
+     * conflict. See above for a more thorough discussion.
+     * @return A set of
      * sets of iterators (where sets are represented by std::vector for
      * efficiency). Each element of the outermost set corresponds to the
      * iterators pointing to objects that are in the same partition (i.e., the
@@ -500,7 +502,8 @@ namespace GraphColoring
    * @param[in] end The element past the end of the range of iterators.
    * @param[in] get_conflict_indices A user defined function object returning
    * a set of indicators that are descriptive of what represents a conflict.
-   * See above for a more thorough discussion. @return A set of sets of
+   * See above for a more thorough discussion.
+   * @return A set of sets of
    * iterators (where sets are represented by std::vector for efficiency).
    * Each element of the outermost set corresponds to the iterators pointing
    * to objects that are in the same partition (have the same color) and
index 914db74eb08fbac544c26f9fa1b32b7b9d9f0c13..8d51ba5cd69a0218c10efcebcd79700c81a88607 100644 (file)
@@ -140,13 +140,15 @@ public:
     IteratorOverIterators (const BaseIterator &iterator);
 
     /**
-     * Dereferencing operator. @return The iterator within the collection
+     * Dereferencing operator.
+     * @return The iterator within the collection
      * currently pointed to.
      */
     BaseIterator operator* () const;
 
     /**
-     * Dereferencing operator. @return The iterator within the collection
+     * Dereferencing operator.
+     * @return The iterator within the collection
      * currently pointed to.
      */
     const BaseIterator *operator-> () const;
@@ -166,7 +168,8 @@ public:
 
     /**
      * Comparison operator
-     * @param i_o_i Another iterator over iterators. @return Returns whether
+     * @param i_o_i Another iterator over iterators.
+     * @return Returns whether
      * the current iterator points to a different object than the iterator
      * represented by the argument.
      */
index bacf1a0aacce0070d6c9cf5434531357a7abfd88..e6d1c20c9a5ec7cb79de65aeeae8426ae5e47267 100644 (file)
@@ -409,8 +409,11 @@ namespace GridTools
    *
    * @note When applied to a triangulation or DoF handler object based on a
    * parallel::distributed::Triangulation object, the cell returned may in
-   * fact be a ghost or artificial cell (see @ref GlossArtificialCell and
-   * @ref GlossGhostCell). If so, many of the operations one may want to do
+   * fact be a ghost or artificial cell (see
+   * @ref GlossArtificialCell
+   * and
+   * @ref GlossGhostCell
+   * ). If so, many of the operations one may want to do
    * on this cell (e.g., evaluating the solution) may not be possible and
    * you will have to decide what to do in that case.
    */
@@ -443,7 +446,9 @@ namespace GridTools
    * @param mapping The mapping used to determine whether the given point is
    * inside a given cell.
    * @param container A variable of a type that satisfies the requirements of
-   * a mesh container (see @ref GlossMeshAsAContainer).
+   * a mesh container (see
+   * @ref GlossMeshAsAContainer
+   * ).
    * @param p The point for which we want to find the surrounding cell.
    * @return An pair of an iterator into the mesh container that points to the
    * surrounding cell, and of the coordinates of that point inside the cell in
@@ -460,7 +465,9 @@ namespace GridTools
    *
    * @note When applied to a triangulation or DoF handler object based on a
    * parallel::distributed::Triangulation object, the cell returned may in
-   * fact be a ghost or artificial cell (see @ref GlossArtificialCell and
+   * fact be a ghost or artificial cell (see
+   * @ref GlossArtificialCell
+   * and
    * @ref GlossGhostCell). If so, many of the operations one may want to do
    * on this cell (e.g., evaluating the solution) may not be possible and
    * you will have to decide what to do in that case.
@@ -488,7 +495,8 @@ namespace GridTools
    *
    * @note When applied to a triangulation or DoF handler object based on a
    * parallel::distributed::Triangulation object, the cell returned may in
-   * fact be a ghost or artificial cell (see @ref GlossArtificialCell and
+   * fact be a ghost or artificial cell (see
+   * @ref GlossArtificialCell and
    * @ref GlossGhostCell). If so, many of the operations one may want to do
    * on this cell (e.g., evaluating the solution) may not be possible and
    * you will have to decide what to do in that case.
@@ -509,7 +517,8 @@ namespace GridTools
    * (because the cell has no children that may be active).
    *
    * @tparam Container A type that satisfies the requirements of a mesh
-   * container (see @ref GlossMeshAsAContainer).
+   * container (see
+   * @ref GlossMeshAsAContainer).
    * @param cell An iterator pointing to a cell of the mesh container.
    * @return A list of active descendants of the given cell
    *
@@ -529,7 +538,8 @@ namespace GridTools
    * the vector @p active_neighbors.
    *
    * @tparam Container A type that satisfies the requirements of a mesh
-   * container (see @ref GlossMeshAsAContainer).
+   * container (see
+   * @ref GlossMeshAsAContainer).
    * @param[in] cell An iterator pointing to a cell of the mesh container.
    * @param[out] active_neighbors A list of active descendants of the given
    * cell
@@ -661,8 +671,10 @@ namespace GridTools
   /**
    * For a triangulation, return a mask that represents which of its vertices
    * are "owned" by the current process in the same way as we talk about
-   * locally owned cells or degrees of freedom (see @ref GlossLocallyOwnedCell
-   * and @ref GlossLocallyOwnedDof). For the purpose of this function, we
+   * locally owned cells or degrees of freedom (see
+   * @ref GlossLocallyOwnedCell
+   * and
+   * @ref GlossLocallyOwnedDof). For the purpose of this function, we
    * define a locally owned vertex as follows: a vertex is owned by that
    * processor with the smallest subdomain id (which equals the MPI rank of
    * that processor) among all owners of cells adjacent to this vertex. In
@@ -721,7 +733,8 @@ namespace GridTools
    * traversed in one, or both, of the meshes given as arguments.
    *
    * @tparam Container A type that satisfies the requirements of a mesh
-   * container (see @ref GlossMeshAsAContainer).
+   * container (see
+   * @ref GlossMeshAsAContainer).
    */
   template <typename Container>
   std::list<std::pair<typename Container::cell_iterator,
@@ -750,7 +763,8 @@ namespace GridTools
    * triangulations or the classes built on triangulations.
    *
    * @tparam Container A type that satisfies the requirements of a mesh
-   * container (see @ref GlossMeshAsAContainer).
+   * container (see
+   * @ref GlossMeshAsAContainer).
    */
   template <typename Container>
   bool
@@ -815,7 +829,8 @@ namespace GridTools
    * sub-faces to the list to be returned.
    *
    * @tparam Container A type that satisfies the requirements of a mesh
-   * container (see @ref GlossMeshAsAContainer). In C++, the compiler can not
+   * container (see
+   * @ref GlossMeshAsAContainer). In C++, the compiler can not
    * determine the type of <code>Container</code> from the function call. You
    * need to specify it as an explicit template argument following the
    * function name.
@@ -994,7 +1009,8 @@ namespace GridTools
    * @endcode
    *
    * and any combination of that... More information on the topic can be found
-   * in the @ref GlossFaceOrientation "glossary" article.
+   * in the
+   * @ref GlossFaceOrientation "glossary" article.
    *
    * @author Matthias Maier, 2012
    */
@@ -1057,7 +1073,8 @@ namespace GridTools
    * @ref GlossPeriodicConstraints "glossary entry on periodic boundary conditions".
    *
    * @tparam Container A type that satisfies the requirements of a mesh
-   * container (see @ref GlossMeshAsAContainer).
+   * container (see
+   * @ref GlossMeshAsAContainer).
    *
    * @note The created std::vector can be used in
    * DoFTools::make_periodicity_constraints() and in
@@ -1086,7 +1103,8 @@ namespace GridTools
 
   /**
    * This compatibility version of collect_periodic_face_pairs() only works on
-   * grids with cells in @ref GlossFaceOrientation "standard orientation".
+   * grids with cells in
+   * @ref GlossFaceOrientation "standard orientation".
    *
    * Instead of defining a 'first' and 'second' boundary with the help of two
    * boundary_indicators this function defines a 'left' boundary as all faces
@@ -1107,7 +1125,8 @@ namespace GridTools
    * @ref GlossPeriodicConstraints "glossary entry on periodic boundary conditions".
    *
    * @tparam Container A type that satisfies the requirements of a mesh
-   * container (see @ref GlossMeshAsAContainer).
+   * container (see
+   * @ref GlossMeshAsAContainer).
    *
    * @note This version of collect_periodic_face_pairs() will not work on
    * meshes with cells not in
index 36d48a77f10d9251a11d17612d499222a1d9f70e..d30820c8c5b05f1dbe7959707ce96af4b4c2c775 100644 (file)
@@ -447,7 +447,8 @@ namespace hp
      * in the documentation of active_cell_iterators().
      *
      * @param[in] level A given level in the refinement hierarchy of this
-     * triangulation. @return The half open range <code>[this->begin(level),
+     * triangulation.
+     * @return The half open range <code>[this->begin(level),
      * this->end(level))</code>
      *
      * @pre level must be less than this->n_levels().
@@ -463,7 +464,8 @@ namespace hp
      * in the documentation of active_cell_iterators().
      *
      * @param[in] level A given level in the refinement hierarchy of this
-     * triangulation. @return The half open range
+     * triangulation.
+     * @return The half open range
      * <code>[this->begin_active(level), this->end(level))</code>
      *
      * @pre level must be less than this->n_levels().
index 56e8f0f826a98ab88ad927ac2745fd4e01e38072..bd5646d3ce63c4d0a017d229d275d93eff2d351a 100644 (file)
@@ -106,7 +106,8 @@ template <typename> class Vector;
  * The remaining code of this sample program concerns preconditioning and is
  * described in the documentation of BlockTrianglePrecondition.
  *
- * @see @ref GlossBlockLA "Block (linear algebra)"
+ * @see
+ * @ref GlossBlockLA "Block (linear algebra)"
  * @author Guido Kanschat
  * @date 2000-2005, 2010
  */

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.