vector_data_exchange.h

Go to the documentation of this file.

// -----------------------------------------------------------------------------
//
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR LGPL-2.1-or-later
// Copyright (C) 2020 - 2023 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Detailed license information governing the source code and contributions
// can be found in LICENSE.md and CONTRIBUTING.md at the top level directory.
//
// -----------------------------------------------------------------------------
 
 
#ifndef dealii_matrix_free_vector_data_exchange_h
#define dealii_matrix_free_vector_data_exchange_h
 
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/array_view.h>
#include <deal.II/base/mpi_stub.h>
#include <deal.II/base/partitioner.h>
 
#include <deal.II/lac/vector_operation.h>
 
#include <memory>
 
DEAL_II_NAMESPACE_OPEN
 
namespace internal
{
  namespace MatrixFreeFunctions
  {
    namespace VectorDataExchange
    {
      class Base
      {
      public:
        virtual ~Base() = default;
 
        virtual unsigned int
        locally_owned_size() const = 0;
 
        virtual unsigned int
        n_ghost_indices() const = 0;
 
        virtual unsigned int
        n_import_indices() const = 0;
 
        virtual unsigned int
        n_import_sm_procs() const = 0;
 
        virtual types::global_dof_index
        size() const = 0;
 
        virtual void
        export_to_ghosted_array_start(
          const unsigned int                          communication_channel,
          const ArrayView<const double>              &locally_owned_array,
          const std::vector<ArrayView<const double>> &shared_arrays,
          const ArrayView<double>                    &ghost_array,
          const ArrayView<double>                    &temporary_storage,
          std::vector<MPI_Request>                   &requests) const = 0;
 
        virtual void
        export_to_ghosted_array_finish(
          const ArrayView<const double>              &locally_owned_array,
          const std::vector<ArrayView<const double>> &shared_arrays,
          const ArrayView<double>                    &ghost_array,
          std::vector<MPI_Request>                   &requests) const = 0;
 
        virtual void
        import_from_ghosted_array_start(
          const VectorOperation::values               vector_operation,
          const unsigned int                          communication_channel,
          const ArrayView<const double>              &locally_owned_array,
          const std::vector<ArrayView<const double>> &shared_arrays,
          const ArrayView<double>                    &ghost_array,
          const ArrayView<double>                    &temporary_storage,
          std::vector<MPI_Request>                   &requests) const = 0;
 
        virtual void
        import_from_ghosted_array_finish(
          const VectorOperation::values               vector_operation,
          const ArrayView<double>                    &locally_owned_storage,
          const std::vector<ArrayView<const double>> &shared_arrays,
          const ArrayView<double>                    &ghost_array,
          const ArrayView<const double>              &temporary_storage,
          std::vector<MPI_Request>                   &requests) const = 0;
 
        virtual void
        reset_ghost_values(const ArrayView<double> &ghost_array) const = 0;
 
        virtual void
        export_to_ghosted_array_start(
          const unsigned int                         communication_channel,
          const ArrayView<const float>              &locally_owned_array,
          const std::vector<ArrayView<const float>> &shared_arrays,
          const ArrayView<float>                    &ghost_array,
          const ArrayView<float>                    &temporary_storage,
          std::vector<MPI_Request>                  &requests) const = 0;
 
        virtual void
        export_to_ghosted_array_finish(
          const ArrayView<const float>              &locally_owned_array,
          const std::vector<ArrayView<const float>> &shared_arrays,
          const ArrayView<float>                    &ghost_array,
          std::vector<MPI_Request>                  &requests) const = 0;
 
        virtual void
        import_from_ghosted_array_start(
          const VectorOperation::values              vector_operation,
          const unsigned int                         communication_channel,
          const ArrayView<const float>              &locally_owned_array,
          const std::vector<ArrayView<const float>> &shared_arrays,
          const ArrayView<float>                    &ghost_array,
          const ArrayView<float>                    &temporary_storage,
          std::vector<MPI_Request>                  &requests) const = 0;
 
        virtual void
        import_from_ghosted_array_finish(
          const VectorOperation::values              vector_operation,
          const ArrayView<float>                    &locally_owned_storage,
          const std::vector<ArrayView<const float>> &shared_arrays,
          const ArrayView<float>                    &ghost_array,
          const ArrayView<const float>              &temporary_storage,
          std::vector<MPI_Request>                  &requests) const = 0;
 
        virtual void
        reset_ghost_values(const ArrayView<float> &ghost_array) const = 0;
      };
 
 
      class PartitionerWrapper : public Base
      {
      public:
        PartitionerWrapper(
          const std::shared_ptr<const Utilities::MPI::Partitioner>
            &partitioner);
 
        virtual ~PartitionerWrapper() = default;
 
        unsigned int
        locally_owned_size() const override;
 
        unsigned int
        n_ghost_indices() const override;
 
        unsigned int
        n_import_indices() const override;
 
        unsigned int
        n_import_sm_procs() const override;
 
        types::global_dof_index
        size() const override;
 
        void
        export_to_ghosted_array_start(
          const unsigned int                          communication_channel,
          const ArrayView<const double>              &locally_owned_array,
          const std::vector<ArrayView<const double>> &shared_arrays,
          const ArrayView<double>                    &ghost_array,
          const ArrayView<double>                    &temporary_storage,
          std::vector<MPI_Request>                   &requests) const override;
 
        void
        export_to_ghosted_array_finish(
          const ArrayView<const double>              &locally_owned_array,
          const std::vector<ArrayView<const double>> &shared_arrays,
          const ArrayView<double>                    &ghost_array,
          std::vector<MPI_Request>                   &requests) const override;
 
        void
        import_from_ghosted_array_start(
          const VectorOperation::values               vector_operation,
          const unsigned int                          communication_channel,
          const ArrayView<const double>              &locally_owned_array,
          const std::vector<ArrayView<const double>> &shared_arrays,
          const ArrayView<double>                    &ghost_array,
          const ArrayView<double>                    &temporary_storage,
          std::vector<MPI_Request>                   &requests) const override;
 
        void
        import_from_ghosted_array_finish(
          const VectorOperation::values               vector_operation,
          const ArrayView<double>                    &locally_owned_storage,
          const std::vector<ArrayView<const double>> &shared_arrays,
          const ArrayView<double>                    &ghost_array,
          const ArrayView<const double>              &temporary_storage,
          std::vector<MPI_Request>                   &requests) const override;
 
        void
        reset_ghost_values(const ArrayView<double> &ghost_array) const override;
 
        void
        export_to_ghosted_array_start(
          const unsigned int                         communication_channel,
          const ArrayView<const float>              &locally_owned_array,
          const std::vector<ArrayView<const float>> &shared_arrays,
          const ArrayView<float>                    &ghost_array,
          const ArrayView<float>                    &temporary_storage,
          std::vector<MPI_Request>                  &requests) const override;
 
        void
        export_to_ghosted_array_finish(
          const ArrayView<const float>              &locally_owned_array,
          const std::vector<ArrayView<const float>> &shared_arrays,
          const ArrayView<float>                    &ghost_array,
          std::vector<MPI_Request>                  &requests) const override;
 
        void
        import_from_ghosted_array_start(
          const VectorOperation::values              vector_operation,
          const unsigned int                         communication_channel,
          const ArrayView<const float>              &locally_owned_array,
          const std::vector<ArrayView<const float>> &shared_arrays,
          const ArrayView<float>                    &ghost_array,
          const ArrayView<float>                    &temporary_storage,
          std::vector<MPI_Request>                  &requests) const override;
 
        void
        import_from_ghosted_array_finish(
          const VectorOperation::values              vector_operation,
          const ArrayView<float>                    &locally_owned_storage,
          const std::vector<ArrayView<const float>> &shared_arrays,
          const ArrayView<float>                    &ghost_array,
          const ArrayView<const float>              &temporary_storage,
          std::vector<MPI_Request>                  &requests) const override;
 
        void
        reset_ghost_values(const ArrayView<float> &ghost_array) const override;
 
      private:
        template <typename Number>
        void
        reset_ghost_values_impl(const ArrayView<Number> &ghost_array) const;
 
        const std::shared_ptr<const Utilities::MPI::Partitioner> partitioner;
      };
 
 
 
      class Full : public Base
      {
      public:
        Full(
          const std::shared_ptr<const Utilities::MPI::Partitioner> &partitioner,
          const MPI_Comm communicator_sm);
 
        unsigned int
        locally_owned_size() const override;
 
        unsigned int
        n_ghost_indices() const override;
 
        unsigned int
        n_import_indices() const override;
 
        virtual unsigned int
        n_import_sm_procs() const override;
 
        virtual types::global_dof_index
        size() const override;
 
        MPI_Comm
        get_sm_mpi_communicator() const;
 
        void
        export_to_ghosted_array_start(
          const unsigned int                          communication_channel,
          const ArrayView<const double>              &locally_owned_array,
          const std::vector<ArrayView<const double>> &shared_arrays,
          const ArrayView<double>                    &ghost_array,
          const ArrayView<double>                    &temporary_storage,
          std::vector<MPI_Request>                   &requests) const override;
 
        void
        export_to_ghosted_array_finish(
          const ArrayView<const double>              &locally_owned_array,
          const std::vector<ArrayView<const double>> &shared_arrays,
          const ArrayView<double>                    &ghost_array,
          std::vector<MPI_Request>                   &requests) const override;
 
        void
        import_from_ghosted_array_start(
          const VectorOperation::values               vector_operation,
          const unsigned int                          communication_channel,
          const ArrayView<const double>              &locally_owned_array,
          const std::vector<ArrayView<const double>> &shared_arrays,
          const ArrayView<double>                    &ghost_array,
          const ArrayView<double>                    &temporary_storage,
          std::vector<MPI_Request>                   &requests) const override;
 
        void
        import_from_ghosted_array_finish(
          const VectorOperation::values               vector_operation,
          const ArrayView<double>                    &locally_owned_storage,
          const std::vector<ArrayView<const double>> &shared_arrays,
          const ArrayView<double>                    &ghost_array,
          const ArrayView<const double>              &temporary_storage,
          std::vector<MPI_Request>                   &requests) const override;
 
        void
        reset_ghost_values(const ArrayView<double> &ghost_array) const override;
 
        void
        export_to_ghosted_array_start(
          const unsigned int                         communication_channel,
          const ArrayView<const float>              &locally_owned_array,
          const std::vector<ArrayView<const float>> &shared_arrays,
          const ArrayView<float>                    &ghost_array,
          const ArrayView<float>                    &temporary_storage,
          std::vector<MPI_Request>                  &requests) const override;
 
        void
        export_to_ghosted_array_finish(
          const ArrayView<const float>              &locally_owned_array,
          const std::vector<ArrayView<const float>> &shared_arrays,
          const ArrayView<float>                    &ghost_array,
          std::vector<MPI_Request>                  &requests) const override;
 
        void
        import_from_ghosted_array_start(
          const VectorOperation::values              vector_operation,
          const unsigned int                         communication_channel,
          const ArrayView<const float>              &locally_owned_array,
          const std::vector<ArrayView<const float>> &shared_arrays,
          const ArrayView<float>                    &ghost_array,
          const ArrayView<float>                    &temporary_storage,
          std::vector<MPI_Request>                  &requests) const override;
 
        void
        import_from_ghosted_array_finish(
          const VectorOperation::values              vector_operation,
          const ArrayView<float>                    &locally_owned_storage,
          const std::vector<ArrayView<const float>> &shared_arrays,
          const ArrayView<float>                    &ghost_array,
          const ArrayView<const float>              &temporary_storage,
          std::vector<MPI_Request>                  &requests) const override;
 
        void
        reset_ghost_values(const ArrayView<float> &ghost_array) const override;
 
      private:
        template <typename Number>
        void
        export_to_ghosted_array_start_impl(
          const unsigned int                          communication_channel,
          const ArrayView<const Number>              &locally_owned_array,
          const std::vector<ArrayView<const Number>> &shared_arrays,
          const ArrayView<Number>                    &ghost_array,
          const ArrayView<Number>                    &temporary_storage,
          std::vector<MPI_Request>                   &requests) const;
 
        template <typename Number>
        void
        export_to_ghosted_array_finish_impl(
          const ArrayView<const Number>              &locally_owned_array,
          const std::vector<ArrayView<const Number>> &shared_arrays,
          const ArrayView<Number>                    &ghost_array,
          std::vector<MPI_Request>                   &requests) const;
 
        template <typename Number>
        void
        import_from_ghosted_array_start_impl(
          const VectorOperation::values               vector_operation,
          const unsigned int                          communication_channel,
          const ArrayView<const Number>              &locally_owned_array,
          const std::vector<ArrayView<const Number>> &shared_arrays,
          const ArrayView<Number>                    &ghost_array,
          const ArrayView<Number>                    &temporary_storage,
          std::vector<MPI_Request>                   &requests) const;
 
        template <typename Number>
        void
        import_from_ghosted_array_finish_impl(
          const VectorOperation::values               vector_operation,
          const ArrayView<Number>                    &locally_owned_storage,
          const std::vector<ArrayView<const Number>> &shared_arrays,
          const ArrayView<Number>                    &ghost_array,
          const ArrayView<const Number>              &temporary_storage,
          std::vector<MPI_Request>                   &requests) const;
 
        template <typename Number>
        void
        reset_ghost_values_impl(const ArrayView<Number> &ghost_array) const;
 
      private:
        const MPI_Comm comm;
 
        const MPI_Comm comm_sm;
 
        const unsigned int n_local_elements;
 
        const unsigned int n_ghost_elements;
 
        const types::global_dof_index n_global_elements;
 
        std::vector<unsigned int> n_ghost_indices_in_larger_set_by_remote_rank;
 
        std::pair<std::vector<unsigned int>,
                  std::vector<std::pair<unsigned int, unsigned int>>>
          ghost_indices_subset_data;
 
        std::vector<std::array<unsigned int, 3>> ghost_targets_data;
 
        std::vector<std::array<unsigned int, 3>> import_targets_data;
 
        std::pair<std::vector<unsigned int>,
                  std::vector<std::pair<unsigned int, unsigned int>>>
          import_indices_data;
 
        std::vector<unsigned int> sm_ghost_ranks;
 
        std::pair<std::vector<unsigned int>,
                  std::vector<std::pair<unsigned int, unsigned int>>>
          sm_export_data;
 
        std::pair<std::vector<unsigned int>,
                  std::vector<std::pair<unsigned int, unsigned int>>>
          sm_export_data_this;
 
        std::vector<unsigned int> sm_import_ranks;
 
        std::pair<std::vector<unsigned int>,
                  std::vector<std::pair<unsigned int, unsigned int>>>
          sm_import_data;
 
        std::pair<std::vector<unsigned int>,
                  std::vector<std::pair<unsigned int, unsigned int>>>
          sm_import_data_this;
      };
 
    } // namespace VectorDataExchange
  }   // end of namespace MatrixFreeFunctions
} // end of namespace internal
 
DEAL_II_NAMESPACE_CLOSE
 
#endif