multigrid_amg.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) XXXX - YYYY by the polyDEAL authors
//
// This file is part of the polyDEAL library.
//
// Detailed license information governing the source code
// can be found in LICENSE.md at the top level directory.
//
// -----------------------------------------------------------------------------
 
 
#ifndef multigrid_amg_h
#define multigrid_amg_h
 
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/mg_level_object.h>
 
#include <deal.II/fe/fe_dgq.h>
 
#include <deal.II/lac/la_parallel_vector.h>
 
#include <deal.II/matrix_free/operators.h>
 
#include <deal.II/multigrid/mg_base.h>
 
#include <linear_operator_for_mg.h>
 
namespace dealii
{
  template <int dim, typename OperatorType, typename Number = double>
  class MatrixFreeProjector
  {
  private:
    using VectorType = LinearAlgebra::distributed::Vector<Number>;
    MPI_Comm communicator;

    const OperatorType *mf_operator;

    std::vector<TrilinosWrappers::SparseMatrix *> transfer_matrices;

    std::vector<LinearOperatorMG<VectorType, VectorType>> level_operators;

    LinearOperatorMG<VectorType, VectorType> mf_linear_operator;
 
  public:
    MatrixFreeProjector(
      const OperatorType                                 &mf_operator_,
      const std::vector<TrilinosWrappers::SparseMatrix *> transfers_)
    {
      // Only DGQ discretizations are supported.
      Assert(dynamic_cast<const FE_DGQ<dim> *>(
               &mf_operator_.get_matrix_free()->get_dof_handler().get_fe()) !=
               nullptr,
             ExcNotImplemented());
      using VectorType = LinearAlgebra::distributed::Vector<Number>;
 
      // Check parallel layout is identical on every level
      for (unsigned int l = 0; l < transfers_.size(); ++l)
        Assert((mf_operator_.get_matrix_free()->get_locally_owned_set() ==
                transfers_[l]->locally_owned_range_indices()),
               ExcInternalError());
 
      transfer_matrices.resize(transfers_.size());
      level_operators.resize(transfers_.size());
      // get communicator from first Trilinos matrix
      communicator = transfers_[0]->get_mpi_communicator();
 
      for (unsigned int l = 0; l < transfers_.size(); ++l)
        {
          // Set the pointer to the correct matrix
          transfer_matrices[l] = transfers_[l];
 
          // Define vmult-type lambdas for each linear operator.
          level_operators[l].vmult = [this, l](VectorType       &dst,
                                               const VectorType &src) {
            transfer_matrices[l]->vmult(dst, src);
          };
          level_operators[l].vmult_add = [this, l](VectorType       &dst,
                                                   const VectorType &src) {
            transfer_matrices[l]->vmult_add(dst, src);
          };
          level_operators[l].Tvmult = [this, l](VectorType       &dst,
                                                const VectorType &src) {
            transfer_matrices[l]->Tvmult(dst, src);
          };
          level_operators[l].Tvmult_add = [this, l](VectorType       &dst,
                                                    const VectorType &src) {
            transfer_matrices[l]->Tvmult_add(dst, src);
          };
 
          // Inform each linear operator about the parallel layout. Use the
          // given trilinos matrices.
          level_operators[l].reinit_domain_vector = [this, l](VectorType &v,
                                                              bool) {
            v.reinit(transfer_matrices[l]->locally_owned_domain_indices(),
                     communicator);
          };
 
          level_operators[l].reinit_range_vector = [this, l](VectorType &v,
                                                             bool) {
            v.reinit(transfer_matrices[l]->locally_owned_range_indices(),
                     communicator);
          };
        }
 
      // Do the same for the matrix-free object.
      // First, set the pointer
      mf_operator = &mf_operator_;
 
      // Then, populate the corresponding lambdas (std::functions)
      mf_linear_operator.vmult = [this](VectorType       &dst,
                                        const VectorType &src) {
        mf_operator->vmult(dst, src);
      };
      mf_linear_operator.vmult_add = [this](VectorType       &dst,
                                            const VectorType &src) {
        mf_operator->vmult_add(dst, src);
      };
      mf_linear_operator.Tvmult = [this](VectorType       &dst,
                                         const VectorType &src) {
        mf_operator->Tvmult(dst, src);
      };
      mf_linear_operator.Tvmult_add = [this](VectorType       &dst,
                                             const VectorType &src) {
        mf_operator->Tvmult_add(dst, src);
      };
 
      mf_linear_operator.reinit_domain_vector = [&](VectorType &v, bool) {};
      mf_linear_operator.reinit_range_vector  = [&](VectorType &v, bool) {
        v.reinit(mf_operator->get_matrix_free()
                   ->get_dof_handler()
                   .locally_owned_dofs(),
                 communicator);
      };
    }

    void
    compute_level_matrices(
      MGLevelObject<LinearOperatorMG<VectorType, VectorType>> &mg_matrices)
    {
      Assert(mg_matrices.n_levels() > 1,
             ExcMessage("Vector of matrices set to invalid size."));
      Assert(!mf_linear_operator.is_null_operator, ExcInternalError());
 
      using VectorType             = LinearAlgebra::distributed::Vector<Number>;
      const unsigned int min_level = mg_matrices.min_level();
      const unsigned int max_level = mg_matrices.max_level();
 
      mg_matrices[min_level] = mf_linear_operator; // finest level
 
      // do the same, but using transfers to define level matrices
      for (unsigned int l = min_level + 1; l < max_level; l++)
        mg_matrices[l] = transpose_operator(level_operators[l - 1]) *
                         mf_linear_operator * level_operators[l - 1];
    }
  };
 
 

  template <int dim, typename MatrixType, typename Number = double>
  class AmgProjector
  {
  private:
    using VectorType = LinearAlgebra::distributed::Vector<Number>;
    MPI_Comm communicator;

    // const MatrixType &fine_operator;

    std::vector<const MatrixType *> transfer_matrices;
 
 
 
  public:
    AmgProjector(const std::vector<TrilinosWrappers::SparseMatrix> &transfers_)
    {
      using VectorType = LinearAlgebra::distributed::Vector<Number>;
      // get communicator from first Trilinos matrix
      communicator = transfers_[0].get_mpi_communicator();
      transfer_matrices.resize(transfers_.size());
 
      // Store pointers to fine operator and transfers
      for (unsigned int l = 0; l < transfers_.size(); ++l)
        {
          // std::cout << "transferring matrix l= " << l << std::endl;
          transfer_matrices[l] = &transfers_[l];
        }
    }
 

    AmgProjector(
      const MGLevelObject<TrilinosWrappers::SparseMatrix> &transfers_)
    {
      using VectorType = LinearAlgebra::distributed::Vector<Number>;
 
      // get communicator from first Trilinos matrix
      communicator = transfers_[0].get_mpi_communicator();
      transfer_matrices.resize(transfers_.n_levels());
 
      // Store pointers to fine operator and transfers
      for (unsigned int l = 0; l < transfer_matrices.size(); ++l)
        {
          // std::cout << "transferring matrix l= " << l << std::endl;
          transfer_matrices[l] = &transfers_[l];
        }
    }
 
 

    void
    compute_level_matrices(
      MGLevelObject<std::unique_ptr<MatrixType>> &mg_matrices)
    {
      Assert(mg_matrices.n_levels() > 1,
             ExcMessage("Vector of matrices set to invalid size."));
      using VectorType = LinearAlgebra::distributed::Vector<Number>;
 
      const unsigned int min_level = mg_matrices.min_level();
      const unsigned int max_level = mg_matrices.max_level();
 
      // mg_matrices[max_level].copy_from(fine_operator); // finest level
      // MPI_Barrier(communicator);
      // std::cout << "copied finest operator " << max_level << std::endl;
 
      // do the same, but using transfers to define level matrices
      // std::cout << "min level = " << min_level << std::endl;
      for (unsigned int l = max_level; l-- > min_level;)
        {
          // Set parallel layout of intermediate operators AP
          MatrixType level_operator;
 
          mg_matrices[l] = std::make_unique<MatrixType>();
 
          // First, compute AP
          mg_matrices[l + 1]->mmult(
            level_operator,
            *transfer_matrices[l]); // result stored in level_operators[l]
                                    // Multiply by the transpose
          transfer_matrices[l]->Tmmult(*mg_matrices[l], level_operator);
        }
    }
 
 

    void
    compute_level_matrices_as_linear_operators(
      MGLevelObject<std::unique_ptr<MatrixType>> &mg_matrices,
      MGLevelObject<
        LinearOperatorMG<LinearAlgebra::distributed::Vector<Number>,
                         LinearAlgebra::distributed::Vector<Number>>>
        &multigrid_matrices_lo)
    {
      Assert(mg_matrices.n_levels() > 1,
             ExcMessage("Vector of matrices set to invalid size."));
      using VectorType = LinearAlgebra::distributed::Vector<Number>;
 
      const unsigned int min_level = mg_matrices.min_level();
      const unsigned int max_level = mg_matrices.max_level();
 
      for (unsigned int l = max_level; l-- > min_level;)
        {
          // Set parallel layout of intermediate operators AP
          MatrixType level_operator;
 
          mg_matrices[l] = std::make_unique<MatrixType>();
 
          // First, compute AP
          mg_matrices[l + 1]->mmult(
            level_operator,
            *transfer_matrices[l]); // result stored in level_operators[l]
                                    // Multiply by the transpose
          transfer_matrices[l]->Tmmult(*mg_matrices[l], level_operator);
 
          // Wrap every matrix into a linear operator now.
          multigrid_matrices_lo[l] =
            linear_operator_mg<VectorType, VectorType>(*mg_matrices[l]);
          multigrid_matrices_lo[l].vmult =
            [&mg_matrices, l](VectorType &dst, const VectorType &src) {
              mg_matrices[l]->vmult(dst, src);
            };
          multigrid_matrices_lo[l].n_rows = mg_matrices[l]->m();
          multigrid_matrices_lo[l].n_cols = mg_matrices[l]->n();
        }
    }
 
 
    /*
     * Same as above, but with a vector of matrices.
     */
    void
    compute_level_matrices_as_linear_operators(
      MGLevelObject<MatrixType> &mg_matrices,
      MGLevelObject<
        LinearOperatorMG<LinearAlgebra::distributed::Vector<Number>,
                         LinearAlgebra::distributed::Vector<Number>>>
        &multigrid_matrices_lo)
    {
      Assert(mg_matrices.n_levels() > 1,
             ExcMessage("Vector of matrices set to invalid size."));
      using VectorType = LinearAlgebra::distributed::Vector<Number>;
 
      const unsigned int min_level = mg_matrices.min_level();
      const unsigned int max_level = mg_matrices.max_level();
 
      for (unsigned int l = max_level; l-- > min_level;)
        {
          // Set intermediate operators "AP"
          MatrixType level_operator;
 
          // First, compute AP
          mg_matrices[l + 1].mmult(
            level_operator,
            *transfer_matrices[l]); // result stored in level_operators[l]
                                    // Multiply by the transpose
          transfer_matrices[l]->Tmmult(mg_matrices[l], level_operator);
          // Wrap every matrix into a linear operator now.
          multigrid_matrices_lo[l] =
            linear_operator_mg<VectorType, VectorType>(mg_matrices[l]);
          multigrid_matrices_lo[l].vmult =
            [&mg_matrices, l](VectorType &dst, const VectorType &src) {
              mg_matrices[l].vmult(dst, src);
            };
          multigrid_matrices_lo[l].n_rows = mg_matrices[l].m();
          multigrid_matrices_lo[l].n_cols = mg_matrices[l].n();
        }
    }
 
 
 
    void
    compute_level_matrices(MGLevelObject<MatrixType> &mg_matrices)
    {
      Assert(mg_matrices.n_levels() > 1,
             ExcMessage("Vector of matrices set to invalid size."));
      using VectorType = LinearAlgebra::distributed::Vector<Number>;
 
      const unsigned int min_level = mg_matrices.min_level();
      const unsigned int max_level = mg_matrices.max_level();
 
      // mg_matrices[max_level].copy_from(fine_operator); // finest level
      // MPI_Barrier(communicator);
      // std::cout << "copied finest operator " << max_level << std::endl;
 
      // do the same, but using transfers to define level matrices
      // std::cout << "min level = " << min_level << std::endl;
      for (unsigned int l = max_level; l-- > min_level;)
        {
          // Set parallel layout of intermediate operators AP
          MatrixType level_operator(
            transfer_matrices[l]->locally_owned_range_indices(),
            transfer_matrices[l]->locally_owned_domain_indices(),
            communicator);
 
          // First, compute AP
          mg_matrices[l + 1].mmult(
            level_operator,
            *transfer_matrices[l]); // result stored in level_operators[l]
                                    // Multiply by the transpose
          transfer_matrices[l]->Tmmult(mg_matrices[l], level_operator);
        }
    }
  };
 
 

  template <int dim, typename VectorType>
  class MGTransferAgglomeration : public MGTransferBase<VectorType>
  {
  public:
    MGTransferAgglomeration(
      const MGLevelObject<TrilinosWrappers::SparseMatrix *> &transfer_matrices,
      const std::vector<DoFHandler<dim> *>                  &dof_handlers);

    MGTransferAgglomeration(
      const MGLevelObject<TrilinosWrappers::SparseMatrix> &transfer_matrices,
      const std::vector<DoFHandler<dim> *>                &dof_handlers);
 

    void
    prolongate(const unsigned int to_level,
               VectorType        &dst,
               const VectorType  &src) const override;
 

    void
    prolongate_and_add(const unsigned int to_level,
                       VectorType        &dst,
                       const VectorType  &src) const override;
 

    void
    restrict_and_add(const unsigned int from_level,
                     VectorType        &dst,
                     const VectorType  &src) const override;
 

    void
    copy_to_mg(const DoFHandler<dim>     &dof_handler,
               MGLevelObject<VectorType> &dst,
               const VectorType          &src) const;
 

    void
    copy_from_mg(const DoFHandler<dim>           &dof_handler,
                 VectorType                      &dst,
                 const MGLevelObject<VectorType> &src) const;
 
 
  private:
    MGLevelObject<ObserverPointer<TrilinosWrappers::SparseMatrix>>
      transfer_matrices;

    std::vector<const DoFHandler<dim> *> dof_handlers;
  };
 
} // namespace dealii
 
 
#endif