]> https://gitweb.dealii.org/ - dealii.git/commitdiff
clarify docu of MatrixFree::initialize_dof_vector() 13481/head
authorNiklas Fehn <fehn@lnm.mw.tum.de>
Wed, 2 Mar 2022 14:39:28 +0000 (15:39 +0100)
committerNiklas Fehn <fehn@lnm.mw.tum.de>
Wed, 2 Mar 2022 14:40:33 +0000 (15:40 +0100)
include/deal.II/matrix_free/matrix_free.h

index 5c456917b885dc12e1c5bc4c7e60231ba8ed45bf..043d331fe20ff5aafec3b53eccda00abc199f627 100644 (file)
@@ -1523,11 +1523,10 @@ public:
 
   /**
    * Initialize function for a general vector. The length of the vector is
-   * equal to the total number of degrees in the DoFHandler. If the vector is
-   * of class LinearAlgebra::distributed::Vector@<Number@>, the ghost entries
-   * are set accordingly. For vector-valued problems with several DoFHandlers
-   * underlying this class, the parameter @p vector_component defines which
-   * component is to be used.
+   * equal to the total number of degrees in the DoFHandler. Vector entries
+   * are initialized with zero. For vector-valued problems with several
+   * DoFHandlers underlying this class, the parameter @p vector_component
+   * defines which component is to be used.
    *
    * For the vectors used with MatrixFree and in FEEvaluation, a vector needs
    * to hold all
@@ -1547,24 +1546,10 @@ public:
                         const unsigned int dof_handler_index = 0) const;
 
   /**
-   * Initialize function for a distributed vector. The length of the vector is
-   * equal to the total number of degrees in the DoFHandler. If the vector is
-   * of class LinearAlgebra::distributed::Vector@<Number@>, the ghost entries
-   * are set accordingly. For vector-valued problems with several DoFHandlers
-   * underlying this class, the parameter @p vector_component defines which
-   * component is to be used.
+   * See the other function with the same name for descriptions.
    *
-   * For the vectors used with MatrixFree and in FEEvaluation, a vector needs
-   * to hold all
-   * @ref GlossLocallyActiveDof "locally active DoFs"
-   * and also some of the
-   * @ref GlossLocallyRelevantDof "locally relevant DoFs".
-   * The selection of DoFs is such that one can read all degrees of freedom on
-   * all locally relevant elements (locally active) plus the degrees of freedom
-   * that constraints expand into from the locally owned cells. However, not
-   * all locally relevant DoFs are stored because most of them would never be
-   * accessed in matrix-vector products and result in too much data sent
-   * around which impacts the performance.
+   * Since the vector is of class LinearAlgebra::distributed::Vector@<Number@>,
+   * the ghost entries are set accordingly.
    */
   template <typename Number2>
   void

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.