Amesos2 - Direct Sparse Solver Interfaces Version of the Day
Amesos2_KokkosCrsMatrix_MatrixAdapter_decl.hpp
Go to the documentation of this file.
1// @HEADER
2//
3// ***********************************************************************
4//
5// Amesos2: Templated Direct Sparse Solver Package
6// Copyright 2011 Sandia Corporation
7//
8// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9// the U.S. Government retains certain rights in this software.
10//
11// Redistribution and use in source and binary forms, with or without
12// modification, are permitted provided that the following conditions are
13// met:
14//
15// 1. Redistributions of source code must retain the above copyright
16// notice, this list of conditions and the following disclaimer.
17//
18// 2. Redistributions in binary form must reproduce the above copyright
19// notice, this list of conditions and the following disclaimer in the
20// documentation and/or other materials provided with the distribution.
21//
22// 3. Neither the name of the Corporation nor the names of the
23// contributors may be used to endorse or promote products derived from
24// this software without specific prior written permission.
25//
26// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37//
38// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
39//
40// ***********************************************************************
41//
42// @HEADER
43
44
54#ifndef AMESOS2_KOKKOSCRSMATRIX_MATRIXADAPTER_DECL_HPP
55#define AMESOS2_KOKKOSCRSMATRIX_MATRIXADAPTER_DECL_HPP
56
57#include "Amesos2_config.h"
58
59#include "Amesos2_MatrixAdapter_decl.hpp"
60#include "KokkosSparse_CrsMatrix.hpp"
62
63namespace Amesos2 {
64
73 template <typename Scalar,
74 typename LocalOrdinal,
75 typename ExecutionSpace>
76 class ConcreteMatrixAdapter<KokkosSparse::CrsMatrix<Scalar, LocalOrdinal, ExecutionSpace>> :
77 public MatrixAdapter<KokkosSparse::CrsMatrix<Scalar, LocalOrdinal, ExecutionSpace>>
78 {
79 public:
80 typedef KokkosSparse::CrsMatrix<Scalar, LocalOrdinal, ExecutionSpace> matrix_t;
81
82 public:
83 typedef typename MatrixTraits<matrix_t>::scalar_t scalar_t;
84 typedef typename MatrixTraits<matrix_t>::local_ordinal_t local_ordinal_t;
85 typedef typename MatrixTraits<matrix_t>::global_ordinal_t global_ordinal_t;
86 typedef typename MatrixTraits<matrix_t>::node_t node_t;
87 typedef typename MatrixTraits<matrix_t>::global_size_t global_size_t;
90 typedef ConcreteMatrixAdapter<matrix_t> type;
91 typedef typename MatrixTraits<matrix_t>::major_access major_access;
92
93 ConcreteMatrixAdapter(Teuchos::RCP<matrix_t> m);
94
95 Teuchos::RCP<const MatrixAdapter<matrix_t> > get_impl(const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > map, EDistribution distribution = ROOTED) const;
96
97 const Teuchos::RCP<const Teuchos::Comm<int> > getComm_impl() const;
98 global_size_t getGlobalNumRows_impl() const;
99 global_size_t getGlobalNumCols_impl() const;
100 global_size_t getGlobalNNZ_impl() const;
101
102 template<class KV>
103 void getSparseRowPtr_kokkos_view(KV & view) const {
104 deep_copy_or_assign_view(view, this->mat_->graph.row_map);
105 }
106
107 template<class KV>
108 void getSparseColInd_kokkos_view(KV & view) const {
109 deep_copy_or_assign_view(view, this->mat_->graph.entries);
110 }
111
112 template<class KV>
113 void getSparseValues_kokkos_view(KV & view) const {
114 deep_copy_or_assign_view(view, this->mat_->values);
115 }
116
117 size_t getGlobalRowNNZ_impl(global_ordinal_t row) const;
118 size_t getLocalRowNNZ_impl(local_ordinal_t row) const;
119 size_t getGlobalColNNZ_impl(global_ordinal_t col) const;
120 size_t getLocalColNNZ_impl(local_ordinal_t col) const;
121
122 global_size_t getRowIndexBase() const;
123 global_size_t getColumnIndexBase() const;
124
125 const Teuchos::RCP<const Tpetra::Map<local_ordinal_t,
126 global_ordinal_t,
127 node_t> >
128 getMap_impl() const;
129
130 const Teuchos::RCP<const Tpetra::Map<local_ordinal_t,
131 global_ordinal_t,
132 node_t> >
133 getRowMap_impl() const;
134
135 const Teuchos::RCP<const Tpetra::Map<local_ordinal_t,
136 global_ordinal_t,
137 node_t> >
138 getColMap_impl() const;
139
140 // implementation functions
141 void getGlobalRowCopy_impl(global_ordinal_t row,
142 const Teuchos::ArrayView<global_ordinal_t>& indices,
143 const Teuchos::ArrayView<scalar_t>& vals,
144 size_t& nnz) const;
145
146 void getGlobalColCopy_impl(global_ordinal_t col,
147 const Teuchos::ArrayView<global_ordinal_t>& indices,
148 const Teuchos::ArrayView<scalar_t>& vals,
149 size_t& nnz) const;
150
151
152 template <typename KV_GO, typename KV_S>
153 void getGlobalRowCopy_kokkos_view_impl(global_ordinal_t row,
154 KV_GO & indices,
155 KV_S & vals,
156 size_t& nnz) const;
157
158 };
159
160} // end namespace Amesos2
161
162#endif // AMESOS2_KOKKOSCRSMATRIX_MATRIXADAPTER_DECL_HPP
Copy or assign views based on memory spaces.
@ ROOTED
Definition Amesos2_TypeDecl.hpp:127
A Matrix adapter interface for Amesos2.
Definition Amesos2_MatrixAdapter_decl.hpp:76
EDistribution
Definition Amesos2_TypeDecl.hpp:123
Indicates that the concrete class can use the generic getC{c|r}s methods implemented in MatrixAdapter...
Definition Amesos2_TypeDecl.hpp:91