From: David Wells Date: Mon, 7 Dec 2015 01:30:58 +0000 (-0500) Subject: Improve docs for distribute_sparsity_pattern. X-Git-Tag: v8.4.0-rc2~174^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c237ea30f4d6d2f26009c66c49f972a8a5f6e21f;p=dealii.git Improve docs for distribute_sparsity_pattern. --- diff --git a/include/deal.II/lac/sparsity_tools.h b/include/deal.II/lac/sparsity_tools.h index 9a0a1d1938..68b3190b01 100644 --- a/include/deal.II/lac/sparsity_tools.h +++ b/include/deal.II/lac/sparsity_tools.h @@ -174,21 +174,23 @@ namespace SparsityTools /** * Communicate rows in a dynamic sparsity pattern over MPI. * - * @param dsp is a dynamic sparsity pattern that has been built locally and - * for which we need to exchange entries with other processors to make sure - * that each processor knows all the elements of the rows of a matrix it - * stores and that may eventually be written to. This sparsity pattern will - * be changed as a result of this function: All entries in rows that belong - * to a different processor are sent to them and added there. + * @param dsp A dynamic sparsity pattern that has been built locally and for + * which we need to exchange entries with other processors to make sure that + * each processor knows all the elements of the rows of a matrix it stores + * and that may eventually be written to. This sparsity pattern will be + * changed as a result of this function: All entries in rows that belong to + * a different processor are sent to them and added there. * - * @param rows_per_cpu determines ownership of rows. + * @param rows_per_cpu A vector containing the number of of rows per CPU for + * determining ownership. This is typically the value returned by + * DoFHandler::locally_owned_dofs_per_processor. * - * @param mpi_comm is the MPI communicator that is shared between the - * processors that all participate in this operation. + * @param mpi_comm The MPI communicator shared between the processors that + * participate in this operation. * - * @param myrange indicates the range of elements stored locally and should - * be the one used in the constructor of the DynamicSparsityPattern. This - * should be the locally relevant set. Only rows contained in myrange are + * @param myrange The range of elements stored locally. This should be the + * one used in the constructor of the DynamicSparsityPattern, and should + * also be the locally relevant set. Only rows contained in myrange are * checked in dsp for transfer. This function needs to be used with * PETScWrappers::MPI::SparseMatrix for it to work correctly in a parallel * computation. @@ -200,10 +202,13 @@ namespace SparsityTools const IndexSet &myrange); /** - * similar to the function above, but for BlockDynamicSparsityPattern - * instead. @p owned_set_per_cpu is typically - * DoFHandler::locally_owned_dofs_per_processor and @p myrange is - * locally_relevant_dofs. + * Similar to the function above, but for BlockDynamicSparsityPattern + * instead. + + * @param owned_set_per_cpu Typically the value given by + * DoFHandler::locally_owned_dofs_per_processor. + * + * @param myrange Typically the locally relevant DoFs. */ void distribute_sparsity_pattern (BlockDynamicSparsityPattern &dsp,