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_TPETRA_INST_INT_INT
54 #ifdef HAVE_AMESOS2_EPETRA
55 # include <Epetra_RowMatrix.h>
56 # include <Epetra_CrsMatrix.h>
57 // # include <Epetra_MsrMatrix.h>
58 # include <Epetra_VbrMatrix.h>
59 // and perhaps some others later...
60 #endif
61 #endif
62 
63 #include "Amesos2_Util.hpp"
64 
65 namespace Amesos2 {
66 
67  // The declaration
68  template <class Matrix>
69  struct MatrixTraits {};
70 
71  /*******************
72  * Specializations *
73  *******************/
74 
75  template < typename Scalar,
76  typename LocalOrdinal,
77  typename GlobalOrdinal,
78  typename Node >
79  struct MatrixTraits<
80  Tpetra::RowMatrix<Scalar,
81  LocalOrdinal,
82  GlobalOrdinal,
83  Node> > {
84  typedef Scalar scalar_t;
85  typedef LocalOrdinal local_ordinal_t;
86  typedef GlobalOrdinal global_ordinal_t;
87  typedef Node node_t;
88 
89  typedef Tpetra::RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> matrix_type;
90  typedef typename matrix_type::local_matrix_type local_matrix_t;
91  typedef typename matrix_type::local_matrix_type::row_map_type::pointer_type sparse_ptr_type;
92  typedef typename matrix_type::local_matrix_type::index_type::pointer_type sparse_idx_type;
93  typedef typename matrix_type::local_matrix_type::values_type::pointer_type sparse_values_type;
94 
95  typedef row_access major_access;
96  };
97 
98  template < typename Scalar,
99  typename LocalOrdinal,
100  typename GlobalOrdinal,
101  typename Node >
102  struct MatrixTraits<
103  Tpetra::CrsMatrix<Scalar,
104  LocalOrdinal,
105  GlobalOrdinal,
106  Node> > {
107  typedef Scalar scalar_t;
108  typedef LocalOrdinal local_ordinal_t;
109  typedef GlobalOrdinal global_ordinal_t;
110  typedef Node node_t;
111 
112  typedef Tpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> matrix_type;
113  typedef typename matrix_type::local_matrix_type local_matrix_t;
114  typedef typename matrix_type::local_matrix_type::row_map_type::pointer_type sparse_ptr_type;
115  typedef typename matrix_type::local_matrix_type::index_type::pointer_type sparse_idx_type;
116  typedef typename matrix_type::local_matrix_type::values_type::pointer_type sparse_values_type;
117 
118  typedef row_access major_access;
119  };
120 
121 
122 #ifdef HAVE_TPETRA_INST_INT_INT
123 #ifdef HAVE_AMESOS2_EPETRA
124 
125  template <>
126  struct MatrixTraits<Epetra_RowMatrix> {
127  typedef double scalar_t;
128  typedef int local_ordinal_t;
129  typedef int global_ordinal_t;
130  typedef Tpetra::Map<>::node_type node_t;
131 
132  typedef Epetra_RowMatrix matrix_type;
133  typedef matrix_type local_matrix_t;
134  typedef int* sparse_ptr_type;
135  typedef int* sparse_idx_type;
136  typedef double* sparse_values_type;
137 
138  typedef row_access major_access;
139  };
140 
141  template <>
142  struct MatrixTraits<Epetra_CrsMatrix> {
143  typedef double scalar_t;
144  typedef int local_ordinal_t;
145  typedef int global_ordinal_t;
146  typedef Tpetra::Map<>::node_type node_t;
147 
148  typedef Epetra_CrsMatrix matrix_type;
149  typedef matrix_type local_matrix_t;
150  typedef int* sparse_ptr_type;
151  typedef int* sparse_idx_type;
152  typedef double* sparse_values_type;
153 
154  typedef row_access major_access;
155  };
156 
157  // template <>
158  // struct MatrixTraits<Epetra_MsrMatrix> {
159  // typedef double scalar_t;
160  // typedef int local_ordinal_t;
161  // typedef int global_ordinal_t;
162  // typedef Tpetra::Map<>::node_type node_t;
163 
164  // typedef row_access major_access;
165  // };
166 
167  template <>
168  struct MatrixTraits<Epetra_VbrMatrix> {
169  typedef double scalar_t;
170  typedef int local_ordinal_t;
171  typedef int global_ordinal_t;
172  typedef Tpetra::Map<>::node_type node_t;
173 
174  typedef Epetra_VbrMatrix matrix_type;
175  typedef matrix_type local_matrix_t;
176  typedef int* sparse_ptr_type;
177  typedef int* sparse_idx_type;
178  typedef double* sparse_values_type;
179 
180  typedef row_access major_access;
181  };
182 
183 #endif
184 #endif
185 
186 }
187 
188 #endif // AMESOS2_MATRIXTRAITS_HPP
Utility functions for Amesos2.
Definition: Amesos2_AbstractConcreteMatrixAdapter.hpp:48