From: bangerth Date: Fri, 28 Jul 2006 16:04:43 +0000 (+0000) Subject: Fix outdated docs X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7764fefd7bb94b75b257828d85ffab68958cbd6e;p=dealii-svn.git Fix outdated docs git-svn-id: https://svn.dealii.org/trunk@13471 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/deal.II/include/dofs/dof_handler.h b/deal.II/deal.II/include/dofs/dof_handler.h index d5f3c99f99..07bc3d53af 100644 --- a/deal.II/deal.II/include/dofs/dof_handler.h +++ b/deal.II/deal.II/include/dofs/dof_handler.h @@ -231,25 +231,37 @@ class DoFHandler : public Subscriptor */ virtual void clear (); - /** - * Actually do the renumbering based on - * a list of new dof numbers for all the - * dofs. - * - * @p new_numbers is an array of integers - * with size equal to the number of dofs - * on the present grid. It stores the new - * indices after renumbering in the - * order of the old indices. - * - * This function is called by the - * @p renumber_dofs function after computing - * the ordering of the degrees of freedom. - * However, you can call this function - * yourself, which is necessary if a user - * wants to implement an ordering scheme - * herself, for example downwind numbering. - */ + /** + * Renumber degrees of freedom based on + * a list of new dof numbers for all the + * dofs. + * + * @p new_numbers is an array of integers + * with size equal to the number of dofs + * on the present grid. It stores the new + * indices after renumbering in the + * order of the old indices. + * + * This function is called by + * the functions in + * DoFRenumbering function + * after computing the ordering + * of the degrees of freedom. + * However, you can call this + * function yourself, which is + * necessary if a user wants to + * implement an ordering scheme + * herself, for example + * downwind numbering. + * + * The @p new_number array must + * have a size equal to the + * number of degrees of + * freedom. Each entry must + * state the new global DoF + * number of the degree of + * freedom referenced. + */ void renumber_dofs (const std::vector &new_numbers); /**