From: Wolfgang Bangerth Date: Sun, 23 Jul 2017 07:09:08 +0000 (-0600) Subject: Minor doc updates to a couple of classes. X-Git-Tag: v9.0.0-rc1~1394^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F4647%2Fhead;p=dealii.git Minor doc updates to a couple of classes. --- diff --git a/include/deal.II/grid/tria_accessor.h b/include/deal.II/grid/tria_accessor.h index 01fe5af177..664cfc970b 100644 --- a/include/deal.II/grid/tria_accessor.h +++ b/include/deal.II/grid/tria_accessor.h @@ -579,6 +579,9 @@ public: * $R^{dim}$, for spacedim@>dim the triangulation is of a * manifold embedded in a higher dimensional space). * + * There is a specialization of this class for the case where + * @p structdim equals zero, i.e., for vertices of a triangulation. + * * @ingroup Accessors * @author Wolfgang Bangerth and others, 1998, 2000, 2008 */ @@ -1540,8 +1543,9 @@ private: /** - * Specialization of TriaAccessor. This - * class represent vertices in a triangulation of dimensionality + * This class is a specialization of TriaAccessor + * for the case that @p structdim is zero. This + * class represents vertices in a triangulation of dimensionality * dim (i.e. 1 for a triangulation of lines, 2 for a * triangulation of quads, and 3 for a triangulation of hexes) that is * embedded in a space of dimensionality spacedim (for @@ -1549,6 +1553,10 @@ private: * ${\mathbb R}^\text{dim}$, for spacedim@>dim the triangulation * is of a manifold embedded in a higher dimensional space). * + * There is a further specialization of this class for the case that + * @p dim equals one, i.e., for vertices of a one-dimensional triangulation, + * since in that case vertices are also faces. + * * @ingroup Accessors * @author Bruno Turcksin, 2015 */ @@ -1892,10 +1900,17 @@ private: /** - * A class that represents an access to a face in 1d -- i.e. to a point. This - * is not a full fledged access from which you can build an iterator: for - * example, you can't iterate from one such point to the next. Point also - * don't have children, and they don't have neighbors. + * This class is a specialization of TriaAccessor + * for the case that @p structdim is zero and @p dim is one. This + * class represents vertices in a one-dimensional triangulation that is + * embedded in a space of dimensionality spacedim (for + * spacedim==dim==1 the triangulation represents a domain in + * ${\mathbb R}^\text{dim}$, for spacedim@>dim==1 the triangulation + * is of a manifold embedded in a higher dimensional space). + * + * The current specialization of the TriaAccessor<0,dim,spacedim> class + * for vertices of a one-dimensional triangulation exists + * since in the @p dim == 1 case vertices are also faces. * * @ingroup Accessors * @author Wolfgang Bangerth, 2010