]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Corrected documentation about FEFieldFunction and distributed triangulation: exceptio... 6236/head
authorGiovanni Alzetta <giovannialzetta@hotmail.it>
Thu, 12 Apr 2018 21:36:34 +0000 (23:36 +0200)
committerGiovanni Alzetta <giovannialzetta@hotmail.it>
Sat, 14 Apr 2018 14:00:28 +0000 (16:00 +0200)
include/deal.II/numerics/fe_field_function.h

index dc007f4c3de30e17b3cf8cbfbb7308a901e13e5d..55baf7a495909d4885a0b2d1025d986239bba8db 100644 (file)
@@ -123,16 +123,10 @@ namespace Functions
    * @ref GlossArtificialCell
    * and
    * @ref GlossGhostCell).
-   * If the cell is artificial, we have no access to the solution there and
+   * The solution can be evaluated on ghost cells, but for artificial cells
+   * we have no access to the solution there and
    * functions that evaluate the solution at such a point will trigger an
-   * exception of type VectorTools::ExcPointNotAvailableHere. The same kind of
-   * exception will also be produced if the cell is a ghost cell: On such
-   * cells, one could in principle evaluate the solution, but it becomes
-   * easier if we do not allow to do so because then there is exactly one
-   * processor in a parallel distributed computation that can indeed evaluate
-   * the solution. Consequently, it is clear which processor is responsible
-   * for producing output if the point evaluation is done as a postprocessing
-   * step.
+   * exception of type VectorTools::ExcPointNotAvailableHere.
    *
    * To deal with this situation, you will want to use code as follows when,
    * for example, evaluating the solution at the origin (here using a parallel
@@ -194,8 +188,8 @@ namespace Functions
      *
      * @note When using this function on a
      * parallel::distributed::Triangulation you may get an exception when
-     * trying to evaluate the solution at a point that does not lie in a
-     * locally owned cell (see
+     * trying to evaluate the solution at a point that lies on an artificial
+     * cell (see
      * @ref GlossLocallyOwnedCell).
      * See the section in the general documentation of this class for more
      * information.
@@ -214,8 +208,8 @@ namespace Functions
      *
      * @note When using this function on a
      * parallel::distributed::Triangulation you may get an exception when
-     * trying to evaluate the solution at a point that does not lie in a
-     * locally owned cell (see
+     * trying to evaluate the solution at a point that lies on an artificial
+     * cell (see
      * @ref GlossLocallyOwnedCell).
      * See the section in the general documentation of this class for more
      * information.
@@ -232,8 +226,8 @@ namespace Functions
      *
      * @note When using this function on a
      * parallel::distributed::Triangulation you may get an exception when
-     * trying to evaluate the solution at a point that does not lie in a
-     * locally owned cell (see
+     * trying to evaluate the solution at a point that lies on an artificial
+     * cell (see
      * @ref GlossLocallyOwnedCell).
      * See the section in the general documentation of this class for more
      * information.
@@ -252,8 +246,8 @@ namespace Functions
      *
      * @note When using this function on a
      * parallel::distributed::Triangulation you may get an exception when
-     * trying to evaluate the solution at a point that does not lie in a
-     * locally owned cell (see
+     * trying to evaluate the solution at a point that lies on an artificial
+     * cell (see
      * @ref GlossLocallyOwnedCell).
      * See the section in the general documentation of this class for more
      * information.
@@ -270,8 +264,8 @@ namespace Functions
      *
      * @note When using this function on a
      * parallel::distributed::Triangulation you may get an exception when
-     * trying to evaluate the solution at a point that does not lie in a
-     * locally owned cell (see
+     * trying to evaluate the solution at a point that lies on an artificial
+     * cell (see
      * @ref GlossLocallyOwnedCell).
      * See the section in the general documentation of this class for more
      * information.
@@ -289,8 +283,8 @@ namespace Functions
      *
      * @note When using this function on a
      * parallel::distributed::Triangulation you may get an exception when
-     * trying to evaluate the solution at a point that does not lie in a
-     * locally owned cell (see
+     * trying to evaluate the solution at a point that lies on an artificial
+     * cell (see
      * @ref GlossLocallyOwnedCell).
      * See the section in the general documentation of this class for more
      * information.
@@ -305,8 +299,8 @@ namespace Functions
      *
      * @note When using this function on a
      * parallel::distributed::Triangulation you may get an exception when
-     * trying to evaluate the solution at a point that does not lie in a
-     * locally owned cell (see
+     * trying to evaluate the solution at a point that lies on an artificial
+     * cell (see
      * @ref GlossLocallyOwnedCell).
      * See the section in the general documentation of this class for more
      * information.
@@ -323,8 +317,8 @@ namespace Functions
      *
      * @note When using this function on a
      * parallel::distributed::Triangulation you may get an exception when
-     * trying to evaluate the solution at a point that does not lie in a
-     * locally owned cell (see
+     * trying to evaluate the solution at a point that lies on an artificial
+     * cell (see
      * @ref GlossLocallyOwnedCell).
      * See the section in the general documentation of this class for more
      * information.
@@ -340,8 +334,8 @@ namespace Functions
      *
      * @note When using this function on a
      * parallel::distributed::Triangulation you may get an exception when
-     * trying to evaluate the solution at a point that does not lie in a
-     * locally owned cell (see
+     * trying to evaluate the solution at a point that lies on an artificial
+     * cell (see
      * @ref GlossLocallyOwnedCell).
      * See the section in the general documentation of this class for more
      * information.
@@ -356,8 +350,8 @@ namespace Functions
      *
      * @note When using this function on a
      * parallel::distributed::Triangulation you may get an exception when
-     * trying to evaluate the solution at a point that does not lie in a
-     * locally owned cell (see
+     * trying to evaluate the solution at a point that lies on an artificial
+     * cell (see
      * @ref GlossLocallyOwnedCell).
      * See the section in the general documentation of this class for more
      * information.
@@ -371,8 +365,8 @@ namespace Functions
      *
      * @note When using this function on a
      * parallel::distributed::Triangulation you may get an exception when
-     * trying to evaluate the solution at a point that does not lie in a
-     * locally owned cell (see
+     * trying to evaluate the solution at a point that lies on an artificial
+     * cell (see
      * @ref GlossLocallyOwnedCell).
      * See the section in the general documentation of this class for more
      * information.
@@ -387,8 +381,8 @@ namespace Functions
      *
      * @note When using this function on a
      * parallel::distributed::Triangulation you may get an exception when
-     * trying to evaluate the solution at a point that does not lie in a
-     * locally owned cell (see
+     * trying to evaluate the solution at a point that lies on an artificial
+     * cell (see
      * @ref GlossLocallyOwnedCell).
      * See the section in the general documentation of this class for more
      * information.

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.