]> https://gitweb.dealii.org/ - dealii.git/commitdiff
fix formatting
authorTimo Heister <timo.heister@gmail.com>
Wed, 14 Jan 2015 18:13:14 +0000 (13:13 -0500)
committerTimo Heister <timo.heister@gmail.com>
Wed, 14 Jan 2015 18:13:34 +0000 (13:13 -0500)
include/deal.II/lac/parallel_vector.h

index c0fd7962473a2f10427378653ca3d00ea8ff2755..1d9c472316e4a4a7a40f9e5ef786530f4780464e 100644 (file)
@@ -71,9 +71,12 @@ namespace parallel
      * exception that storage is distributed with MPI.
      *
      * The vector is designed for the following scheme of parallel
-     * partitioning: <ul> <li> The indices held by individual processes
+     * partitioning:
+     * <ul>
+     * <li> The indices held by individual processes
      * (locally owned part) in the MPI parallelization form a contiguous range
-     * <code>[my_first_index,my_last_index)</code>. <li> Ghost indices
+     * <code>[my_first_index,my_last_index)</code>.
+     * <li> Ghost indices
      * residing on arbitrary positions of other processors are allowed. It is
      * in general more efficient if ghost indices are clustered, since they
      * are stored as a set of intervals. The communication pattern of the
@@ -82,37 +85,46 @@ namespace parallel
      * the partitioning is changed. This allows for efficient parallel
      * communication of indices. In particular, it stores the communication
      * pattern, rather than having to compute it again for every
-     * communication. For more information on ghost vectors, see also the @ref
-     * GlossGhostedVector "glossary entry on vectors with ghost
-     * elements". <li> Besides the usual global access operator () it is also
+     * communication. For more information on ghost vectors, see also the
+     * @ref GlossGhostedVector "glossary entry on vectors with ghost elements".
+     * <li> Besides the usual global access operator() it is also
      * possible to access vector entries in the local index space with the
      * function @p local_element(). Locally owned indices are placed first,
      * [0, local_size()), and then all ghost indices follow after them
-     * contiguously, [local_size(), local_size()+n_ghost_entries()).</ul>
+     * contiguously, [local_size(), local_size()+n_ghost_entries()).
+     * </ul>
      *
-     * Functions related to parallel functionality: <ul> <li> The function
+     * Functions related to parallel functionality:
+     * <ul>
+     * <li> The function
      * <code>compress()</code> goes through the data associated with ghost
      * indices and communicates it to the owner process, which can then add it
      * to the correct position. This can be used e.g. after having run an
      * assembly routine involving ghosts that fill this vector. Note that the
      * @p insert mode of @p compress() does not set the elements included in
      * ghost entries but simply discards them, assuming that the owning
-     * processor has set them to the desired value already (See also the @ref
-     * GlossCompress "glossary entry on compress"). <li> The
+     * processor has set them to the desired value already (See also the
+     * @ref GlossCompress "glossary entry on compress").
+     * <li> The
      * <code>update_ghost_values()</code> function imports the data from the
      * owning processor to the ghost indices in order to provide read access
-     * to the data associated with ghosts. <li> It is possible to split the
+     * to the data associated with ghosts.
+     * <li> It is possible to split the
      * above functions into two phases, where the first initiates the
      * communication and the second one finishes it. These functions can be
      * used to overlap communication with computations in other parts of the
-     * code. <li> Of course, reduction operations (like norms) make use of
-     * collective all- to-all MPI communications. </ul>
+     * code.
+     * <li> Of course, reduction operations (like norms) make use of
+     * collective all-to-all MPI communications.
+     * </ul>
      *
      * This vector can take two different states with respect to ghost
-     * elements: <ul> <li> After creation and whenever zero_out_ghosts() is
-     * called (or <code>operator = (0.)</code>), the vector does only allow
-     * writing into ghost elements but not reading from ghost elements. <li>
-     * After a call to update_ghost_values(), the vector does not allow
+     * elements:
+     * <ul>
+     * <li> After creation and whenever zero_out_ghosts() is
+     * called (or <code>operator= (0.)</code>), the vector does only allow
+     * writing into ghost elements but not reading from ghost elements.
+     * <li> After a call to update_ghost_values(), the vector does not allow
      * writing into ghost elements but only reading from them. This is to
      * avoid undesired ghost data artifacts when calling compress() after
      * modifying some vector entries. The current status of the ghost entries
@@ -120,7 +132,8 @@ namespace parallel
      * has_ghost_elements(), which returns <code>true</code> exactly when
      * ghost elements have been updated and <code>false</code> otherwise,
      * irrespective of the actual number of ghost entries in the vector layout
-     * (for that information, use n_ghost_entries() instead).</ul>
+     * (for that information, use n_ghost_entries() instead).
+     * </ul>
      *
      * This vector uses the facilities of the class dealii::Vector<Number> for
      * implementing the operations on the local range of the vector. In

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.