petsc_communication_pattern.h

Go to the documentation of this file.

// ---------------------------------------------------------------------
//
// Copyright (C) 2023 by the deal.II authors
//
// This file is part of the deal.II library.
//
// The deal.II library is free software; you can use it, redistribute
// it, and/or modify it under the terms of the GNU Lesser General
// Public License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// The full text of the license can be found in the file LICENSE.md at
// the top level directory of deal.II.
//
// ---------------------------------------------------------------------
 
#ifndef dealii_petsc_communication_pattern_h
#define dealii_petsc_communication_pattern_h
 
#include <deal.II/base/config.h>
 
#ifdef DEAL_II_WITH_PETSC
 
#  include <deal.II/base/array_view.h>
#  include <deal.II/base/communication_pattern_base.h>
#  include <deal.II/base/index_set.h>
 
#  include <deal.II/lac/vector_operation.h>
 
#  include <petscsf.h>
 
#  include <vector>
 
DEAL_II_NAMESPACE_OPEN
 
namespace PETScWrappers
{
  class CommunicationPattern : public Utilities::MPI::CommunicationPatternBase
  {
  public:
    CommunicationPattern();
 
    virtual ~CommunicationPattern() override;
 
    virtual void
    reinit(const IndexSet &locally_owned_indices,
           const IndexSet &ghost_indices,
           const MPI_Comm  communicator) override;
 
    void
    reinit(const std::vector<types::global_dof_index> &indices_locally_owned,
           const std::vector<types::global_dof_index> &indices_want,
           const MPI_Comm                              communicator);
 
    void
    reinit(const types::global_dof_index local_size,
           const IndexSet &              ghost_indices,
           const MPI_Comm                communicator);
 
    template <typename Number>
    void
    export_to_ghosted_array(const ArrayView<const Number> &locally_owned_array,
                            const ArrayView<Number> &      ghost_array) const;
 
    template <typename Number>
    void
    export_to_ghosted_array_start(
      const ArrayView<const Number> &locally_owned_array,
      const ArrayView<Number> &      ghost_array) const;
 
    template <typename Number>
    void
    export_to_ghosted_array_finish(
      const ArrayView<const Number> &locally_owned_array,
      const ArrayView<Number> &      ghost_array) const;
 
    template <typename Number>
    void
    import_from_ghosted_array(
      const VectorOperation::values  op,
      const ArrayView<const Number> &ghost_array,
      const ArrayView<Number> &      locally_owned_array) const;
 
    template <typename Number>
    void
    import_from_ghosted_array_start(
      const VectorOperation::values  op,
      const ArrayView<const Number> &ghost_array,
      const ArrayView<Number> &      locally_owned_array) const;
 
    template <typename Number>
    void
    import_from_ghosted_array_finish(
      const VectorOperation::values  op,
      const ArrayView<const Number> &ghost_array,
      const ArrayView<Number> &      locally_owned_array) const;
 
    MPI_Comm
    get_mpi_communicator() const override;
 
    operator const PetscSF &() const
    {
      return sf;
    }
 
    void
    clear();
 
  protected:
    PetscSF sf;
 
    void
    do_reinit(const std::vector<PetscInt> &inidx,
              const std::vector<PetscInt> &inloc,
              const std::vector<PetscInt> &outidx,
              const std::vector<PetscInt> &outloc,
              const MPI_Comm               communicator);
  };
 
  class Partitioner : public Utilities::MPI::CommunicationPatternBase
  {
  public:
    Partitioner();
 
    virtual ~Partitioner() override = default;
 
    virtual void
    reinit(const IndexSet &locally_owned_indices,
           const IndexSet &ghost_indices,
           const MPI_Comm  communicator) override;
 
    void
    reinit(const IndexSet &locally_owned_indices,
           const IndexSet &ghost_indices,
           const IndexSet &larger_ghost_indices,
           const MPI_Comm  communicator);
 
    unsigned int
    n_ghost_indices() const
    {
      return n_ghost_indices_data;
    }
 
    const IndexSet &
    ghost_indices() const
    {
      return ghost_indices_data;
    }
 
    template <typename Number>
    void
    export_to_ghosted_array(const ArrayView<const Number> &locally_owned_array,
                            const ArrayView<Number> &      ghost_array) const;
 
    template <typename Number>
    void
    export_to_ghosted_array_start(
      const ArrayView<const Number> &locally_owned_array,
      const ArrayView<Number> &      ghost_array) const;
 
    template <typename Number>
    void
    export_to_ghosted_array_finish(
      const ArrayView<const Number> &locally_owned_array,
      const ArrayView<Number> &      ghost_array) const;
 
    template <typename Number>
    void
    import_from_ghosted_array(
      const VectorOperation::values  op,
      const ArrayView<const Number> &ghost_array,
      const ArrayView<Number> &      locally_owned_array) const;
 
    template <typename Number>
    void
    import_from_ghosted_array_start(
      const VectorOperation::values  op,
      const ArrayView<const Number> &ghost_array,
      const ArrayView<Number> &      locally_owned_array) const;
 
    template <typename Number>
    void
    import_from_ghosted_array_finish(
      const VectorOperation::values  op,
      const ArrayView<const Number> &ghost_array,
      const ArrayView<Number> &      locally_owned_array) const;
 
    MPI_Comm
    get_mpi_communicator() const override;
 
  protected:
    CommunicationPattern    ghost, larger_ghost;
    IndexSet                ghost_indices_data;
    types::global_dof_index n_ghost_indices_data;
    types::global_dof_index n_ghost_indices_larger;
  };
 
} // namespace PETScWrappers
 
DEAL_II_NAMESPACE_CLOSE
 
#endif
 
#endif