]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fix some DoFHandlerType documentation. 2090/head
authorDavid Wells <wellsd2@rpi.edu>
Wed, 20 Jan 2016 18:52:23 +0000 (13:52 -0500)
committerDavid Wells <wellsd2@rpi.edu>
Wed, 20 Jan 2016 19:10:01 +0000 (14:10 -0500)
include/deal.II/dofs/dof_tools.h
include/deal.II/numerics/vector_tools.templates.h

index 560dd62bdd22e55e9407d281147fe9702c324ce1..891a222bbd022bcd8c560a6abdc42b94a51654e0 100644 (file)
@@ -1933,11 +1933,13 @@ namespace DoFTools
    * DoFTools::get_dofs_on_patch() will then help to make the connection
    * between global degrees of freedom and the local ones.
    *
-   * @tparam Container A type that is either DoFHandler or hp::DoFHandler. In
-   * C++, the compiler can not determine the type of <code>DoFHandlerType</code> from the
-   * function call. You need to specify it as an explicit template argument
-   * following the function name.
+   * @tparam DoFHandlerType A type that is either DoFHandler or
+   * hp::DoFHandler. In C++, the compiler can not determine the type of
+   * <code>DoFHandlerType</code> from the function call. You need to specify it
+   * as an explicit template argument following the function name.
+   *
    * @param patch A collection of cells within an object of type DoFHandlerType
+   *
    * @return The number of degrees of freedom associated with the cells of
    * this patch.
    *
@@ -1985,11 +1987,13 @@ namespace DoFTools
    * one considers the index into this array a local DoF index, then the local
    * system that results retains the block structure of the global system.
    *
-   * @tparam Container A type that is either DoFHandler or hp::DoFHandler. In
-   * C++, the compiler can not determine the type of <code>DoFHandlerType</code> from the
-   * function call. You need to specify it as an explicit template argument
-   * following the function name.
+   * @tparam DoFHandlerType A type that is either DoFHandler or
+   * hp::DoFHandler. In C++, the compiler can not determine the type of
+   * <code>DoFHandlerType</code> from the function call. You need to specify it
+   * as an explicit template argument following the function name.
+   *
    * @param patch A collection of cells within an object of type DoFHandlerType
+   *
    * @return A list of those global degrees of freedom located on the patch,
    * as defined above.
    *
index 3386cc6e38af587046c4ba424b91625d17d6d6ea..4671bb5fa227bb27c761297c1bdf77e601d29daf 100644 (file)
@@ -558,7 +558,7 @@ namespace VectorTools
                                  VectorType                          &u2)
   {
     Assert(GridTools::have_same_coarse_mesh(dof1, dof2),
-           ExcMessage ("The two containers must represent triangulations that "
+           ExcMessage ("The two DoF handlers must represent triangulations that "
                        "have the same coarse meshes"));
 
     InterGridMap<DoFHandlerType<dim, spacedim> > intergridmap;
@@ -581,7 +581,7 @@ namespace VectorTools
                                  VectorType                          &u2)
   {
     Assert(GridTools::have_same_coarse_mesh(dof1, dof2),
-           ExcMessage ("The two containers must represent triangulations that "
+           ExcMessage ("The two DoF handlers must represent triangulations that "
                        "have the same coarse meshes"));
 
     InterGridMap<DoFHandlerType<dim, spacedim> > intergridmap;

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.