]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update documentation of a function.
authorWolfgang Bangerth <bangerth@colostate.edu>
Thu, 7 Dec 2017 23:35:25 +0000 (16:35 -0700)
committerWolfgang Bangerth <bangerth@colostate.edu>
Fri, 8 Dec 2017 18:09:37 +0000 (11:09 -0700)
include/deal.II/numerics/fe_field_function.h

index 1468802b6c49166676919be28fbf4c5e7ccee061..119a7d43b400dbc8231283146324357669d25e85 100644 (file)
@@ -397,15 +397,22 @@ namespace Functions
                            std::vector<Vector<typename VectorType::value_type> >   &values) const;
 
     /**
-     * Create quadrature rules. This function groups the points into blocks
-     * that live in the same cell, and fills up three vectors: @p cells, @p
-     * qpoints and @p maps. The first is a list of the cells that contain the
-     * points, the second is a list of quadrature points matching each cell of
-     * the first list, and the third contains the index of the given
-     * quadrature points, i.e., @p points[maps[3][4]] ends up as the 5th
-     * quadrature point in the 4th cell. This is where optimization would
-     * help. This function returns the number of cells that contain the given
-     * set of points.
+     * Given a set of points located in the domain (or, in the case of
+     * a parallel Triangulation, in the locally owned part of the domain
+     * or on the ghost cells for the current processor), sort these
+     * points into buckets for each of the cells on which at least
+     * one of the points is located.
+     *
+     * This function fills three output vectors: @p cells, @p qpoints
+     * and @p maps. The first is a list of the cells that contain the
+     * points, the second is a list of quadrature points matching each
+     * cell of the first list, and the third contains the index of the
+     * given quadrature points, i.e., @p points[maps[3][4]] ends up as
+     * the 5th quadrature point in the 4th cell.
+     *
+     * @return This function returns the number of cells that
+     *   collectively contain the set of points give as @p
+     *   points. This also equals the lengths of the output arrays.
      */
     unsigned int
     compute_point_locations

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.