]> https://gitweb.dealii.org/ - dealii.git/commitdiff
doc TrilinosWrappers::PreconditionAMG::AdditionalData::constant_modes with more details
authorLei Qiao <qiaol618@gmail.com>
Thu, 8 Oct 2015 20:24:05 +0000 (15:24 -0500)
committerLei Qiao <qiaol618@gmail.com>
Thu, 8 Oct 2015 23:30:12 +0000 (18:30 -0500)
include/deal.II/lac/trilinos_precondition.h

index d1d60257563ed86d992e16ebec1c3393049389b1..836c9c26b8966c4ac720f758f1078c8e47e3957f 100644 (file)
@@ -1373,8 +1373,17 @@ 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) or on a vector-valued
-       * equation.
+       * 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:
+       * <ul>
+       * <li>  n_component.size() == <tt>n_component</tt> </li>
+       * <li>  n_component[*].size() == n_dof_local or
+       *       n_component[*].size() == n_dof_global </li>
+       * <li>  n_component[<tt>ic</tt>][<tt>id</tt>] == "<tt>id</tt><em>th</em>
+       *       DoF is corresponding to component <tt>ic</tt> </li>
+       * </ul>
        */
       std::vector<std::vector<bool> > constant_modes;
 

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.