From: Denis Davydov Date: Sat, 16 Mar 2019 06:42:03 +0000 (+0100) Subject: adjust documentation and add a changelog X-Git-Tag: v9.1.0-rc1~242^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F7819%2Fhead;p=dealii.git adjust documentation and add a changelog --- diff --git a/doc/news/changes/minor/20190316DenisDavydov b/doc/news/changes/minor/20190316DenisDavydov new file mode 100644 index 0000000000..7d018538b7 --- /dev/null +++ b/doc/news/changes/minor/20190316DenisDavydov @@ -0,0 +1,3 @@ +Improved: DoFRenumbering::cell_wise() now support parallel::Triangulation . +
+(Denis Davydov, 2019/03/16) diff --git a/include/deal.II/dofs/dof_renumbering.h b/include/deal.II/dofs/dof_renumbering.h index 445fedd078..cfd8832837 100644 --- a/include/deal.II/dofs/dof_renumbering.h +++ b/include/deal.II/dofs/dof_renumbering.h @@ -838,10 +838,10 @@ namespace DoFRenumbering /** * Renumber degrees of freedom by cell. The function takes a vector of cell - * iterators (which needs to list all active cells of the DoF handler - * objects) and will give degrees of freedom new indices based on where in - * the given list of cells the cell is on which the degree of freedom is - * located. Degrees of freedom that exist at the interface between two or + * iterators (which needs to list all locally owned active cells of the + * DoF handler objects) and will give degrees of freedom new indices based on + * where in the given list of cells the cell is on which the degree of freedom + * is located. Degrees of freedom that exist at the interface between two or * more cells will be numbered when they are encountered first. * * Degrees of freedom that are encountered first on the same cell retain @@ -852,10 +852,12 @@ namespace DoFRenumbering * @param[in] cell_order A vector that contains the order of the cells that * defines the order in which degrees of freedom should be renumbered. * - * @pre @p cell_order must have size - * dof_handler.get_triangulation().n_active_cells(). Every - * active cell iterator of that triangulation needs to be present in @p - * cell_order exactly once. + * @pre for serial triangulation @p cell_order must have size + * dof_handler.get_triangulation().n_active_cells(), whereas + * in case of parallel triangulation its size should be + * parallel::Triangulation::n_locally_owned_active_cells(). Every active cell + * iterator of that triangulation needs to be present in @p cell_order exactly + * once. */ template void @@ -865,34 +867,38 @@ namespace DoFRenumbering /** * Compute a renumbering of degrees of freedom by cell. The function takes a - * vector of cell iterators (which needs to list all active cells of - * the DoF handler objects) and will give degrees of freedom new indices - * based on where in the given list of cells the cell is on which the degree - * of freedom is located. Degrees of freedom that exist at the interface - * between two or more cells will be numbered when they are encountered - * first. + * vector of cell iterators (which needs to list all locally owned + * active cells of the DoF handler objects) and will give degrees of freedom + * new indices based on where in the given list of cells the cell is on which + * the degree of freedom is located. Degrees of freedom that exist at the + * interface between two or more cells will be numbered when they are + * encountered first. * * Degrees of freedom that are encountered first on the same cell retain * their original ordering before the renumbering step. * * @param[out] renumbering A vector of length - * dof_handler.n_dofs() that contains for each degree of - * freedom (in their current numbering) their future DoF index. This vector - * therefore presents a (very particular) permutation of the current - * DoF indices. + * dof_handler.n_locally_owned_dofs() that contains for each + * degree of freedom (in their current numbering) their future DoF index. This + * vector therefore presents a (very particular) permutation of the + * current DoF indices. * @param[out] inverse_renumbering The reverse of the permutation returned - * in the previous argument. + * in the previous argument. In case of parallel::Triangulation the inverse + * is within locally owned DoFs. * @param[in] dof_handler The DoFHandler whose degrees of freedom are to be * renumbered. * @param[in] cell_order A vector that contains the order of the cells that * defines the order in which degrees of freedom should be renumbered. * - * @pre @p cell_order must have size - * dof_handler.get_triangulation().n_active_cells(). Every - * active cell iterator of that triangulation needs to be present in @p + * @pre for serial triangulation @p cell_order must have size + * dof_handler.get_triangulation().n_active_cells(), whereas + * in case of parallel triangulation its size should be + * parallel::Triangulation::n_locally_owned_active_cells(). Every active cell + * iterator of that triangulation needs to be present in @p * cell_order exactly once. @post For each @p i between zero and - * dof_handler.n_dofs(), the condition - * renumbering[inverse_renumbering[i]] == i will hold. + * dof_handler.n_locally_owned_dofs(), the condition + * renumbering[inverse_renumbering[i]] == + * dof_handler.locally_owned_dofs().nth_index_in_set(i) will hold. */ template void