Amesos2 - Direct Sparse Solver Interfaces Version of the Day
Amesos2_MatrixTraits.hpp
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
45#ifndef AMESOS2_MATRIXTRAITS_HPP
46#define AMESOS2_MATRIXTRAITS_HPP
47
48#include "Amesos2_config.h"
49
50#include <Tpetra_CrsMatrix.hpp>
51
52
53#ifdef HAVE_AMESOS2_EPETRA
54# include <Epetra_RowMatrix.h>
55# include <Epetra_CrsMatrix.h>
56// # include <Epetra_MsrMatrix.h>
57# include <Epetra_VbrMatrix.h>
58// and perhaps some others later...
59#endif
60
61#include "Amesos2_Util.hpp"
62
63namespace Amesos2 {
64
65 // The declaration
66 template <class Matrix>
67 struct MatrixTraits {};
68
69 /*******************
70 * Specializations *
71 *******************/
72
73 template < typename Scalar,
74 typename LocalOrdinal,
75 typename GlobalOrdinal,
76 typename Node >
77 struct MatrixTraits<
78 Tpetra::RowMatrix<Scalar,
79 LocalOrdinal,
80 GlobalOrdinal,
81 Node> > {
82 typedef Scalar scalar_t;
83 typedef LocalOrdinal local_ordinal_t;
84 typedef GlobalOrdinal global_ordinal_t;
85 typedef Node node_t;
86
87 typedef Tpetra::RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> matrix_type;
88 #ifdef TPETRA_ENABLE_DEPRECATED_CODE
89 typedef typename matrix_type::local_matrix_type local_matrix_t;
90 typedef typename matrix_type::local_matrix_type::row_map_type::pointer_type sparse_ptr_type;
91 typedef typename matrix_type::local_matrix_type::index_type::pointer_type sparse_idx_type;
92 typedef typename matrix_type::local_matrix_type::values_type::pointer_type sparse_values_type;
93 #endif
94
95 typedef typename matrix_type::nonconst_global_inds_host_view_type global_host_idx_type;
96 typedef typename matrix_type::nonconst_values_host_view_type global_host_val_type;
97
98 typedef row_access major_access;
99 };
100
101 template < typename Scalar,
102 typename LocalOrdinal,
103 typename GlobalOrdinal,
104 typename Node >
105 struct MatrixTraits<
106 Tpetra::CrsMatrix<Scalar,
107 LocalOrdinal,
108 GlobalOrdinal,
109 Node> > {
110 typedef Scalar scalar_t;
111 typedef LocalOrdinal local_ordinal_t;
112 typedef GlobalOrdinal global_ordinal_t;
113 typedef Node node_t;
114
115 typedef Tpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> matrix_type;
116 #ifdef TPETRA_ENABLE_DEPRECATED_CODE
117 typedef typename matrix_type::local_matrix_type local_matrix_t;
118 typedef typename matrix_type::local_matrix_type::row_map_type::pointer_type sparse_ptr_type;
119 typedef typename matrix_type::local_matrix_type::index_type::pointer_type sparse_idx_type;
120 typedef typename matrix_type::local_matrix_type::values_type::pointer_type sparse_values_type;
121 #endif
122
123 typedef typename matrix_type::nonconst_global_inds_host_view_type global_host_idx_type;
124 typedef typename matrix_type::nonconst_values_host_view_type global_host_val_type;
125
126 typedef row_access major_access;
127 };
128
129 template < typename Scalar,
130 typename LocalOrdinal,
131 typename DeviceType >
132 struct MatrixTraits<
133 KokkosSparse::CrsMatrix<Scalar,
134 LocalOrdinal,
135 DeviceType> > {
136 typedef Scalar scalar_t;
137 typedef LocalOrdinal local_ordinal_t;
138 typedef Tpetra::Map<>::global_ordinal_type global_ordinal_t;
139 typedef LocalOrdinal global_size_t;
140
141 typedef KokkosSparse::CrsMatrix<Scalar, LocalOrdinal, DeviceType> matrix_type;
142 typedef Tpetra::Map<>::node_type node_t;
143
144 #ifdef TPETRA_ENABLE_DEPRECATED_CODE
145 typedef matrix_type local_matrix_t; // is the same right now
146 typedef typename matrix_type::row_map_type::value_type * sparse_ptr_type;
147 typedef typename matrix_type::ordinal_type * sparse_idx_type;
148 typedef typename matrix_type::value_type * sparse_values_type;
149 #endif
150
151 typedef typename matrix_type::HostMirror::index_type global_host_idx_type;
152 typedef typename matrix_type::HostMirror::values_type global_host_val_type;
153
154 typedef row_access major_access;
155 };
156
157#ifdef HAVE_AMESOS2_EPETRA
158
159 template <>
160 struct MatrixTraits<Epetra_RowMatrix> {
161 typedef double scalar_t;
162 typedef int local_ordinal_t;
163 typedef Tpetra::Map<>::global_ordinal_type global_ordinal_t;
164 typedef Tpetra::Map<>::node_type node_t;
165
166 typedef Epetra_RowMatrix matrix_type;
167 typedef matrix_type local_matrix_t;
168 typedef int* sparse_ptr_type;
169 typedef int* sparse_idx_type;
170 typedef double* sparse_values_type;
171
172 typedef Kokkos::View<global_ordinal_t*, Kokkos::HostSpace> global_host_idx_type;
173 typedef Kokkos::View<scalar_t*, Kokkos::HostSpace> global_host_val_type;
174
175 typedef row_access major_access;
176 };
177
178 template <>
179 struct MatrixTraits<Epetra_CrsMatrix> {
180 typedef double scalar_t;
181 typedef int local_ordinal_t;
182 typedef Tpetra::Map<>::global_ordinal_type global_ordinal_t;
183 typedef Tpetra::Map<>::node_type node_t;
184
185 typedef Epetra_CrsMatrix matrix_type;
186 typedef matrix_type local_matrix_t;
187 typedef int* sparse_ptr_type;
188 typedef int* sparse_idx_type;
189 typedef double* sparse_values_type;
190
191 typedef Kokkos::View<global_ordinal_t*, Kokkos::HostSpace> global_host_idx_type;
192 typedef Kokkos::View<scalar_t*, Kokkos::HostSpace> global_host_val_type;
193
194 typedef row_access major_access;
195 };
196
197 // template <>
198 // struct MatrixTraits<Epetra_MsrMatrix> {
199 // typedef double scalar_t;
200 // typedef int local_ordinal_t;
201 // typedef Tpetra::Map<>::global_ordinal_type global_ordinal_t;
202 // typedef Tpetra::Map<>::node_type node_t;
203
204 // typedef row_access major_access;
205 // };
206
207 template <>
208 struct MatrixTraits<Epetra_VbrMatrix> {
209 typedef double scalar_t;
210 typedef int local_ordinal_t;
211 typedef Tpetra::Map<>::global_ordinal_type global_ordinal_t;
212 typedef Tpetra::Map<>::node_type node_t;
213
214 typedef Epetra_VbrMatrix matrix_type;
215 typedef matrix_type local_matrix_t;
216 typedef int* sparse_ptr_type;
217 typedef int* sparse_idx_type;
218 typedef double* sparse_values_type;
219
220 typedef row_access major_access;
221 };
222
223#endif
224
225}
226
227#endif // AMESOS2_MATRIXTRAITS_HPP
Amesos2_Util.hpp
Utility functions for Amesos2.
Generated by doxygen 1.9.4