From: Matthias Maier <tamiko@43-1.org>
Date: Sun, 23 Aug 2015 01:51:45 +0000 (-0500)
Subject: Fix typos and clarify documentation
X-Git-Tag: v8.4.0-rc2~557^2~1
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e683388b3a8b66fecefda5f2a7b5488dc0c1ad46;p=dealii.git

Fix typos and clarify documentation
---

diff --git a/doc/doxygen/headers/glossary.h b/doc/doxygen/headers/glossary.h
index 02a10aef32..ba521e48f7 100644
--- a/doc/doxygen/headers/glossary.h
+++ b/doc/doxygen/headers/glossary.h
@@ -1220,13 +1220,13 @@ Article{JK10,
  * conditions</b></dt>
  * <dd>Periodic boundary condition are often used when only part of the physical
  * relevant domain is modeled. One assumes that the solution simply continues
- * periodically with respect to the boundaries that are condiered periodic.
+ * periodically with respect to the boundaries that are considered periodic.
  * In deal.II, support for this is through DoFTools::make_periodicity_constraints()
  * and GridTools::collect_periodic_faces(). As soon as a
  * parallel::distributed::Triangulation is used also
  * parallel::distributed::Triangulation::add_periodicity() has to be called to make
  * sure that all the processes know about relevant parts of the triangulation on both
- * sides of the periodic boundary. A typical process for disctributed triangulations would be:
+ * sides of the periodic boundary. A typical process for distributed triangulations would be:
  * -# Create a mesh
  * -# Gather the periodic faces using GridTools::collect_periodic_faces() (Triangulation)
  * -# Add the periodicity information to the mesh
diff --git a/doc/news/changes.h b/doc/news/changes.h
index 24c874f93e..5965319d36 100644
--- a/doc/news/changes.h
+++ b/doc/news/changes.h
@@ -109,7 +109,8 @@ inconvenience this causes.
 
 <ol>
   <li> Improved: The interface and documentation for periodic boundary
-  conditions have been restructured. A glossary entry has been written.
+  conditions have been restructured. A
+  @ref GlossPeriodicConstraints "glossary entry" has been written.
   <br>
   (Daniel Arndt, Matthias Maier, 2015/08/01-2015/08/21)
   </li>
diff --git a/include/deal.II/grid/grid_tools.h b/include/deal.II/grid/grid_tools.h
index ebd0056573..19434191a6 100644
--- a/include/deal.II/grid/grid_tools.h
+++ b/include/deal.II/grid/grid_tools.h
@@ -942,11 +942,11 @@ namespace GridTools
      * parameter to DofTools::make_periodicity_constraints()) is non empty
      * the matrix is interpreted as a @p dim $\times$ @p dim rotation
      * matrix that is applied to all vector valued blocks listed in @p
-     * first_vector_components of the FESystem. Alternatively, if @p
-     * first_vector_components is empty the matrix is interpreted as an
-     * interpolation matrix with size no_face_dofs $\times$ no_face_dofs.
-     * For more details see DoFTools::make_periodicity_constraints() and
-     * the glossary
+     * first_vector_components of the finite element space. Alternatively,
+     * if @p first_vector_components is empty the matrix is interpreted as
+     * an interpolation matrix with size no_face_dofs $\times$
+     * no_face_dofs. For more details see
+     * DoFTools::make_periodicity_constraints() and the glossary
      * @ref GlossPeriodicConstraints "glossary entry on periodic conditions".
      */
     FullMatrix<double> matrix;
@@ -1123,16 +1123,16 @@ namespace GridTools
    * This function will collect periodic face pairs on the coarsest mesh level
    * and add them to @p matched_pairs leaving the original contents intact.
    *
-   * Optionally a rotation matrix @p matrix along with a vector @p
-   * first_vector_components can be specified that describes how vector valued
-   * DoFs of the first face should be modified prior to constraining to the
-   * DoFs of the second face. If @p first_vector_components is non empty the
-   * matrix is interpreted as a rotation matrix that is applied to all
-   * vector valued blocks listed in @p first_vector_components of the
-   * FESystem. For more details see
-   * DoFTools::make_periodicity_constraints() and the glossary
-   *
-   * @ref GlossPeriodicConstraints "glossary entry on periodic conditions".
+   * Optionally, a @p matrix can be specified that describes how vector
+   * valued DoFs of the first face should be modified prior to constraining
+   * to the DoFs of the second face. If the matrix has size
+   * $n\_face\_dofs\times n\_face\_dofs$, the periodicity constraints are
+   * applied as $dofs\_2 = matrix\cdot dofs\_1$. If the matrix has size
+   * $dim\times dim$, the matrix is interpreted as a rotation matrix for
+   * vector valued components. For more details see
+   * DoFTools::make_periodicity_constraints(), the glossary
+   * @ref GlossPeriodicConstraints "glossary entry on periodic conditions"
+   * and @ref step_45 "step-45".
    *
    * @tparam Container A type that satisfies the requirements of a mesh
    * container (see