]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Remove reference to VectorSpacevector from the documentation. 15668/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Thu, 6 Jul 2023 13:05:02 +0000 (07:05 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Thu, 6 Jul 2023 13:05:02 +0000 (07:05 -0600)
While there, rename some function arguments to match their real intent.
The new names match those in the reinit() functions right below.

include/deal.II/lac/trilinos_epetra_communication_pattern.h
include/deal.II/lac/trilinos_tpetra_communication_pattern.h
source/lac/trilinos_epetra_communication_pattern.cc
source/lac/trilinos_tpetra_communication_pattern.cc

index bfcc6b78cddc95dfb66f449e18207eed584f0971..a37a824985df3dfe600be4622e16c9dbf081e45d 100644 (file)
@@ -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);
 
       /**
index 19d5da6c00115ebde09482bcc30b0df206b13f71..a759cf9ed57b6f5d39e4e9ab5edebf91a6f4d83d 100644 (file)
@@ -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);
 
       /**
index 4260d90cc69e7b461193a19467604eda66b8e2aa..3db029c28373b58225a92126842a79f302b88d6e 100644 (file)
@@ -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);
     }
 
index b4a77450f1351a1309ab97f1581920ddc20a04f9..c1ad9b978abe002073ec7f5c453fdd3c833fe96d 100644 (file)
@@ -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);
     }
 

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.