From: Wolfgang Bangerth Date: Sun, 2 Jul 2023 03:32:12 +0000 (-0600) Subject: Fix the naming of some function arguments. X-Git-Tag: relicensing~804^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=35365f9c38272388a9d2870f62197eb393c33933;p=dealii.git Fix the naming of some function arguments. --- diff --git a/include/deal.II/lac/trilinos_epetra_communication_pattern.h b/include/deal.II/lac/trilinos_epetra_communication_pattern.h index a6665cf499..bfcc6b78cd 100644 --- a/include/deal.II/lac/trilinos_epetra_communication_pattern.h +++ b/include/deal.II/lac/trilinos_epetra_communication_pattern.h @@ -53,11 +53,21 @@ namespace LinearAlgebra const MPI_Comm communicator); /** - * Reinitialize the object. + * Reinitialize 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. */ virtual void - reinit(const IndexSet &vector_space_vector_index_set, - const IndexSet &read_write_vector_index_set, + reinit(const IndexSet &locally_owned_indices, + const IndexSet &ghost_indices, const MPI_Comm communicator) override; /** diff --git a/include/deal.II/lac/trilinos_tpetra_communication_pattern.h b/include/deal.II/lac/trilinos_tpetra_communication_pattern.h index 3826de0142..19d5da6c00 100644 --- a/include/deal.II/lac/trilinos_tpetra_communication_pattern.h +++ b/include/deal.II/lac/trilinos_tpetra_communication_pattern.h @@ -52,11 +52,21 @@ namespace LinearAlgebra const MPI_Comm communicator); /** - * Reinitialize the object. + * Reinitialize 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. */ virtual void - reinit(const IndexSet &vector_space_vector_index_set, - const IndexSet &read_write_vector_index_set, + reinit(const IndexSet &locally_owned_indices, + const IndexSet &ghost_indices, const MPI_Comm communicator) override; /** diff --git a/source/lac/trilinos_epetra_communication_pattern.cc b/source/lac/trilinos_epetra_communication_pattern.cc index 5b121cabb8..4260d90cc6 100644 --- a/source/lac/trilinos_epetra_communication_pattern.cc +++ b/source/lac/trilinos_epetra_communication_pattern.cc @@ -45,16 +45,16 @@ namespace LinearAlgebra void - CommunicationPattern::reinit(const IndexSet &vector_space_vector_index_set, - const IndexSet &read_write_vector_index_set, + CommunicationPattern::reinit(const IndexSet &locally_owned_indices, + const IndexSet &ghost_indices, const MPI_Comm communicator) { comm = std::make_shared(communicator); Epetra_Map vector_space_vector_map = - vector_space_vector_index_set.make_trilinos_map(*comm, false); + locally_owned_indices.make_trilinos_map(*comm, false); Epetra_Map read_write_vector_map = - read_write_vector_index_set.make_trilinos_map(*comm, true); + ghost_indices.make_trilinos_map(*comm, true); // Target map is read_write_vector_map // Source map is vector_space_vector_map. This map must have uniquely diff --git a/source/lac/trilinos_tpetra_communication_pattern.cc b/source/lac/trilinos_tpetra_communication_pattern.cc index 0ec7ad4c1c..b4a77450f1 100644 --- a/source/lac/trilinos_tpetra_communication_pattern.cc +++ b/source/lac/trilinos_tpetra_communication_pattern.cc @@ -45,18 +45,18 @@ namespace LinearAlgebra void - CommunicationPattern::reinit(const IndexSet &vector_space_vector_index_set, - const IndexSet &read_write_vector_index_set, + CommunicationPattern::reinit(const IndexSet &locally_owned_indices, + const IndexSet &ghost_indices, const MPI_Comm communicator) { comm = std::make_shared(communicator); auto vector_space_vector_map = Teuchos::rcp(new Tpetra::Map( - vector_space_vector_index_set.make_tpetra_map(*comm, false))); + locally_owned_indices.make_tpetra_map(*comm, false))); auto read_write_vector_map = Teuchos::rcp(new Tpetra::Map( - read_write_vector_index_set.make_tpetra_map(*comm, true))); + ghost_indices.make_tpetra_map(*comm, true))); // Target map is read_write_vector_map // Source map is vector_space_vector_map. This map must have uniquely