]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Also document arguments and types. 2419/head
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Sun, 27 Mar 2016 19:11:30 +0000 (14:11 -0500)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Sun, 27 Mar 2016 19:11:30 +0000 (14:11 -0500)
include/deal.II/grid/manifold.h

index 1cc6a9ef46edbd2847634f454e81bfe788277e2b..a902725ebad0b80f79d76ec05ed14b587b361278 100644 (file)
@@ -65,6 +65,16 @@ namespace Manifolds
    * of the object pointed to. An example of where this is necessary
    * is for mesh refinement, where (using the 2d situation as an example)
    * we need to first create new edge mid-points, and then a new cell-point.
+   *
+   * @param[in] iterator A mesh iterator that points to either a line, quad,
+   *   or hex.
+   * @param[in] with_laplace Whether or not to compute the quadrature weights
+   *   by solving a Laplace equation, as discussed above.
+   * @tparam MeshIteratorType An iterator type that corresponds to either
+   *   Triangulation::cell_iterator (or variants such as
+   *   Triangulation::active_cell_iterator or DoFHandler::cell_iterator) or
+   *   that is the result of statements such as
+   *   <code>cell-@>face(f)</code> or <code>cell-@>line(l)</code>.
    */
   template <typename MeshIteratorType>
   Quadrature<MeshIteratorType::AccessorType::space_dimension>

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.