From: Wolfgang Bangerth <bangerth@colostate.edu>
Date: Thu, 6 Jul 2023 13:05:02 +0000 (-0600)
Subject: Remove reference to VectorSpacevector from the documentation.
X-Git-Tag: relicensing~731^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F15668%2Fhead;p=dealii.git

Remove reference to VectorSpacevector from the documentation.

While there, rename some function arguments to match their real intent.
The new names match those in the reinit() functions right below.
---

diff --git a/include/deal.II/lac/trilinos_epetra_communication_pattern.h b/include/deal.II/lac/trilinos_epetra_communication_pattern.h
index bfcc6b78cd..a37a824985 100644
--- a/include/deal.II/lac/trilinos_epetra_communication_pattern.h
+++ b/include/deal.II/lac/trilinos_epetra_communication_pattern.h
@@ -42,14 +42,20 @@ namespace LinearAlgebra
     {
     public:
       /**
-       * Initialize the communication pattern. The first argument @p
-       * vector_space_vector_index_set is the index set associated to a
-       * VectorSpaceVector object. The second argument @p
-       * read_write_vector_index_set is the index set associated to a
-       * ReadWriteVector object.
+       * Initialize the communication pattern.
+       *
+       * @param[in] locally_owned_indices The set of indices of elements
+       *   in the array mentioned in the class documentation that are
+       *   stored on the current process.
+       * @param[in] ghost_indices The set of indices of elements in the
+       *   array mentioned in the class documentation that the current
+       *   process will need to be able to import.
+       * @param[in] communicator The MPI communicator used to describe the
+       *   entire set of processes that participate in the storage and
+       *   access to elements of the array.
        */
-      CommunicationPattern(const IndexSet &vector_space_vector_index_set,
-                           const IndexSet &read_write_vector_index_set,
+      CommunicationPattern(const IndexSet &locally_owned_indices,
+                           const IndexSet &ghost_indices,
                            const MPI_Comm  communicator);
 
       /**
diff --git a/include/deal.II/lac/trilinos_tpetra_communication_pattern.h b/include/deal.II/lac/trilinos_tpetra_communication_pattern.h
index 19d5da6c00..a759cf9ed5 100644
--- a/include/deal.II/lac/trilinos_tpetra_communication_pattern.h
+++ b/include/deal.II/lac/trilinos_tpetra_communication_pattern.h
@@ -41,14 +41,20 @@ namespace LinearAlgebra
     {
     public:
       /**
-       * Reinitialize the communication pattern. The first argument @p
-       * vector_space_vector_index_set is the index set associated to a
-       * VectorSpaceVector object. The second argument @p
-       * read_write_vector_index_set is the index set associated to a
-       * ReadWriteVector object.
+       * Initialize the communication pattern.
+       *
+       * @param[in] locally_owned_indices The set of indices of elements
+       *   in the array mentioned in the class documentation that are
+       *   stored on the current process.
+       * @param[in] ghost_indices The set of indices of elements in the
+       *   array mentioned in the class documentation that the current
+       *   process will need to be able to import.
+       * @param[in] communicator The MPI communicator used to describe the
+       *   entire set of processes that participate in the storage and
+       *   access to elements of the array.
        */
-      CommunicationPattern(const IndexSet &vector_space_vector_index_set,
-                           const IndexSet &read_write_vector_index_set,
+      CommunicationPattern(const IndexSet &locally_owned_indices,
+                           const IndexSet &ghost_indices,
                            const MPI_Comm  communicator);
 
       /**
diff --git a/source/lac/trilinos_epetra_communication_pattern.cc b/source/lac/trilinos_epetra_communication_pattern.cc
index 4260d90cc6..3db029c283 100644
--- a/source/lac/trilinos_epetra_communication_pattern.cc
+++ b/source/lac/trilinos_epetra_communication_pattern.cc
@@ -30,15 +30,15 @@ namespace LinearAlgebra
   namespace EpetraWrappers
   {
     CommunicationPattern::CommunicationPattern(
-      const IndexSet &vector_space_vector_index_set,
-      const IndexSet &read_write_vector_index_set,
+      const IndexSet &locally_owned_indices,
+      const IndexSet &ghost_indices,
       const MPI_Comm  communicator)
     {
       // virtual functions called in constructors and destructors never use the
       // override in a derived class
       // for clarity be explicit on which function is called
-      CommunicationPattern::reinit(vector_space_vector_index_set,
-                                   read_write_vector_index_set,
+      CommunicationPattern::reinit(locally_owned_indices,
+                                   ghost_indices,
                                    communicator);
     }
 
diff --git a/source/lac/trilinos_tpetra_communication_pattern.cc b/source/lac/trilinos_tpetra_communication_pattern.cc
index b4a77450f1..c1ad9b978a 100644
--- a/source/lac/trilinos_tpetra_communication_pattern.cc
+++ b/source/lac/trilinos_tpetra_communication_pattern.cc
@@ -30,15 +30,15 @@ namespace LinearAlgebra
   namespace TpetraWrappers
   {
     CommunicationPattern::CommunicationPattern(
-      const IndexSet &vector_space_vector_index_set,
-      const IndexSet &read_write_vector_index_set,
+      const IndexSet &locally_owned_indices,
+      const IndexSet &ghost_indices,
       const MPI_Comm  communicator)
     {
       // virtual functions called in constructors and destructors never use the
       // override in a derived class
       // for clarity be explicit on which function is called
-      CommunicationPattern::reinit(vector_space_vector_index_set,
-                                   read_write_vector_index_set,
+      CommunicationPattern::reinit(locally_owned_indices,
+                                   ghost_indices,
                                    communicator);
     }