DistributedSubDomainDeflation.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* DistributedSubDomainDeflation.h                             (C) 2000-2026 */
/*                                                                           */
/* Distributed solver based on subdomain deflation.                          */
/*---------------------------------------------------------------------------*/
#ifndef ARCCORE_ALINA_DISTRIBUTEDSUBDOMAINDEFLATION_H
#define ARCCORE_ALINA_DISTRIBUTEDSUBDOMAINDEFLATION_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*
 * This file is based on the work on AMGCL library (version march 2026)
 * which can be found at https://github.com/ddemidov/amgcl.
 *
 * Copyright (c) 2012-2022 Denis Demidov <dennis.demidov@gmail.com>
 * SPDX-License-Identifier: MIT
 */
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arccore/alina/BuiltinBackend.h"
#include "arccore/alina/Adapters.h"
#include "arccore/alina/MessagePassingUtils.h"
#include "arccore/alina/DistributedSkylineLUDirectSolver.h"
#include "arccore/alina/DistributedInnerProduct.h"
#include "arccore/alina/DistributedMatrix.h"
 
#include <vector>
#include <algorithm>
#include <numeric>
#include <memory>
#include <functional>
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane::Alina
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

struct constant_deflation
{
  const int block_size;
  constant_deflation(int block_size = 1)
  : block_size(block_size)
  {}
 
  int dim() const
  {
    return block_size;
  }
 
  int operator()(ptrdiff_t row, int j) const
  {
    return row % block_size == j;
  }
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
template <class SDD, class Matrix>
struct sdd_projected_matrix
{
  typedef typename SDD::value_type value_type;
 
  const SDD& S;
  const Matrix& A;
 
  sdd_projected_matrix(const SDD& S, const Matrix& A)
  : S(S)
  , A(A)
  {}
 
  template <class T, class Vec1, class Vec2>
  void mul(T alpha, const Vec1& x, T beta, Vec2& y) const
  {
    ARCCORE_ALINA_TIC("top/spmv");
    backend::spmv(alpha, A, x, beta, y);
    ARCCORE_ALINA_TOC("top/spmv");
 
    S.project(y);
  }
 
  template <class Vec1, class Vec2, class Vec3>
  void residual(const Vec1& f, const Vec2& x, Vec3& r) const
  {
    ARCCORE_ALINA_TIC("top/residual");
    backend::residual(f, A, x, r);
    ARCCORE_ALINA_TOC("top/residual");
 
    S.project(r);
  }
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
template <class SDD, class Matrix>
sdd_projected_matrix<SDD, Matrix> make_sdd_projected_matrix(const SDD& S, const Matrix& A)
{
  return sdd_projected_matrix<SDD, Matrix>(S, A);
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

template <class LocalPrecond,
          class IterativeSolver,
          class DirectSolver = DistributedSkylineLUDirectSolver<typename LocalPrecond::backend_type>>
class DistributedSubDomainDeflation
{
 public:
 
  typedef typename LocalPrecond::backend_type backend_type;
  typedef typename backend_type::params backend_params;
 
  struct params
  {
    typename LocalPrecond::params local;
    typename IterativeSolver::params isolver;
    typename DirectSolver::params dsolver;
 
    // Number of deflation vectors.
    Int32 num_def_vec = 0;
 
    // Value of deflation vector at the given row and column.
    std::function<double(ptrdiff_t, unsigned)> def_vec;
 
    params() {}
 
    params(const PropertyTree& p)
    : ARCCORE_ALINA_PARAMS_IMPORT_CHILD(p, local)
    , ARCCORE_ALINA_PARAMS_IMPORT_CHILD(p, isolver)
    , ARCCORE_ALINA_PARAMS_IMPORT_CHILD(p, dsolver)
    , ARCCORE_ALINA_PARAMS_IMPORT_VALUE(p, num_def_vec)
    {
      void* ptr = 0;
      ptr = p.get("def_vec", ptr);
 
      precondition(ptr, "Error in subdomain_deflation parameters: def_vec is not set");
 
      def_vec = *static_cast<std::function<double(ptrdiff_t, unsigned)>*>(ptr);
 
      p.check_params({ "local", "isolver", "dsolver", "num_def_vec", "def_vec" });
    }
 
    void get(PropertyTree& p, const std::string& path) const
    {
      ARCCORE_ALINA_PARAMS_EXPORT_CHILD(p, path, local);
      ARCCORE_ALINA_PARAMS_EXPORT_CHILD(p, path, isolver);
      ARCCORE_ALINA_PARAMS_EXPORT_CHILD(p, path, dsolver);
      ARCCORE_ALINA_PARAMS_EXPORT_VALUE(p, path, num_def_vec);
    }
  };
 
  typedef typename backend_type::value_type value_type;
  typedef typename math::scalar_of<value_type>::type scalar_type;
  typedef typename backend_type::matrix bmatrix;
  using col_type = backend_type::col_type;
  using ptr_type = backend_type::ptr_type;
  typedef typename backend_type::vector vector;
  typedef DistributedMatrix<backend_type> matrix;
 
  template <class Matrix>
  DistributedSubDomainDeflation(mpi_communicator comm,
                                const Matrix& Astrip,
                                const params& prm = params(),
                                const backend_params& bprm = backend_params())
  : comm(comm)
  , nrows(backend::nbRow(Astrip))
  , ndv(prm.num_def_vec)
  , dv_start(comm.size + 1, 0)
  , Z(ndv)
  , q(backend_type::create_vector(nrows, bprm))
  , S(nrows, prm.isolver, bprm, DistributedInnerProduct(comm))
  {
    A = std::make_shared<matrix>(comm, Astrip, nrows);
    init(prm, bprm);
  }
 
  DistributedSubDomainDeflation(mpi_communicator comm,
                                std::shared_ptr<matrix> A,
                                const params& prm = params(),
                                const backend_params& bprm = backend_params())
  : comm(comm)
  , nrows(A->loc_rows())
  , ndv(prm.num_def_vec)
  , A(A)
  , dv_start(comm.size + 1, 0)
  , Z(ndv)
  , q(backend_type::create_vector(nrows, bprm))
  , S(nrows, prm.isolver, bprm, DistributedInnerProduct(comm))
  {
    init(prm, bprm);
  }
 
  void init(const params& prm = params(),
            const backend_params& bprm = backend_params())
  {
    ARCCORE_ALINA_TIC("setup deflation");
    using build_matrix = CSRMatrix<value_type, col_type, ptr_type>;
 
    // Lets see how many deflation vectors are there.
    std::vector<ptrdiff_t> dv_size(comm.size);
 
    {
      ConstArrayView<ptrdiff_t> send_buf(1, &ndv);
      ArrayView<ptrdiff_t> receive_buf(comm.size, &dv_size[0]);
 
      mpAllGather(comm.m_message_passing_mng.get(), send_buf, receive_buf);
    }
 
    std::partial_sum(dv_size.begin(), dv_size.end(), dv_start.begin() + 1);
    nz = dv_start.back();
 
    df.resize(ndv);
    dx.resize(ndv);
    dd = backend_type::create_vector(ndv, bprm);
 
    auto az_loc = std::make_shared<build_matrix>();
    auto az_rem = std::make_shared<build_matrix>();
 
    auto a_loc = A->local();
    auto a_rem = A->remote();
 
    const CommunicationPattern<backend_type>& Acp = A->cpat();
 
    // Fill deflation vectors.
    ARCCORE_ALINA_TIC("copy deflation vectors");
    {
      std::vector<value_type> z(nrows);
      for (int j = 0; j < ndv; ++j) {
        arccoreParallelFor(0, nrows, ForLoopRunInfo{}, [&](Int32 begin, Int32 size) {
          for (ptrdiff_t i = begin; i < (begin + size); ++i)
            z[i] = prm.def_vec(i, j);
        });
        Z[j] = backend_type::copy_vector(z, bprm);
      }
    }
    ARCCORE_ALINA_TOC("copy deflation vectors");
 
    ARCCORE_ALINA_TIC("first pass");
    az_loc->set_size(nrows, ndv, true);
    az_loc->set_nonzeros(nrows * dv_size[comm.rank]);
    az_rem->set_size(nrows, 0, true);
    // 1. Build local part of AZ matrix.
    // 2. Count remote nonzeros
    arccoreParallelFor(0, nrows, ForLoopRunInfo{}, [&](Int32 begin, Int32 size) {
      std::vector<ptrdiff_t> marker(Acp.recv.nbr.size(), -1);
 
      for (ptrdiff_t i = begin; i < (begin + size); ++i) {
        ptrdiff_t az_loc_head = i * ndv;
        az_loc->ptr[i + 1] = az_loc_head + ndv;
 
        for (ptrdiff_t j = 0; j < ndv; ++j) {
          az_loc->col[az_loc_head + j] = j;
          az_loc->val[az_loc_head + j] = math::zero<value_type>();
        }
 
        for (ptrdiff_t j = a_loc->ptr[i], e = a_loc->ptr[i + 1]; j < e; ++j) {
          ptrdiff_t c = a_loc->col[j];
          value_type v = a_loc->val[j];
 
          for (ptrdiff_t j = 0; j < ndv; ++j)
            az_loc->val[az_loc_head + j] += v * prm.def_vec(c, j);
        }
 
        for (ptrdiff_t j = a_rem->ptr[i], e = a_rem->ptr[i + 1]; j < e; ++j) {
          int d = Acp.domain(a_rem->col[j]);
 
          if (marker[d] != i) {
            marker[d] = i;
            az_rem->ptr[i + 1] += dv_size[d];
          }
        }
      }
    });
 
    az_rem->set_nonzeros(az_rem->scan_row_sizes());
    ARCCORE_ALINA_TOC("first pass");
 
    // Create local preconditioner.
    ARCCORE_ALINA_TIC("local preconditioner");
    P = std::make_shared<LocalPrecond>(*a_loc, prm.local, bprm);
    ARCCORE_ALINA_TOC("local preconditioner");
 
    A->set_local(P->system_matrix_ptr());
    A->move_to_backend(bprm);
 
    ARCCORE_ALINA_TIC("remote(A*Z)");
    /* Construct remote part of AZ */
    // Exchange deflation vectors
    std::vector<ptrdiff_t> zrecv_ptr(Acp.recv.nbr.size() + 1, 0);
    std::vector<ptrdiff_t> zcol_ptr;
    zcol_ptr.reserve(Acp.recv.count() + 1);
    zcol_ptr.push_back(0);
 
    for (size_t i = 0; i < Acp.recv.nbr.size(); ++i) {
      ptrdiff_t ncols = Acp.recv.ptr[i + 1] - Acp.recv.ptr[i];
      ptrdiff_t nvecs = dv_size[Acp.recv.nbr[i]];
      ptrdiff_t size = nvecs * ncols;
      zrecv_ptr[i + 1] = zrecv_ptr[i] + size;
 
      for (ptrdiff_t j = 0; j < ncols; ++j)
        zcol_ptr.push_back(zcol_ptr.back() + nvecs);
    }
 
    std::vector<value_type> zrecv(zrecv_ptr.back());
    std::vector<value_type> zsend(Acp.send.count() * ndv);
 
    for (size_t i = 0; i < Acp.recv.nbr.size(); ++i) {
      ptrdiff_t begin = zrecv_ptr[i];
      ptrdiff_t size = zrecv_ptr[i + 1] - begin;
 
      Acp.recv.req[i] = comm.doIReceive(&zrecv[begin], size, Acp.recv.nbr[i], tag_exc_vals);
    }
 
    for (size_t i = 0, k = 0; i < Acp.send.count(); ++i)
      for (ptrdiff_t j = 0; j < ndv; ++j, ++k)
        zsend[k] = prm.def_vec(Acp.send.col[i], j);
 
    for (size_t i = 0; i < Acp.send.nbr.size(); ++i)
      Acp.send.req[i] = comm.doISend(&zsend[ndv * Acp.send.ptr[i]], ndv * (Acp.send.ptr[i + 1] - Acp.send.ptr[i]),
                                     Acp.send.nbr[i], tag_exc_vals);
 
    comm.waitAll(Acp.recv.req);
    comm.waitAll(Acp.send.req);
 
    arccoreParallelFor(0, nrows, ForLoopRunInfo{}, [&](Int32 begin, Int32 size) {
      std::vector<ptrdiff_t> marker(nz, -1);
 
      // AZ_rem = Arem * Z
      for (ptrdiff_t i = begin; i < (begin + size); ++i) {
        ptrdiff_t az_rem_head = az_rem->ptr[i];
        ptrdiff_t az_rem_tail = az_rem_head;
 
        for (auto a = backend::row_begin(*a_rem, i); a; ++a) {
          ptrdiff_t c = a.col();
          value_type v = a.value();
 
          // Domain the column belongs to
          ptrdiff_t d = Acp.recv.nbr[std::upper_bound(Acp.recv.ptr.begin(), Acp.recv.ptr.end(), c) -
                                     Acp.recv.ptr.begin() - 1];
 
          value_type* zval = &zrecv[zcol_ptr[c]];
          for (ptrdiff_t j = 0, k = dv_start[d]; j < dv_size[d]; ++j, ++k) {
            if (marker[k] < az_rem_head) {
              marker[k] = az_rem_tail;
              az_rem->col[az_rem_tail] = k;
              az_rem->val[az_rem_tail] = v * zval[j];
              ++az_rem_tail;
            }
            else {
              az_rem->val[marker[k]] += v * zval[j];
            }
          }
        }
      }
    });
    ARCCORE_ALINA_TOC("remote(A*Z)");
 
    /* Build solver for the deflated matrix E. */
    ARCCORE_ALINA_TIC("assemble E");
 
    // Count nonzeros in E.
    std::vector<int> nbrs; // processes we are talking to
    nbrs.reserve(1 + Acp.send.nbr.size() + Acp.recv.nbr.size());
    std::set_union(
    Acp.send.nbr.begin(), Acp.send.nbr.end(),
    Acp.recv.nbr.begin(), Acp.recv.nbr.end(),
    std::back_inserter(nbrs));
    nbrs.push_back(comm.rank);
 
    build_matrix E;
    E.set_size(ndv, nz, false);
 
    {
      ptrdiff_t nnz = 0;
      for (int j : nbrs)
        nnz += dv_size[j];
      for (int k = 0; k <= ndv; ++k)
        E.ptr[k] = k * nnz;
    }
    E.setNbNonZero(E.ptr[ndv]);
    E.set_nonzeros(E.ptr[ndv]);
 
    // Build local strip of E.
    int nthreads = ConcurrencyBase::maxAllowedThread();
    multi_array<value_type, 3> erow(nthreads, ndv, nz);
    std::fill_n(erow.data(), erow.size(), 0);
 
    {
      ptrdiff_t dv_offset = dv_start[comm.rank];
      arccoreParallelFor(0, nrows, ForLoopRunInfo{}, [&](Int32 begin, Int32 size) {
        const int tid = TaskFactory::currentTaskThreadIndex();
        std::vector<value_type> z(ndv);
 
        for (ptrdiff_t i = begin; i < (begin + size); ++i) {
          for (ptrdiff_t j = 0; j < ndv; ++j)
            z[j] = prm.def_vec(i, j);
 
          for (ptrdiff_t k = az_loc->ptr[i], e = az_loc->ptr[i + 1]; k < e; ++k) {
            ptrdiff_t c = az_loc->col[k] + dv_offset;
            value_type v = az_loc->val[k];
 
            for (ptrdiff_t j = 0; j < ndv; ++j)
              erow(tid, j, c) += v * z[j];
          }
 
          for (ptrdiff_t k = az_rem->ptr[i], e = az_rem->ptr[i + 1]; k < e; ++k) {
            ptrdiff_t c = az_rem->col[k];
            value_type v = az_rem->val[k];
 
            for (ptrdiff_t j = 0; j < ndv; ++j)
              erow(tid, j, c) += v * z[j];
          }
        }
      });
    }
 
    for (int i = 0; i < ndv; ++i) {
      int row_head = E.ptr[i];
      for (int j : nbrs) {
        for (int k = 0; k < dv_size[j]; ++k) {
          int c = dv_start[j] + k;
          value_type v = math::zero<value_type>();
          for (int t = 0; t < nthreads; ++t)
            v += erow(t, i, c);
 
          E.col[row_head] = c;
          E.val[row_head] = v;
 
          ++row_head;
        }
      }
    }
    ARCCORE_ALINA_TOC("assemble E");
 
    ARCCORE_ALINA_TIC("factorize E");
    this->E = std::make_shared<DirectSolver>(comm, E, prm.dsolver);
    ARCCORE_ALINA_TOC("factorize E");
 
    ARCCORE_ALINA_TIC("finish(A*Z)");
    AZ = std::make_shared<matrix>(comm, az_loc, az_rem);
    AZ->move_to_backend(bprm);
    ARCCORE_ALINA_TOC("finish(A*Z)");
    ARCCORE_ALINA_TOC("setup deflation");
  }
 
  template <class Vec1, class Vec2>
  void apply(const Vec1& rhs, Vec2&& x) const
  {
    size_t iters;
    double error;
    backend::clear(x);
    std::tie(iters, error) = (*this)(rhs, x);
  }
 
  std::shared_ptr<matrix> system_matrix_ptr() const
  {
    return A;
  }
 
  const matrix& system_matrix() const
  {
    return *A;
  }
 
  template <class Matrix, class Vec1, class Vec2>
  std::tuple<size_t, value_type> operator()(
  const Matrix& A, const Vec1& rhs, Vec2&& x) const
  {
    std::tuple<size_t, value_type> cnv = S(make_sdd_projected_matrix(*this, A), *P, rhs, x);
    postprocess(rhs, x);
    return cnv;
  }
 
  template <class Vec1, class Vec2>
  std::tuple<size_t, value_type>
  operator()(const Vec1& rhs, Vec2&& x) const
  {
    std::tuple<size_t, value_type> cnv = S(make_sdd_projected_matrix(*this, *A), *P, rhs, x);
    postprocess(rhs, x);
    return cnv;
  }
 
  size_t size() const
  {
    return nrows;
  }
 
  template <class Vector>
  void project(Vector& x) const
  {
    const auto one = math::identity<scalar_type>();
 
    ARCCORE_ALINA_TIC("project");
 
    ARCCORE_ALINA_TIC("local inner product");
    for (ptrdiff_t j = 0; j < ndv; ++j)
      df[j] = backend::inner_product(x, *Z[j]);
    ARCCORE_ALINA_TOC("local inner product");
 
    coarse_solve(df, dx);
 
    ARCCORE_ALINA_TIC("spmv");
    backend::copy(dx, *dd);
    backend::spmv(-one, *AZ, *dd, one, x);
    ARCCORE_ALINA_TOC("spmv");
 
    ARCCORE_ALINA_TOC("project");
  }
 
 private:
 
  static const int tag_exc_vals = 2011;
  static const int tag_exc_dmat = 3011;
  static const int tag_exc_dvec = 4011;
  static const int tag_exc_lnnz = 5011;
 
  mpi_communicator comm;
  ptrdiff_t nrows, ndv, nz;
 
  std::shared_ptr<matrix> A, AZ;
  std::shared_ptr<LocalPrecond> P;
 
  mutable std::vector<value_type> df, dx;
  std::vector<ptrdiff_t> dv_start;
 
  std::vector<std::shared_ptr<vector>> Z;
 
  std::shared_ptr<DirectSolver> E;
 
  std::shared_ptr<vector> q;
  std::shared_ptr<vector> dd;
 
  IterativeSolver S;
 
  void coarse_solve(std::vector<value_type>& f, std::vector<value_type>& x) const
  {
    ARCCORE_ALINA_TIC("coarse solve");
    (*E)(f, x);
    ARCCORE_ALINA_TOC("coarse solve");
  }
 
  template <class Vec1, class Vec2>
  void postprocess(const Vec1& rhs, Vec2& x) const
  {
    const auto one = math::identity<scalar_type>();
 
    ARCCORE_ALINA_TIC("postprocess");
 
    // q = rhs - Ax
    backend::copy(rhs, *q);
    backend::spmv(-one, *A, x, one, *q);
 
    // df = transp(Z) * (rhs - Ax)
    ARCCORE_ALINA_TIC("local inner product");
    for (ptrdiff_t j = 0; j < ndv; ++j)
      df[j] = backend::inner_product(*q, *Z[j]);
    ARCCORE_ALINA_TOC("local inner product");
 
    // dx = inv(E) * df
    coarse_solve(df, dx);
 
    // x += Z * dx
    backend::lin_comb(ndv, dx, Z, one, x);
 
    ARCCORE_ALINA_TOC("postprocess");
  }
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Arcane::Alina
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane::Alina::backend
{
 
template <class SDD, class Matrix,
          class Alpha, class Beta, class Vec1, class Vec2>
struct spmv_impl<Alpha, sdd_projected_matrix<SDD, Matrix>, Vec1, Beta, Vec2>
{
  typedef sdd_projected_matrix<SDD, Matrix> M;
 
  static void apply(Alpha alpha, const M& A, const Vec1& x, Beta beta, Vec2& y)
  {
    A.mul(alpha, x, beta, y);
  }
};
 
template <class SDD, class Matrix, class Vec1, class Vec2, class Vec3>
struct residual_impl<sdd_projected_matrix<SDD, Matrix>, Vec1, Vec2, Vec3>
{
  typedef sdd_projected_matrix<SDD, Matrix> M;
 
  static void apply(const Vec1& rhs, const M& A, const Vec2& x, Vec3& r)
  {
    A.residual(rhs, x, r);
  }
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Arcane::Alina::backend
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif