From ec244b409ade85345e2153638a1044e15179333d Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Sun, 16 Aug 2015 15:46:55 -0500 Subject: [PATCH] Some minor doc updates. --- include/deal.II/fe/mapping.h | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/include/deal.II/fe/mapping.h b/include/deal.II/fe/mapping.h index e4e00988ca..e2dbd34272 100644 --- a/include/deal.II/fe/mapping.h +++ b/include/deal.II/fe/mapping.h @@ -258,19 +258,30 @@ public: Mapping *clone () const = 0; /** - * Return the mapped vertices of a cell. These values are not equal to the - * vertex coordinates stored by the triangulation for MappingQEulerian and - * MappingQ1Eulerian. + * Return the mapped vertices of a cell. + * + * Most of the time, these values will simply be the coordinates of the + * vertices of a cell as returned by cell-@>vertex(v) for + * vertex v, i.e., information stored by the triangulation. + * However, there are also mappings that add displacements or choose + * completely different locations, e.g., MappingQEulerian, + * MappingQ1Eulerian, or MappingFEField. + * + * The default implementation of this function simply returns the + * information stored by the triangulation, i.e., + * cell-@>vertex(v). */ virtual std_cxx11::array, GeometryInfo::vertices_per_cell> get_vertices (const typename Triangulation::cell_iterator &cell) const; /** - * Returns whether the mapping preserves vertex locations, i.e., whether the + * Returns whether the mapping preserves vertex locations. In other + * words, this function returns whether the * mapped location of the reference cell vertices (given by * GeometryInfo::unit_cell_vertex()) equals the result of - * cell-@>vertex(). + * cell-@>vertex() (i.e., information stored by the + * triangulation). * * For example, implementations in derived classes return @p true for * MappingQ, MappingQ1, MappingCartesian, but @p false for MappingQEulerian, @@ -536,8 +547,7 @@ protected: * instead, from which the determinant can also be computed -- but * this does not take away from the instructiveness of the example.) * - * See - * @ref UpdateFlagsEssay. + * @see UpdateFlagsEssay */ virtual UpdateFlags -- 2.39.5