From 67ff99c90fc183b57d0ba2638bd1cfc6d310a143 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Thu, 12 Jan 2006 20:50:23 +0000 Subject: [PATCH] Use a documentation style that doxygen gets along with. Previously, it got caught up with the DoFLevels<1> documentation and didn't generate documentation for any of the rest of the file. git-svn-id: https://svn.dealii.org/trunk@12007 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/deal.II/include/dofs/hp_dof_levels.h | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/deal.II/deal.II/include/dofs/hp_dof_levels.h b/deal.II/deal.II/include/dofs/hp_dof_levels.h index da1f2af56b..1908a3bb18 100644 --- a/deal.II/deal.II/include/dofs/hp_dof_levels.h +++ b/deal.II/deal.II/include/dofs/hp_dof_levels.h @@ -81,9 +81,9 @@ namespace hp * Store the indices of the degrees of freedom which are located on * the lines. * - * @sect3{Information for all DoFLevel() classes} + * @sect3{Information for all DoFLevel classes} * - * The DoFLevel() classes + * The DoFLevel classes * store the global indices of the degrees of freedom for each cell on a * certain level. The index or number of a degree of freedom is the zero-based * index of the according value in the solution vector and the row and column @@ -96,19 +96,19 @@ namespace hp * be viewed as the index into a block vector, where each block contains the * different values according to a degree of freedom. It is left to the derived * classes, whether the values in a block are stored consecutively or distributed - * (e.g. if the solution function is $u=(u_1, u_2)$, we could store the values + * (e.g. if the solution function is u=(u_1, u_2), we could store the values * in the solution vector like - * $\ldots, u_1^m, u_2^m, u_1^{m+1}, u_2^{m+1},\ldots$ with $m$ denoting the - * $m$th basis function, or $\ldots, u_1^m, u_1^{m+1}, u_1^{m+2}, \ldots, - * u_2^m, u_2^{m+1}, u_2^{m+2}, \ldots$, respectively). Likewise, the - * constraint matrix returned by DoFHandler::make_hanging_node_constraints () - * is then - * to be understood as a block matrix. + * \f[\ldots, u_1^m, u_2^m, u_1^{m+1}, u_2^{m+1},\ldots\f] with m denoting the + * m-th basis function, or + * \f[\ldots, u_1^m, u_1^{m+1}, u_1^{m+2}, \ldots, u_2^m, u_2^{m+1}, u_2^{m+2}, \ldots,\f] + * respectively). Likewise, the constraint matrix returned by + * DoFHandler::make_hanging_node_constraints () + * is then to be understood as a block matrix. * * The storage format of the degrees of freedom indices (short: DoF * indices) is somewhat like a mirror of the data structures of the * triangulation classes. There is a hierarchy of - * DoFLevel() classes for the different dimensions which + * DoFLevel classes for the different dimensions which * have objects named @p line_dofs, @p quad_dofs and so on, in which * the indices of DoFs located on lines and quads, respectively, are * stored. The indices are stored levelwise. -- 2.39.5