From: David Wells Date: Sat, 29 Apr 2017 17:16:04 +0000 (-0400) Subject: Fix (serial) PETSc vector documentation. X-Git-Tag: v9.0.0-rc1~1627^2~1 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=282d606b9080c514dc0f6186c1bd3f12b350da19;p=dealii.git Fix (serial) PETSc vector documentation. 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. --- diff --git a/include/deal.II/fe/fe_tools.h b/include/deal.II/fe/fe_tools.h index 3f53097695..37b9ffed1f 100644 --- a/include/deal.II/fe/fe_tools.h +++ b/include/deal.II/fe/fe_tools.h @@ -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 void interpolation_difference(const DoFHandler &dof1, diff --git a/include/deal.II/fe/fe_values.h b/include/deal.II/fe/fe_values.h index 564685705f..6e20e8dbf0 100644 --- a/include/deal.II/fe/fe_values.h +++ b/include/deal.II/fe/fe_values.h @@ -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<T>, BlockVector<T>, 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<T>, BlockVector<T>, 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<T>, BlockVector<T>, 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<T>, BlockVector<T>, 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<T>, BlockVector<T>, 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<T>, BlockVector<T>, 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<T>, BlockVector<T>, 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<T>, BlockVector<T>, 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<T>, BlockVector<T>, 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<T>, BlockVector<T>, 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} */ diff --git a/include/deal.II/lac/block_vector_base.h b/include/deal.II/lac/block_vector_base.h index 668066644c..8b9bfa1895 100644 --- a/include/deal.II/lac/block_vector_base.h +++ b/include/deal.II/lac/block_vector_base.h @@ -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 block(i). @@ -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 update_ghost_values for + * each block. */ void update_ghost_values () const; diff --git a/include/deal.II/lac/petsc_parallel_block_sparse_matrix.h b/include/deal.II/lac/petsc_parallel_block_sparse_matrix.h index c0d4ec2fc2..e0c80e7ff2 100644 --- a/include/deal.II/lac/petsc_parallel_block_sparse_matrix.h +++ b/include/deal.II/lac/petsc_parallel_block_sparse_matrix.h @@ -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 diff --git a/include/deal.II/lac/vector.h b/include/deal.II/lac/vector.h index 8eb4c59eac..f63389c22b 100644 --- a/include/deal.II/lac/vector.h +++ b/include/deal.II/lac/vector.h @@ -808,15 +808,8 @@ public: const Vector &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; //@}