From f2992aadbced3d95323b998eb80033843b453b56 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Wed, 5 Nov 2014 11:16:13 -0600 Subject: [PATCH] Augment documentation. --- include/deal.II/grid/grid_tools.h | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/include/deal.II/grid/grid_tools.h b/include/deal.II/grid/grid_tools.h index 09a3a13828..eb00e598fc 100644 --- a/include/deal.II/grid/grid_tools.h +++ b/include/deal.II/grid/grid_tools.h @@ -74,12 +74,31 @@ namespace GridTools /** * Compute the volume (i.e. the dim-dimensional measure) of the * triangulation. We compute the measure using the integral - * $\int 1 \; dx$. The integral approximated is approximated + * $\sum_K \int_K 1 \; dx$ where $K$ are the cells of the + * given triangulation. The integral is approximated * via quadrature for which we need the mapping argument. * + * If the triangulation is a dim-dimensional one embedded in + * a higher dimensional space of dimension spacedim, then the + * value returned is the dim-dimensional measure. For example, + * for a two-dimensional triangulation in three-dimensional space, + * the value returned is the area of the surface so described. + * (This obviously makes sense since the spacedim-dimensional + * measure of a dim-dimensional triangulation would always be + * zero if dim @< spacedim. + * * This function also works for objects of type * parallel::distributed::Triangulation, in which case the * function is a collective operation. + * + * @param tria The triangulation. + * @param mapping An optional argument used to denote the mapping + * that should be used when describing whether cells are bounded + * by straight or curved faces. The default is to use a $Q_1$ + * mapping, which corresponds to straight lines bounding the + * cells. + * @return The dim-dimensional measure of the domain described + * by the triangulation, as discussed above. */ template double volume (const Triangulation &tria, -- 2.39.5