Ifpack2_Experimental_RBILUK_decl.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//       Ifpack2: Templated Object-Oriented Algebraic Preconditioner Package
//
// Copyright 2009 NTESS and the Ifpack2 contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER


#ifndef IFPACK2_EXPERIMENTALCRSRBILUK_DECL_HPP
#define IFPACK2_EXPERIMENTALCRSRBILUK_DECL_HPP

#include <Tpetra_BlockCrsMatrix.hpp>

#include <Ifpack2_RILUK.hpp>

namespace Ifpack2 {

namespace Experimental {

template <class MatrixType>
class RBILUK : virtual public Ifpack2::RILUK<Tpetra::RowMatrix<typename MatrixType::scalar_type,
                                                               typename MatrixType::local_ordinal_type, typename MatrixType::global_ordinal_type, typename MatrixType::node_type> > {
 public:

  typedef typename MatrixType::scalar_type scalar_type;

  // typedef typename MatrixType::impl_scalar_type impl_scalar_type;
  typedef typename Kokkos::ArithTraits<typename MatrixType::scalar_type>::val_type impl_scalar_type;

  typedef typename MatrixType::local_ordinal_type local_ordinal_type;
  typedef typename MatrixType::local_ordinal_type LO;

  typedef typename MatrixType::global_ordinal_type global_ordinal_type;
  typedef typename MatrixType::global_ordinal_type GO;

  typedef typename MatrixType::node_type node_type;

  typedef typename node_type::execution_space execution_space;

  typedef typename Teuchos::ScalarTraits<scalar_type>::magnitudeType magnitude_type;

  typedef Tpetra::RowMatrix<scalar_type,
                            local_ordinal_type,
                            global_ordinal_type,
                            node_type>
      row_matrix_type;

  typedef Tpetra::CrsMatrix<scalar_type,
                            local_ordinal_type,
                            global_ordinal_type,
                            node_type>
      crs_matrix_type;

  using crs_graph_type = Tpetra::CrsGraph<local_ordinal_type,
                                          global_ordinal_type,
                                          node_type>;

  typedef Tpetra::BlockCrsMatrix<scalar_type,
                                 local_ordinal_type,
                                 global_ordinal_type,
                                 node_type>
      block_crs_matrix_type;

  template <class NewMatrixType>
  friend class RBILUK;

  typedef typename block_crs_matrix_type::nonconst_global_inds_host_view_type nonconst_global_inds_host_view_type;
  typedef typename block_crs_matrix_type::nonconst_local_inds_host_view_type nonconst_local_inds_host_view_type;
  typedef typename block_crs_matrix_type::nonconst_values_host_view_type nonconst_values_host_view_type;



  typedef typename block_crs_matrix_type::local_matrix_device_type local_matrix_device_type;
  typedef typename block_crs_matrix_type::local_matrix_host_type local_matrix_host_type;
  typedef typename crs_matrix_type::local_matrix_device_type local_crs_matrix_device_type;
  typedef typename local_matrix_device_type::StaticCrsGraphType::row_map_type lno_row_view_t;
  typedef typename local_matrix_device_type::StaticCrsGraphType::entries_type lno_nonzero_view_t;
  typedef typename local_matrix_device_type::values_type scalar_nonzero_view_t;
  typedef typename local_matrix_device_type::StaticCrsGraphType::device_type::memory_space TemporaryMemorySpace;
  typedef typename local_matrix_device_type::StaticCrsGraphType::device_type::memory_space PersistentMemorySpace;
  typedef typename local_matrix_device_type::StaticCrsGraphType::device_type::execution_space HandleExecSpace;
  typedef typename KokkosKernels::Experimental::KokkosKernelsHandle<typename lno_row_view_t::const_value_type, typename lno_nonzero_view_t::const_value_type, typename scalar_nonzero_view_t::value_type,
                                                                    HandleExecSpace, TemporaryMemorySpace, PersistentMemorySpace>
      kk_handle_type;



  RBILUK(const Teuchos::RCP<const row_matrix_type>& A_in);

  RBILUK(const Teuchos::RCP<const block_crs_matrix_type>& A_in);

 private:
  RBILUK(const RBILUK<MatrixType>& src);

 public:
  virtual ~RBILUK();

  void initialize();

  void compute();



  // Declare that we intend to overload RILUK::setMatrix, not hide it.
  // This avoids build warnings that the method below "hides
  // overloaded virtual function" (e.g., Clang 3.5).
  //
  // NOTE: If the base class of this class changes, e.g., if its
  // template parameter changes, then be sure to change the code below
  // to refer to the proper base class.
  using RILUK<Tpetra::RowMatrix<typename MatrixType::scalar_type,
                                typename MatrixType::local_ordinal_type,
                                typename MatrixType::global_ordinal_type,
                                typename MatrixType::node_type> >::setMatrix;

  void
  setMatrix(const Teuchos::RCP<const block_crs_matrix_type>& A);



  std::string description() const;



  void
  apply(const Tpetra::MultiVector<scalar_type, local_ordinal_type, global_ordinal_type, node_type>& X,
        Tpetra::MultiVector<scalar_type, local_ordinal_type, global_ordinal_type, node_type>& Y,
        Teuchos::ETransp mode = Teuchos::NO_TRANS,
        scalar_type alpha     = Teuchos::ScalarTraits<scalar_type>::one(),
        scalar_type beta      = Teuchos::ScalarTraits<scalar_type>::zero()) const;

 public:
  Teuchos::RCP<const block_crs_matrix_type> getBlockMatrix() const;

  const block_crs_matrix_type& getLBlock() const;

  const block_crs_matrix_type& getDBlock() const;

  const block_crs_matrix_type& getUBlock() const;

 private:
  typedef Tpetra::MultiVector<scalar_type, local_ordinal_type, global_ordinal_type, node_type> MV;
  typedef Teuchos::ScalarTraits<impl_scalar_type> STS;
  typedef Teuchos::ScalarTraits<magnitude_type> STM;
  typedef typename block_crs_matrix_type::little_block_type little_block_type;
  typedef typename block_crs_matrix_type::little_block_host_type little_block_host_type;
  typedef typename block_crs_matrix_type::little_vec_type little_vec_type;
  typedef typename block_crs_matrix_type::little_host_vec_type little_host_vec_type;
  typedef typename block_crs_matrix_type::const_host_little_vec_type const_host_little_vec_type;

  using local_inds_host_view_type   = typename block_crs_matrix_type::local_inds_host_view_type;
  using values_host_view_type       = typename block_crs_matrix_type::values_host_view_type;
  using local_inds_device_view_type = typename block_crs_matrix_type::local_inds_device_view_type;
  using values_device_view_type     = typename block_crs_matrix_type::values_device_view_type;
  using view1d                      = Kokkos::View<impl_scalar_type*, typename values_device_view_type::device_type>;

  void allocate_L_and_U_blocks();
  void initAllValues();

  template <typename X, typename Y>
  void stream_apply_impl(const X& X_views, Y& Y_views, const bool use_temp_x, const bool use_temp_y, const std::vector<Teuchos::RCP<block_crs_matrix_type> >& LU_block_v, const std::vector<Teuchos::RCP<kk_handle_type> >& LU_sptrsv_handle_v, const LO numVecs) const;

  Teuchos::RCP<kk_handle_type> KernelHandle_block_;
  Teuchos::RCP<kk_handle_type> L_Sptrsv_KernelHandle_;
  Teuchos::RCP<kk_handle_type> U_Sptrsv_KernelHandle_;

  std::vector<Teuchos::RCP<kk_handle_type> > KernelHandle_block_v_;
  std::vector<Teuchos::RCP<kk_handle_type> > L_Sptrsv_KernelHandle_v_;
  std::vector<Teuchos::RCP<kk_handle_type> > U_Sptrsv_KernelHandle_v_;

  local_ordinal_type blockSize_;

  Teuchos::RCP<const block_crs_matrix_type> A_local_bcrs_;
  Teuchos::RCP<crs_matrix_type> A_local_crs_nc_;

  std::vector<local_matrix_device_type> A_block_local_diagblks_v_;
  std::vector<lno_row_view_t> A_block_local_diagblks_rowmap_v_;
  std::vector<lno_nonzero_view_t> A_block_local_diagblks_entries_v_;
  std::vector<scalar_nonzero_view_t> A_block_local_diagblks_values_v_;

  Teuchos::RCP<block_crs_matrix_type> L_block_;
  std::vector<Teuchos::RCP<block_crs_matrix_type> > L_block_v_;
  Teuchos::RCP<block_crs_matrix_type> U_block_;
  std::vector<Teuchos::RCP<block_crs_matrix_type> > U_block_v_;
  Teuchos::RCP<block_crs_matrix_type> D_block_;

  Teuchos::RCP<block_crs_matrix_type> D_block_inverse_;

  view1d tmp_;
};

}  // namespace Experimental

}  // namespace Ifpack2

#endif /* IFPACK2_EXPERIMENTALCRSRBILUK_DECL_HPP */