Amesos2 - Direct Sparse Solver Interfaces  Version of the Day
Amesos2_VectorTraits.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_VECTORTRAITS_HPP
46 #define AMESOS2_VECTORTRAITS_HPP
47 
48 //#include "Amesos2_config.h"
49 
50 #include <Tpetra_MultiVector.hpp>
51 
52 
53 #ifdef HAVE_AMESOS2_EPETRA
54 # include <Epetra_MultiVector.h>
55 // and perhaps some others later...
56 #endif
57 
58 namespace Amesos2 {
59 
60  // The declaration
61  template <class Vector>
62  struct VectorTraits {};
63 
64  /*******************
65  * Specializations *
66  *******************/
67 
68  template < typename Scalar,
69  typename LocalOrdinal,
70  typename GlobalOrdinal,
71  typename Node >
72  struct VectorTraits<
73  Tpetra::MultiVector<Scalar,
74  LocalOrdinal,
75  GlobalOrdinal,
76  Node> > {
77  typedef Scalar scalar_t;
78  typedef LocalOrdinal local_ordinal_t;
79  typedef GlobalOrdinal global_ordinal_t;
80  typedef Node node_t;
81 
82  typedef Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> multivector_type;
83  typedef typename multivector_type::impl_scalar_type ptr_scalar_type; // TODO Make this a pointer
84  };
85 
86 #ifdef HAVE_AMESOS2_EPETRA
87 
88  template <>
89  struct VectorTraits<Epetra_MultiVector> {
90  typedef double scalar_t;
91  typedef int local_ordinal_t;
92  typedef Tpetra::Map<>::global_ordinal_type global_ordinal_t;
93  typedef Tpetra::Map<>::node_type node_t;
94 
95  typedef Epetra_MultiVector multivector_type;
96  typedef double ptr_scalar_type; // TODO Make this a pointer
97  };
98 
99 #endif
100 
101 }
102 
103 #endif // AMESOS2_VECTORTRAITS_HPP