From: Wolfgang Bangerth Date: Wed, 13 Sep 2017 13:42:15 +0000 (-0600) Subject: Explain a code example better. X-Git-Tag: v9.0.0-rc1~1091^2~1 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=813de2e5e6d98b68929d74a93b869ce600b20a50;p=dealii.git Explain a code example better. --- diff --git a/include/deal.II/distributed/grid_tools.h b/include/deal.II/distributed/grid_tools.h index ad3edeb35a..319c70ee7d 100644 --- a/include/deal.II/distributed/grid_tools.h +++ b/include/deal.II/distributed/grid_tools.h @@ -110,10 +110,18 @@ namespace parallel * (dof_handler, pack, unpack); * @endcode * - * You will notice that the lambda function returns an `unsigned int`, + * You will notice that the @p pack lambda function returns an `unsigned int`, * not a `boost::optional`. The former converts automatically * to the latter, implying that data will always be transported to the * other processor. + * + * (In reality, the @p unpack function needs to be a bit more + * complicated because it is not allowed to call + * DoFAccessor::set_active_fe_index() on ghost cells. Rather, the + * @p unpack function directly accesses internal data structures. But + * you get the idea -- the code could, just as well, have exchanged + * material ids, user indices, boundary indictors, or any kind of other + * data with similar calls as the ones above.) */ template void