From: bangerth Date: Tue, 24 Nov 2009 03:25:41 +0000 (+0000) Subject: Augment documentation. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7e908c94e95171bfd09185c1c15f059d3e3e0a7b;p=dealii-svn.git Augment documentation. git-svn-id: https://svn.dealii.org/trunk@20159 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/deal.II/include/fe/mapping.h b/deal.II/deal.II/include/fe/mapping.h index 3e57fe9a1d..c0cf593ffb 100644 --- a/deal.II/deal.II/include/fe/mapping.h +++ b/deal.II/deal.II/include/fe/mapping.h @@ -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 + * cell-@>vertex(). + * + * For example, implementations in + * derived classes return @p true for * MappingQ, MappingQ1, MappingCartesian, * but @p false for MappingQEulerian, * MappingQ1Eulerian. diff --git a/deal.II/deal.II/include/fe/mapping_q1_eulerian.h b/deal.II/deal.II/include/fe/mapping_q1_eulerian.h index 0077db0097..475c179f84 100644 --- a/deal.II/deal.II/include/fe/mapping_q1_eulerian.h +++ b/deal.II/deal.II/include/fe/mapping_q1_eulerian.h @@ -123,8 +123,11 @@ class MappingQ1Eulerian : public MappingQ1 /** * 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;