Amesos2 - Direct Sparse Solver Interfaces  Version of the Day
Amesos2_SolverTraits.hpp
Go to the documentation of this file.
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 
55 #ifndef AMESOS2_SOLVERTRAITS_HPP
56 #define AMESOS2_SOLVERTRAITS_HPP
57 
58 #include "Amesos2_Meta.hpp"
59 #include "Amesos2_MatrixAdapter.hpp"
60 
61 namespace Amesos2 {
62 
70  template <template <class,class> class ConcreteSolver>
71  struct solver_traits {
72  typedef Meta::nil_t supported_scalars;
73  };
74 
75 
77  // Related meta-functions //
79 
92  /* SR: We will not use external initialization for the static const types.
93  * Combined with template meta programming this fails in Intel compilers
94  * 11-13. Moving all the initializations inside the declarations.
95  */
96  template <template <class,class> class ConcreteSolver,
97  typename Scalar>
99  static const bool value =
100  Meta::if_then_else<Meta::is_same<typename solver_traits<ConcreteSolver>::supported_scalars, Meta::nil_t>::value,
101  Meta::true_type,
102  Meta::type_list_contains<
103  typename solver_traits<ConcreteSolver>::supported_scalars,
104  Scalar> >::type::value;
105  };
106 
107  template <template <class,class> class ConcreteSolver,
108  typename Matrix>
109  struct solver_supports_matrix {
110  static const bool value = true;
111  };
112 
113  // for kokkos adapter we only allow this for the specific solvers which
114  // are using it. This is to avoid having ETI setup for all solvers. The
115  // kokkos adapter is for testing UVM off and would become relic when Tpetra
116  // switches to UVM off. To support this, solvers like Tacho override this
117  // method and return true.
118  template <template <class,class> class ConcreteSolver,
119  typename Scalar, typename LocalOrdinal, typename ExecutionSpace>
120  struct solver_supports_matrix<ConcreteSolver,
121  KokkosSparse::CrsMatrix<Scalar, LocalOrdinal, ExecutionSpace>> {
122  static const bool value = false;
123  };
124 
125 } // end namespace Amesos2
126 
127 #endif // AMESOS2_SOLVERTRAITS_HPP
Provides some simple meta-programming utilities for Amesos2.
Provides traits about solvers.
Definition: Amesos2_SolverTraits.hpp:71
Check whether a solver supports a scalar type.
Definition: Amesos2_SolverTraits.hpp:98