]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fix (serial) PETSc vector documentation.
authorDavid Wells <wellsd2@rpi.edu>
Sat, 29 Apr 2017 17:16:04 +0000 (13:16 -0400)
committerDavid Wells <wellsd2@rpi.edu>
Thu, 4 May 2017 01:45:42 +0000 (21:45 -0400)
This commit fixes up some old text which implied that we had to use either
serial PETSc vectors or PETSc vectors for computations: since we support more
than just PETSc these days we can generalize a bit.

include/deal.II/fe/fe_tools.h
include/deal.II/fe/fe_values.h
include/deal.II/lac/block_vector_base.h
include/deal.II/lac/petsc_parallel_block_sparse_matrix.h
include/deal.II/lac/vector.h

index 3f5309769578db4553fe39c577b823e637d74fde..37b9ffed1fd999e2b51b6f8109cc7429166db169 100644 (file)
@@ -704,8 +704,8 @@ namespace FETools
    * elements on grids with hanging nodes (locally refined grids) are
    * involved.
    *
-   * For parallel computations with PETSc, supply @p z1 with ghost elements
-   * and @p z1_difference without ghost elements.
+   * For parallel computations, supply @p z1 with ghost elements and @p
+   * z1_difference without ghost elements.
    */
   template <int dim, class InVector, class OutVector, int spacedim>
   void interpolation_difference(const DoFHandler<dim,spacedim> &dof1,
index 564685705f6947112741d20b3d84b64274a3cc17..6e20e8dbf002073ad62b815ef8f04cbe3591ce62 100644 (file)
@@ -1700,12 +1700,12 @@ public:
    * described by fe_function at the $q$th quadrature point.
    *
    * @note The actual data type of the input vector may be either a
-   * Vector&lt;T&gt;, BlockVector&lt;T&gt;, or one of the sequential PETSc or
-   * Trilinos vector wrapper classes. It represents a global vector of DoF
-   * values associated with the DofHandler object with which this FEValues
-   * object was last initialized. Alternatively, if the vector argument is of
-   * type IndexSet, then the function is represented as one that is either
-   * zero or one, depending on whether a DoF index is in the set or not.
+   * Vector&lt;T&gt;, BlockVector&lt;T&gt;, or one of the PETSc or Trilinos
+   * vector wrapper classes. It represents a global vector of DoF values
+   * associated with the DoFHandler object with which this FEValues object was
+   * last initialized. Alternatively, if the vector argument is of type
+   * IndexSet, then the function is represented as one that is either zero or
+   * one, depending on whether a DoF index is in the set or not.
    *
    * @dealiiRequiresUpdateFlags{update_values}
    */
@@ -1849,12 +1849,12 @@ public:
    * direction $d$ at quadrature point $q$.
    *
    * @note The actual data type of the input vector may be either a
-   * Vector&lt;T&gt;, BlockVector&lt;T&gt;, or one of the sequential PETSc or
-   * Trilinos vector wrapper classes. It represents a global vector of DoF
-   * values associated with the DoFHandler object with which this FEValues
-   * object was last initialized. Alternatively, if the vector argument is of
-   * type IndexSet, then the function is represented as one that is either
-   * zero or one, depending on whether a DoF index is in the set or not.
+   * Vector&lt;T&gt;, BlockVector&lt;T&gt;, or one of the PETSc or Trilinos
+   * vector wrapper classes. It represents a global vector of DoF values
+   * associated with the DoFHandler object with which this FEValues object was
+   * last initialized. Alternatively, if the vector argument is of type
+   * IndexSet, then the function is represented as one that is either zero or
+   * one, depending on whether a DoF index is in the set or not.
    *
    * @dealiiRequiresUpdateFlags{update_gradients}
    */
@@ -1939,12 +1939,12 @@ public:
    * matrix of second derivatives at quadrature point $q$.
    *
    * @note The actual data type of the input vector may be either a
-   * Vector&lt;T&gt;, BlockVector&lt;T&gt;, or one of the sequential PETSc or
-   * Trilinos vector wrapper classes. It represents a global vector of DoF
-   * values associated with the DofHandler object with which this FEValues
-   * object was last initialized. Alternatively, if the vector argument is of
-   * type IndexSet, then the function is represented as one that is either
-   * zero or one, depending on whether a DoF index is in the set or not.
+   * Vector&lt;T&gt;, BlockVector&lt;T&gt;, or one of the PETSc or Trilinos
+   * vector wrapper classes. It represents a global vector of DoF values
+   * associated with the DoFHandler object with which this FEValues object was
+   * last initialized. Alternatively, if the vector argument is of type
+   * IndexSet, then the function is represented as one that is either zero or
+   * one, depending on whether a DoF index is in the set or not.
    *
    * @dealiiRequiresUpdateFlags{update_hessians}
    */
@@ -2032,12 +2032,12 @@ public:
    * would be the output of the get_function_hessians() function.
    *
    * @note The actual data type of the input vector may be either a
-   * Vector&lt;T&gt;, BlockVector&lt;T&gt;, or one of the sequential PETSc or
-   * Trilinos vector wrapper classes. It represents a global vector of DoF
-   * values associated with the DofHandler object with which this FEValues
-   * object was last initialized. Alternatively, if the vector argument is of
-   * type IndexSet, then the function is represented as one that is either
-   * zero or one, depending on whether a DoF index is in the set or not.
+   * Vector&lt;T&gt;, BlockVector&lt;T&gt;, or one of the PETSc or Trilinos
+   * vector wrapper classes. It represents a global vector of DoF values
+   * associated with the DoFHandler object with which this FEValues object was
+   * last initialized. Alternatively, if the vector argument is of type
+   * IndexSet, then the function is represented as one that is either zero or
+   * one, depending on whether a DoF index is in the set or not.
    *
    * @dealiiRequiresUpdateFlags{update_hessians}
    */
@@ -2142,12 +2142,12 @@ public:
    * quadrature point $q$.
    *
    * @note The actual data type of the input vector may be either a
-   * Vector&lt;T&gt;, BlockVector&lt;T&gt;, or one of the sequential PETSc or
-   * Trilinos vector wrapper classes. It represents a global vector of DoF
-   * values associated with the DofHandler object with which this FEValues
-   * object was last initialized. Alternatively, if the vector argument is of
-   * type IndexSet, then the function is represented as one that is either
-   * zero or one, depending on whether a DoF index is in the set or not.
+   * Vector&lt;T&gt;, BlockVector&lt;T&gt;, or one of the PETSc or Trilinos
+   * vector wrapper classes. It represents a global vector of DoF values
+   * associated with the DoFHandler object with which this FEValues object was
+   * last initialized. Alternatively, if the vector argument is of type
+   * IndexSet, then the function is represented as one that is either zero or
+   * one, depending on whether a DoF index is in the set or not.
    *
    * @dealiiRequiresUpdateFlags{update_3rd_derivatives}
    */
index 668066644c902d8525e3977e96ca3c7179ada289..8b9bfa18955c6256b4d1936abb10239c47c84d87 100644 (file)
@@ -474,9 +474,9 @@ namespace internal
 /**
  * A vector composed of several blocks each representing a vector of its own.
  *
- * The BlockVector is a collection of Vectors (e.g. of either deal.II Vector
- * objects or PETScWrappers::Vector object). Each of the vectors inside can
- * have a different size.
+ * The BlockVector is a collection of vectors of a given type (e.g., deal.II
+ * Vector objects, PETScWrappers::MPI::Vector objects, etc.). Each of the
+ * vectors inside can have a different size.
  *
  * The functionality of BlockVector includes everything a Vector can do, plus
  * the access to a single Vector inside the BlockVector by <tt>block(i)</tt>.
@@ -931,15 +931,8 @@ public:
             const value_type b, const BlockVectorBase &W);
 
   /**
-   * This function does nothing but is there for compatibility with the @p
-   * PETScWrappers::Vector class.
-   *
-   * For the PETSc vector wrapper class, this function updates the ghost
-   * values of the PETSc vector. This is necessary after any modification
-   * before reading ghost values.
-   *
-   * However, for the implementation of this class, it is immaterial and thus
-   * an empty function.
+   * Update the ghost values by calling <code>update_ghost_values</code> for
+   * each block.
    */
   void update_ghost_values () const;
 
index c0d4ec2fc2873fd622d1421f762827d2af17229f..e0c80e7ff217bb26cf14dac2ed1c9ea8119c5ed8 100644 (file)
@@ -43,11 +43,11 @@ namespace PETScWrappers
      */
 
     /**
-     * Blocked sparse matrix based on the PETScWrappers::SparseMatrix class.
-     * This class implements the functions that are specific to the PETSc
-     * SparseMatrix base objects for a blocked sparse matrix, and leaves the
-     * actual work relaying most of the calls to the individual blocks to the
-     * functions implemented in the base class. See there also for a
+     * Blocked sparse matrix based on the PETScWrappers::MPI::SparseMatrix
+     * class. This class implements the functions that are specific to the
+     * PETSc SparseMatrix base objects for a blocked sparse matrix, and leaves
+     * the actual work relaying most of the calls to the individual blocks to
+     * the functions implemented in the base class. See there also for a
      * description of when this class is useful.
      *
      * In contrast to the deal.II-type SparseMatrix class, the PETSc matrices
index 8eb4c59eac4c82b43a5e2ebac7c9f05d563a62ac..f63389c22ba0bc326b69fa3ab8a10024e0223e48 100644 (file)
@@ -808,15 +808,8 @@ public:
               const Vector<Number> &b) DEAL_II_DEPRECATED;
 
   /**
-   * This function does nothing but is there for compatibility with the @p
-   * PETScWrappers::Vector class.
-   *
-   * For the PETSc vector wrapper class, this function updates the ghost
-   * values of the PETSc vector. This is necessary after any modification
-   * before reading ghost values.
-   *
-   * However, for the implementation of this class, it is immaterial and thus
-   * an empty function.
+   * This function does nothing but exists for compatibility with the @p
+   * parallel vector classes (e.g., LinearAlgebra::distributed::Vector class).
    */
   void update_ghost_values () const;
   //@}

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.