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 typedef typename matrix_type::impl_scalar_type impl_scalar_type;
89
90 typedef typename matrix_type::nonconst_global_inds_host_view_type global_host_idx_type;
91 typedef typename matrix_type::nonconst_values_host_view_type global_host_val_type;
92
93 typedef row_access major_access;
94 };
95
96 template < typename Scalar,
97 typename LocalOrdinal,
98 typename GlobalOrdinal,
99 typename Node >
100 struct MatrixTraits<
101 Tpetra::CrsMatrix<Scalar,
102 LocalOrdinal,
103 GlobalOrdinal,
104 Node> > {
105 typedef Scalar scalar_t;
106 typedef LocalOrdinal local_ordinal_t;
107 typedef GlobalOrdinal global_ordinal_t;
108 typedef Node node_t;
109
110 typedef Tpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> matrix_type;
111 typedef typename matrix_type::impl_scalar_type impl_scalar_type;
112
113 typedef typename matrix_type::nonconst_global_inds_host_view_type global_host_idx_type;
114 typedef typename matrix_type::nonconst_values_host_view_type global_host_val_type;
115
116 typedef row_access major_access;
117 };
118
119 template < typename Scalar,
120 typename LocalOrdinal,
121 typename DeviceType >
122 struct MatrixTraits<
123 KokkosSparse::CrsMatrix<Scalar,
124 LocalOrdinal,
125 DeviceType> > {
126 typedef Scalar scalar_t;
127 typedef LocalOrdinal local_ordinal_t;
128 typedef Tpetra::Map<>::global_ordinal_type global_ordinal_t;
129 typedef LocalOrdinal global_size_t;
130
131 typedef KokkosSparse::CrsMatrix<Scalar, LocalOrdinal, DeviceType> matrix_type;
132 typedef Scalar impl_scalar_type;
133 typedef Tpetra::Map<>::node_type node_t;
134
135 typedef typename matrix_type::HostMirror::index_type global_host_idx_type;
136 typedef typename matrix_type::HostMirror::values_type global_host_val_type;
137
138 typedef row_access major_access;
139 };
140
141#ifdef HAVE_AMESOS2_EPETRA
142
143 template <>
144 struct MatrixTraits<Epetra_RowMatrix> {
145 typedef double scalar_t;
146 typedef double impl_scalar_type;
147 typedef int local_ordinal_t;
148 typedef Tpetra::Map<>::global_ordinal_type global_ordinal_t;
149 typedef Tpetra::Map<>::node_type node_t;
150
151 typedef Epetra_RowMatrix matrix_type;
152 typedef matrix_type local_matrix_t;
153 typedef int* sparse_ptr_type;
154 typedef int* sparse_idx_type;
155 typedef double* sparse_values_type;
156
157 typedef Kokkos::View<global_ordinal_t*, Kokkos::HostSpace> global_host_idx_type;
158 typedef Kokkos::View<scalar_t*, Kokkos::HostSpace> global_host_val_type;
159
160 typedef row_access major_access;
161 };
162
163 template <>
164 struct MatrixTraits<Epetra_CrsMatrix> {
165 typedef double scalar_t;
166 typedef double impl_scalar_type;
167 typedef int local_ordinal_t;
168 typedef Tpetra::Map<>::global_ordinal_type global_ordinal_t;
169 typedef Tpetra::Map<>::node_type node_t;
170
171 typedef Epetra_CrsMatrix matrix_type;
172 typedef matrix_type local_matrix_t;
173 typedef int* sparse_ptr_type;
174 typedef int* sparse_idx_type;
175 typedef double* sparse_values_type;
176
177 typedef Kokkos::View<global_ordinal_t*, Kokkos::HostSpace> global_host_idx_type;
178 typedef Kokkos::View<scalar_t*, Kokkos::HostSpace> global_host_val_type;
179
180 typedef row_access major_access;
181 };
182
183 // template <>
184 // struct MatrixTraits<Epetra_MsrMatrix> {
185 // typedef double scalar_t;
186 // typedef int local_ordinal_t;
187 // typedef Tpetra::Map<>::global_ordinal_type global_ordinal_t;
188 // typedef Tpetra::Map<>::node_type node_t;
189
190 // typedef row_access major_access;
191 // };
192
193 template <>
194 struct MatrixTraits<Epetra_VbrMatrix> {
195 typedef double scalar_t;
196 typedef double impl_scalar_type;
197 typedef int local_ordinal_t;
198 typedef Tpetra::Map<>::global_ordinal_type global_ordinal_t;
199 typedef Tpetra::Map<>::node_type node_t;
200
201 typedef Epetra_VbrMatrix matrix_type;
202 typedef matrix_type local_matrix_t;
203 typedef int* sparse_ptr_type;
204 typedef int* sparse_idx_type;
205 typedef double* sparse_values_type;
206
207 typedef row_access major_access;
208 };
209
210#endif
211
212}
213
214#endif // AMESOS2_MATRIXTRAITS_HPP
Amesos2_Util.hpp
Utility functions for Amesos2.
Generated by doxygen 1.17.0