Amesos2_KokkosCrsMatrix_MatrixAdapter_decl.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//           Amesos2: Templated Direct Sparse Solver Package
//
// Copyright 2011 NTESS and the Amesos2 contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER


#ifndef AMESOS2_KOKKOSCRSMATRIX_MATRIXADAPTER_DECL_HPP
#define AMESOS2_KOKKOSCRSMATRIX_MATRIXADAPTER_DECL_HPP

#include "Amesos2_config.h"

#include "Amesos2_MatrixAdapter_decl.hpp"
#include "KokkosSparse_CrsMatrix.hpp"
#include "Amesos2_Kokkos_View_Copy_Assign.hpp"

namespace Amesos2 {

  template <typename Scalar,
            typename LocalOrdinal,
            typename ExecutionSpace>
  class ConcreteMatrixAdapter<KokkosSparse::CrsMatrix<Scalar, LocalOrdinal, ExecutionSpace>> :
    public MatrixAdapter<KokkosSparse::CrsMatrix<Scalar, LocalOrdinal, ExecutionSpace>>
  {
  public:
    typedef KokkosSparse::CrsMatrix<Scalar, LocalOrdinal, ExecutionSpace> matrix_t;

  public:
    typedef typename MatrixTraits<matrix_t>::scalar_t                 scalar_t;
    typedef typename MatrixTraits<matrix_t>::local_ordinal_t   local_ordinal_t;
    typedef typename MatrixTraits<matrix_t>::global_ordinal_t global_ordinal_t;
    typedef typename MatrixTraits<matrix_t>::node_t                     node_t;
    typedef typename MatrixTraits<matrix_t>::global_size_t       global_size_t;
    typedef Tpetra::Map<local_ordinal_t, global_ordinal_t, node_t>       map_t;
    typedef no_special_impl                                       get_crs_spec;
    typedef no_special_impl                                       get_ccs_spec;
    typedef ConcreteMatrixAdapter<matrix_t>                               type;
    typedef typename MatrixTraits<matrix_t>::major_access         major_access;

    ConcreteMatrixAdapter(Teuchos::RCP<matrix_t> m);

    Teuchos::RCP<const MatrixAdapter<matrix_t> > get_impl(const Teuchos::Ptr<const map_t> map, EDistribution distribution = ROOTED) const;
    Teuchos::RCP<const MatrixAdapter<matrix_t> > reindex_impl(Teuchos::RCP<const map_t> &contigRowMap,
                                                              Teuchos::RCP<const map_t> &contigColMap,
                                                              const EPhase current_phase) const;

    const Teuchos::RCP<const Teuchos::Comm<int> > getComm_impl() const;
    global_size_t getGlobalNumRows_impl() const;
    global_size_t getGlobalNumCols_impl() const;
    global_size_t getGlobalNNZ_impl() const;

    template<class KV>
    void getSparseRowPtr_kokkos_view(KV & view) const {
      deep_copy_or_assign_view(view, this->mat_->graph.row_map);
    }

    template<class KV>
    void getSparseColInd_kokkos_view(KV & view) const {
      deep_copy_or_assign_view(view, this->mat_->graph.entries);
    }

    template<class KV>
    void getSparseValues_kokkos_view(KV & view) const {
      deep_copy_or_assign_view(view, this->mat_->values);
    }

    size_t getGlobalRowNNZ_impl(global_ordinal_t row) const;
    size_t getLocalRowNNZ_impl(local_ordinal_t row) const;
    size_t getGlobalColNNZ_impl(global_ordinal_t col) const;
    size_t getLocalColNNZ_impl(local_ordinal_t col) const;

    global_size_t getRowIndexBase() const;
    global_size_t getColumnIndexBase() const;

    const Teuchos::RCP<const map_t>
    getMap_impl() const;

    const Teuchos::RCP<const map_t>
    getRowMap_impl() const;

    const Teuchos::RCP<const map_t>
    getColMap_impl() const;

    // implementation functions
    void getGlobalRowCopy_impl(global_ordinal_t row,
             const Teuchos::ArrayView<global_ordinal_t>& indices,
             const Teuchos::ArrayView<scalar_t>& vals,
             size_t& nnz) const;

    void getGlobalColCopy_impl(global_ordinal_t col,
             const Teuchos::ArrayView<global_ordinal_t>& indices,
             const Teuchos::ArrayView<scalar_t>& vals,
             size_t& nnz) const;


    template <typename KV_GO, typename KV_S>
    void getGlobalRowCopy_kokkos_view_impl(global_ordinal_t row,
                                           KV_GO & indices,
                                           KV_S & vals,
                                           size_t& nnz) const;

    template<typename KV_S, typename KV_GO, typename KV_GS, typename host_ordinal_type_array, typename host_scalar_type_array>
    LocalOrdinal gather_impl(KV_S& nzvals, KV_GO& indices, KV_GS& pointers,
                             host_ordinal_type_array &recvCounts, host_ordinal_type_array &recvDispls,
                             host_ordinal_type_array &transpose_map, host_scalar_type_array &nzvals_t,
                             bool column_major, EPhase current_phase) const;
  };

} // end namespace Amesos2

#endif  // AMESOS2_KOKKOSCRSMATRIX_MATRIXADAPTER_DECL_HPP