]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Augment documentation.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Tue, 24 Nov 2009 03:25:41 +0000 (03:25 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Tue, 24 Nov 2009 03:25:41 +0000 (03:25 +0000)
git-svn-id: https://svn.dealii.org/trunk@20159 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/fe/mapping.h
deal.II/deal.II/include/fe/mapping_q1_eulerian.h

index 3e57fe9a1d31b9eda38d5b3636c95ed4241fd6ab..c0cf593ffb18c62281dd9aebf4bf408fd67847b2 100644 (file)
@@ -445,7 +445,15 @@ class Mapping : public Subscriptor
     
                                     /**
                                      * Returns whether the mapping preserves
-                                     * vertex locations. Returns @p true for
+                                     * vertex locations, i.e. whether the
+                                     * mapped location of the reference cell
+                                     * vertices (given by
+                                     * GeometryInfo::unit_cell_vertex())
+                                     * equals the result of
+                                     * <code>cell-@>vertex()</code>.
+                                     *
+                                     * For example, implementations in
+                                     * derived classes return @p true for
                                      * MappingQ, MappingQ1, MappingCartesian,
                                      * but @p false for MappingQEulerian,
                                      * MappingQ1Eulerian.
index 0077db0097e6da38e6aa252bd43d932669d143ef..475c179f845a51f42d3583b9262e56332ea8f45e 100644 (file)
@@ -123,8 +123,11 @@ class MappingQ1Eulerian : public MappingQ1<dim,spacedim>
 
                                     /**
                                      * Always returns @p false because
-                                     * MappingQ1Eulerian does not preserve
-                                     * vertex locations.
+                                     * MappingQ1Eulerian does not in general
+                                     * preserve vertex locations (unless the
+                                     * translation vector happens to provide
+                                     * for zero displacements at vertex
+                                     * locations).
                                      */
     bool preserves_vertex_locations () const;
 

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.