From 6461bb7092b2dc18745afadb29f248de434475f6 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Sat, 13 Feb 2016 07:23:28 -0600 Subject: [PATCH] Update documentation. --- include/deal.II/dofs/dof_accessor.h | 33 +++++++++++++++++++++++++++-- 1 file changed, 31 insertions(+), 2 deletions(-) diff --git a/include/deal.II/dofs/dof_accessor.h b/include/deal.II/dofs/dof_accessor.h index 1f3f7fabb8..d103013ec8 100644 --- a/include/deal.II/dofs/dof_accessor.h +++ b/include/deal.II/dofs/dof_accessor.h @@ -176,6 +176,22 @@ namespace internal * There is a DoFCellAccessor class that provides the equivalent to the * CellAccessor class. * + * @tparam structdim The dimensionality of the objects the accessor + * represents. For example, points have @p structdim equal to zero, + * edges have @structdim equal to one, etc. + * @tparam DoFHandlerType The type of the DoF handler into which accessor + * of this type point. This is either the DoFHandler or hp::DoFHandler + * class. See also the @ref ConceptDoFHandlerType "DoFHandlerType concept". + * @tparam level_dof_access If @p false, then the accessor simply represents + * a cell, face, or edge in a DoFHandler for which degrees of freedom only + * exist on the finest level. Some operations are not allowed in this case, + * such as asking for DoF indices on non-active cells. On the other hand, + * if this template argument is @p true, then the accessor represents an + * object in a multilevel hierarchy of degrees of freedom. In this case, + * accessing DoF indices of any cell is possible, and will return + * the level indices (which, for active cells, may be different + * from the global indices). + * * @ingroup dofs * @ingroup Accessors * @author Wolfgang Bangerth, 1998, 2006, 2008, Timo Heister, Guido Kanschat, @@ -224,12 +240,25 @@ public: DoFAccessor (); /** - * Constructor + * Constructor that generates an access that points to a particular cell or + * face or edge in a DoFHandler or hp::DoFHandler. + * + * @param tria The triangulation into which this accessor points. + * @param level The level within the mesh hierarchy of the object pointed + * to. For example, coarse mesh cells will have level zero, their children + * level one, and so on. This argument is ignored for faces and edges + * which do not have a level. + * @param index The index of the object pointed to within the specified + * refinement level. + * @param dof_handler A pointer to the DoFHandler or hp::DoFHandler object + * to which the accessor shall refer. This DoFHandler object must of + * course be built on the same triangulation as the one specified in + * the first argument. */ DoFAccessor (const Triangulation *tria, const int level, const int index, - const DoFHandlerType *local_data); + const DoFHandlerType *dof_handler); /** * Conversion constructor. This constructor exists to make certain -- 2.39.5