From b397591cebdb5f3229766f7444a5503fffc35b0b Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Thu, 7 Dec 2017 16:35:25 -0700 Subject: [PATCH] Update documentation of a function. --- include/deal.II/numerics/fe_field_function.h | 25 +++++++++++++------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/include/deal.II/numerics/fe_field_function.h b/include/deal.II/numerics/fe_field_function.h index 1468802b6c..119a7d43b4 100644 --- a/include/deal.II/numerics/fe_field_function.h +++ b/include/deal.II/numerics/fe_field_function.h @@ -397,15 +397,22 @@ namespace Functions std::vector > &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 -- 2.39.5