From: Wolfgang Bangerth Date: Tue, 16 Apr 2013 04:24:22 +0000 (+0000) Subject: Add to the documentation. X-Git-Tag: v8.0.0~692 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=96a6ff892ec84245fbb707e828fd4c0774d7839a;p=dealii.git Add to the documentation. git-svn-id: https://svn.dealii.org/trunk@29296 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/include/deal.II/grid/grid_tools.h b/deal.II/include/deal.II/grid/grid_tools.h index c69eb23ce6..37a59770e9 100644 --- a/deal.II/include/deal.II/grid/grid_tools.h +++ b/deal.II/include/deal.II/grid/grid_tools.h @@ -359,6 +359,14 @@ namespace GridTools * as it simultaneously delivers the * local coordinate of the given point * without additional computational cost. + * + * @note When applied to a triangulation or DoF handler object based + * on a parallel::distributed::Triangulation object, the cell + * returned may in fact be a ghost or artificial cell (see + * @ref GlossArtificialCell and @ref GlossGhostCell). If so, + * many of the operations one may want to do on this cell + * (e.g., evaluating the solution) may not be possible and you + * will have to decide what to do in that case. */ template class Container, int spacedim> typename Container::active_cell_iterator @@ -418,6 +426,14 @@ namespace GridTools * using GeometryInfo::project_to_unit_cell. * This is not automatically performed * by the algorithm. + * + * @note When applied to a triangulation or DoF handler object based + * on a parallel::distributed::Triangulation object, the cell + * returned may in fact be a ghost or artificial cell (see + * @ref GlossArtificialCell and @ref GlossGhostCell). If so, + * many of the operations one may want to do on this cell + * (e.g., evaluating the solution) may not be possible and you + * will have to decide what to do in that case. */ template class Container, int spacedim> std::pair::active_cell_iterator, Point > @@ -434,6 +450,14 @@ namespace GridTools * for hp problems, since the active * finite element index for all other DoF * handlers is always zero. + * + * @note When applied to a triangulation or DoF handler object based + * on a parallel::distributed::Triangulation object, the cell + * returned may in fact be a ghost or artificial cell (see + * @ref GlossArtificialCell and @ref GlossGhostCell). If so, + * many of the operations one may want to do on this cell + * (e.g., evaluating the solution) may not be possible and you + * will have to decide what to do in that case. */ template std::pair::active_cell_iterator, Point >