From: Fabian Castelli <50630942+gfcas@users.noreply.github.com>
Date: Sun, 15 May 2022 09:07:17 +0000 (+0200)
Subject: Apply constant_modes doc review
X-Git-Tag: v9.4.0-rc1~144^2~1
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3023327481834bfa12e9fe2c752d05dbd0bdbd5b;p=dealii.git

Apply constant_modes doc review

Co-authored-by: Wolfgang Bangerth <bangerth@colostate.edu>
---

diff --git a/include/deal.II/lac/trilinos_precondition.h b/include/deal.II/lac/trilinos_precondition.h
index 1ca08b46a4..1c5ae1061d 100644
--- a/include/deal.II/lac/trilinos_precondition.h
+++ b/include/deal.II/lac/trilinos_precondition.h
@@ -1493,15 +1493,21 @@ namespace TrilinosWrappers
        * Specifies the constant modes (near null space) of the matrix. This
        * parameter tells AMG whether we work on a scalar equation (where the
        * near null space only consists of ones, and default value is OK) or on
-       * a vector-valued equation. For vector-valued equation problem with
-       * <tt>n_component</tt>, the provided @p constant_modes should fulfill
-       * the following requirements:
+       * a vector-valued equation. For vector-valued problem with
+       * <tt>n_components</tt> components, the provided @p constant_modes
+       * should fulfill the following requirements:
        * <ul>
-       * <li>  <tt>constant_modes.size() == n_component</tt> </li>
-       * <li>  <tt>constant_modes[*].size() == n_dof_local</tt> or
-       *       <tt>constant_modes[*].size() == n_dof_global</tt> </li>
-       * <li>  <tt>constant_modes[ic][id] == id</tt><em>th</em> DoF is
-       *       corresponding to component <tt>ic</tt>
+       * <li>  <tt>constant_modes.size() == n_components</tt> </li>
+       * <li>  <tt>constant_modes[*].size()</tt> needs to be equal to either
+       *       the total number of degrees of freedom associated with the linear
+       *       system (<tt>constant_modes[*].size() == n_dofs</tt>), or the
+       *       number of locally owned degrees of freedom
+       *       (<tt>constant_modes[*].size() == n_locally_owned_dofs</tt>). In
+       *       parallel computations, the latter is the more appropriate choice
+       *       since one does not want to store vectors of global size on
+       *       individual processes. </li>
+       * <li>  <tt>constant_modes[ic][id] == true</tt> if DoF <tt>id</tt> is a
+       *       degree of freedom that is part of vector component <tt>ic</tt>.
        * </li>
        * </ul>
        */