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 <Tpetra_DefaultPlatform.hpp>
56 # include <Epetra_RowMatrix.h>
57 # include <Epetra_CrsMatrix.h>
58 // # include <Epetra_MsrMatrix.h>
59 # include <Epetra_VbrMatrix.h>
60 // and perhaps some others later...
61 #endif
62 #endif
63 
64 #include "Amesos2_Util.hpp"
65 
66 namespace Amesos2 {
67 
68  // The declaration
69  template <class Matrix>
70  struct MatrixTraits {};
71 
72  /*******************
73  * Specializations *
74  *******************/
75 
76  template < typename Scalar,
77  typename LocalOrdinal,
78  typename GlobalOrdinal,
79  typename Node >
80  struct MatrixTraits<
81  Tpetra::RowMatrix<Scalar,
82  LocalOrdinal,
83  GlobalOrdinal,
84  Node> > {
85  typedef Scalar scalar_t;
86  typedef LocalOrdinal local_ordinal_t;
87  typedef GlobalOrdinal global_ordinal_t;
88  typedef Node node_t;
89 
90  typedef row_access major_access;
91  };
92 
93  template < typename Scalar,
94  typename LocalOrdinal,
95  typename GlobalOrdinal,
96  typename Node >
97  struct MatrixTraits<
98  Tpetra::CrsMatrix<Scalar,
99  LocalOrdinal,
100  GlobalOrdinal,
101  Node> > {
102  typedef Scalar scalar_t;
103  typedef LocalOrdinal local_ordinal_t;
104  typedef GlobalOrdinal global_ordinal_t;
105  typedef Node node_t;
106 
107  typedef row_access major_access;
108  };
109 
110 
111 #ifdef HAVE_TPETRA_INST_INT_INT
112 #ifdef HAVE_AMESOS2_EPETRA
113 
114  template <>
115  struct MatrixTraits<Epetra_RowMatrix> {
116  typedef double scalar_t;
117  typedef int local_ordinal_t;
118  typedef int global_ordinal_t;
119  typedef Tpetra::DefaultPlatform::DefaultPlatformType::NodeType node_t;
120 
121  typedef row_access major_access;
122  };
123 
124  template <>
125  struct MatrixTraits<Epetra_CrsMatrix> {
126  typedef double scalar_t;
127  typedef int local_ordinal_t;
128  typedef int global_ordinal_t;
129  typedef Tpetra::DefaultPlatform::DefaultPlatformType::NodeType node_t;
130 
131  typedef row_access major_access;
132  };
133 
134  // template <>
135  // struct MatrixTraits<Epetra_MsrMatrix> {
136  // typedef double scalar_t;
137  // typedef int local_ordinal_t;
138  // typedef int global_ordinal_t;
139  // typedef Tpetra::DefaultPlatform::DefaultPlatformType::NodeType node_t;
140 
141  // typedef row_access major_access;
142  // };
143 
144  template <>
145  struct MatrixTraits<Epetra_VbrMatrix> {
146  typedef double scalar_t;
147  typedef int local_ordinal_t;
148  typedef int global_ordinal_t;
149  typedef Tpetra::DefaultPlatform::DefaultPlatformType::NodeType node_t;
150 
151  typedef row_access major_access;
152  };
153 
154 #endif
155 #endif
156 
157 }
158 
159 #endif // AMESOS2_MATRIXTRAITS_HPP
Utility functions for Amesos2.
Definition: Amesos2_AbstractConcreteMatrixAdapter.hpp:48