trilinos_tpetra_block_sparse_matrix.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) 2024 - 2026 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_tpetra_trilinos_block_sparse_matrix_h
#define dealii_tpetra_trilinos_block_sparse_matrix_h
 
 
#include <deal.II/base/config.h>
 
#ifdef DEAL_II_TRILINOS_WITH_TPETRA
 
#  include <deal.II/base/template_constraints.h>
 
#  include <deal.II/lac/block_matrix_base.h>
#  include <deal.II/lac/block_sparse_matrix.h>
#  include <deal.II/lac/exceptions.h>
#  include <deal.II/lac/full_matrix.h>
#  include <deal.II/lac/trilinos_tpetra_block_vector.h>
#  include <deal.II/lac/trilinos_tpetra_sparse_matrix.h>
 
#  include <cmath>
 
#endif // DEAL_II_TRILINOS_WITH_TPETRA
 
DEAL_II_NAMESPACE_OPEN
 
#ifdef DEAL_II_TRILINOS_WITH_TPETRA
// forward declarations
#  ifndef DOXYGEN
class BlockSparsityPattern;
template <typename number>
class BlockSparseMatrix;
#  endif
 
namespace LinearAlgebra
{
  namespace TpetraWrappers
  {
    template <typename Number, typename MemorySpace = ::MemorySpace::Host>
    class BlockSparseMatrix
      : public BlockMatrixBase<SparseMatrix<Number, MemorySpace>>
    {
    public:
      using BaseClass = BlockMatrixBase<SparseMatrix<Number, MemorySpace>>;
 
      using BlockType = typename BaseClass::BlockType;
 
      using value_type      = typename BaseClass::value_type;
      using pointer         = typename BaseClass::pointer;
      using const_pointer   = typename BaseClass::const_pointer;
      using reference       = typename BaseClass::reference;
      using const_reference = typename BaseClass::const_reference;
      using size_type       = typename BaseClass::size_type;
      using iterator        = typename BaseClass::iterator;
      using const_iterator  = typename BaseClass::const_iterator;
 
      BlockSparseMatrix() = default;
 
      ~BlockSparseMatrix() override;
 
      BlockSparseMatrix<Number, MemorySpace> &
      operator=(const BlockSparseMatrix<Number, MemorySpace> &) = default;
 
      BlockSparseMatrix<Number, MemorySpace> &
      operator=(const Number d);
 
      void
      reinit(const size_type n_block_rows, const size_type n_block_columns);
 
      template <typename BlockSparsityPatternType>
      void
      reinit(const std::vector<IndexSet>    &input_maps,
             const BlockSparsityPatternType &block_sparsity_pattern,
             const MPI_Comm                  communicator  = MPI_COMM_WORLD,
             const bool                      exchange_data = false);
 
      template <typename BlockSparsityPatternType>
      void
      reinit(const BlockSparsityPatternType &block_sparsity_pattern);
 
      void
      reinit(
        const std::vector<IndexSet>               &parallel_partitioning,
        const ::BlockSparseMatrix<double> &dealii_block_sparse_matrix,
        const MPI_Comm communicator   = MPI_COMM_WORLD,
        const double   drop_tolerance = 1e-13);
 
      void
      reinit(const ::BlockSparseMatrix<double> &deal_ii_sparse_matrix,
             const double                               drop_tolerance = 1e-13);
 
      bool
      is_compressed() const;
 
      void
      collect_sizes();
 
      std::uint64_t
      n_nonzero_elements() const;
 
      MPI_Comm
      get_mpi_communicator() const;
 
      std::vector<IndexSet>
      locally_owned_domain_indices() const;
 
      std::vector<IndexSet>
      locally_owned_range_indices() const;
 
      template <typename VectorType1, typename VectorType2>
      void
      vmult(VectorType1 &dst, const VectorType2 &src) const;
 
      template <typename VectorType1, typename VectorType2>
      void
      Tvmult(VectorType1 &dst, const VectorType2 &src) const;
 
      template <typename VectorType1,
                typename VectorType2,
                typename VectorType3>
      Number
      residual(VectorType1       &dst,
               const VectorType2 &x,
               const VectorType3 &b) const;
 
      using BlockMatrixBase<SparseMatrix<Number, MemorySpace>>::clear;
 
    private:
      template <typename VectorType1, typename VectorType2>
      void
      vmult(VectorType1       &dst,
            const VectorType2 &src,
            const bool         transpose,
            const std::bool_constant<true>,
            const std::bool_constant<true>) const;
 
      template <typename VectorType1, typename VectorType2>
      void
      vmult(VectorType1       &dst,
            const VectorType2 &src,
            const bool         transpose,
            const std::bool_constant<false>,
            const std::bool_constant<true>) const;
 
      template <typename VectorType1, typename VectorType2>
      void
      vmult(VectorType1       &dst,
            const VectorType2 &src,
            const bool         transpose,
            const std::bool_constant<true>,
            const std::bool_constant<false>) const;
 
      template <typename VectorType1, typename VectorType2>
      void
      vmult(VectorType1       &dst,
            const VectorType2 &src,
            const bool         transpose,
            const std::bool_constant<false>,
            const std::bool_constant<false>) const;
    };
 
  } // namespace TpetraWrappers
 
  // ------------- inline and template functions -----------------
  namespace TpetraWrappers
  {
    template <typename Number, typename MemorySpace>
    template <typename VectorType1, typename VectorType2>
    inline void
    BlockSparseMatrix<Number, MemorySpace>::vmult(VectorType1       &dst,
                                                  const VectorType2 &src) const
    {
      vmult(dst,
            src,
            false,
            std::bool_constant<IsBlockVector<VectorType1>::value>(),
            std::bool_constant<IsBlockVector<VectorType2>::value>());
    }
 
 
 
    template <typename Number, typename MemorySpace>
    template <typename VectorType1, typename VectorType2>
    inline void
    BlockSparseMatrix<Number, MemorySpace>::Tvmult(VectorType1       &dst,
                                                   const VectorType2 &src) const
    {
      vmult(dst,
            src,
            true,
            std::bool_constant<IsBlockVector<VectorType1>::value>(),
            std::bool_constant<IsBlockVector<VectorType2>::value>());
    }
 
 
 
    template <typename Number, typename MemorySpace>
    template <typename VectorType1, typename VectorType2>
    inline void
    BlockSparseMatrix<Number, MemorySpace>::vmult(
      VectorType1       &dst,
      const VectorType2 &src,
      const bool         transpose,
      std::bool_constant<true>,
      std::bool_constant<true>) const
    {
      if (transpose == true)
        BaseClass::Tvmult_block_block(dst, src);
      else
        BaseClass::vmult_block_block(dst, src);
    }
 
 
 
    template <typename Number, typename MemorySpace>
    template <typename VectorType1, typename VectorType2>
    inline void
    BlockSparseMatrix<Number, MemorySpace>::vmult(
      VectorType1       &dst,
      const VectorType2 &src,
      const bool         transpose,
      std::bool_constant<false>,
      std::bool_constant<true>) const
    {
      if (transpose == true)
        BaseClass::Tvmult_nonblock_block(dst, src);
      else
        BaseClass::vmult_nonblock_block(dst, src);
    }
 
 
 
    template <typename Number, typename MemorySpace>
    template <typename VectorType1, typename VectorType2>
    inline void
    BlockSparseMatrix<Number, MemorySpace>::vmult(
      VectorType1       &dst,
      const VectorType2 &src,
      const bool         transpose,
      std::bool_constant<true>,
      std::bool_constant<false>) const
    {
      if (transpose == true)
        BaseClass::Tvmult_block_nonblock(dst, src);
      else
        BaseClass::vmult_block_nonblock(dst, src);
    }
 
 
 
    template <typename Number, typename MemorySpace>
    template <typename VectorType1, typename VectorType2>
    inline void
    BlockSparseMatrix<Number, MemorySpace>::vmult(
      VectorType1       &dst,
      const VectorType2 &src,
      const bool         transpose,
      std::bool_constant<false>,
      std::bool_constant<false>) const
    {
      if (transpose == true)
        BaseClass::Tvmult_nonblock_nonblock(dst, src);
      else
        BaseClass::vmult_nonblock_nonblock(dst, src);
    }
  } // namespace TpetraWrappers
 
} // namespace LinearAlgebra
 
#endif // DEAL_II_TRILINOS_WITH_TPETRA
 
DEAL_II_NAMESPACE_CLOSE
 
#endif // dealii_tpetra_trilinos_block_sparse_matrix_h