]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Add to the documentation.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Tue, 16 Apr 2013 04:24:22 +0000 (04:24 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Tue, 16 Apr 2013 04:24:22 +0000 (04:24 +0000)
git-svn-id: https://svn.dealii.org/trunk@29296 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/include/deal.II/grid/grid_tools.h

index c69eb23ce621dac75cdaae2b217715f353e73ad9..37a59770e926ccca120b3176f10a23fff6121af9 100644 (file)
@@ -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 <int dim, template <int,int> class Container, int spacedim>
   typename Container<dim,spacedim>::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 <int dim, template<int, int> class Container, int spacedim>
   std::pair<typename Container<dim,spacedim>::active_cell_iterator, Point<dim> >
@@ -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 <int dim, int spacedim>
   std::pair<typename hp::DoFHandler<dim,spacedim>::active_cell_iterator, Point<dim> >

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.