From b9bef8c6741559e00c38aee59c7c6c6a31a7bd6e Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Tue, 31 Jan 2006 20:00:38 +0000 Subject: [PATCH] Doc update. git-svn-id: https://svn.dealii.org/trunk@12214 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/deal.II/include/dofs/dof_accessor.h | 27 ++++++--------------- 1 file changed, 8 insertions(+), 19 deletions(-) diff --git a/deal.II/deal.II/include/dofs/dof_accessor.h b/deal.II/deal.II/include/dofs/dof_accessor.h index 5e492a7e6c..dbe1c588af 100644 --- a/deal.II/deal.II/include/dofs/dof_accessor.h +++ b/deal.II/deal.II/include/dofs/dof_accessor.h @@ -46,26 +46,15 @@ template class TriaRawIterator; /** - * Define the basis for accessors to the degrees of freedom. + * Define the base class for accessors to the degrees of + * freedom. Accessors are used to, well, access the data that pertains + * to edges, faces, and cells of a triangulation. The concept is + * explained in more detail in connection to @ref Iterators. * - * Note that it is allowed to construct an object of which - * #dof_handler is a Null pointer. Such an object would - * result in a strange kind of behaviour, though every reasonable - * operating system should disallow access through that pointer. - * The reason we do not check for the null pointer in the - * constructor which gets passed the DoFHandler pointer is that - * if we did we could not make dof iterators member of other classes - * (like in the FEValues class) if we did not know about the - * DoFHandler object to be used upon construction of that object. - * Through the way this class is implemented here, we allow the - * creation of a kind of virgin object which only gets useful if - * assigned to from another object before first usage. - * - * Opposite to construction, it is not possible to copy an object - * which has an invalid dof handler pointer. This is to guarantee - * that every iterator which is once assigned to is a valid - * object. However, this assertion only holds in debug mode, when - * the #Assert macro is switched on. + * The first template argument of this class refers to the space + * dimension in which we work. The second one denotes the type of DoF + * handler we should work on. It can either be ::DoFHandler or + * hp::DoFHandler. * * @ingroup dofs * @ingroup Accessors -- 2.39.5