Tpetra parallel linear algebra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Tpetra_Details_DefaultTypes.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Tpetra: Templated Linear Algebra Services Package
5 // Copyright (2008) Sandia Corporation
6 //
7 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8 // the U.S. Government retains certain rights in this software.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ************************************************************************
40 // @HEADER
41 
42 #ifndef TPETRA_DETAILS_DEFAULTTYPES_HPP
43 #define TPETRA_DETAILS_DEFAULTTYPES_HPP
44 
45 #include "TpetraCore_config.h"
46 #include "KokkosClassic_DefaultNode_config.h"
47 #include "KokkosCompat_ClassicNodeAPI_Wrapper.hpp"
48 
50 namespace Tpetra {
51 
54 namespace Details {
55 
61 namespace DefaultTypes {
63 #if defined(HAVE_TPETRA_INST_DOUBLE)
64  using scalar_type = double;
65 #elif defined(HAVE_TPETRA_INST_FLOAT)
66  using scalar_type = float;
67 #else
68 # error "Tpetra: No scalar types in the set {float, double} have been enabled."
69 #endif
70 
72  using local_ordinal_type = int;
73 
76 #if defined(TPETRA_ENABLE_DEPRECATED_CODE)
77  #if defined(HAVE_TPETRA_INST_INT_INT)
78  using global_ordinal_type = int;
79  #elif defined(HAVE_TPETRA_INST_INT_LONG_LONG)
80  using global_ordinal_type = long long;
81  #elif defined(HAVE_TPETRA_INST_INT_LONG)
82  using global_ordinal_type = long;
83  #elif defined(HAVE_TPETRA_INST_INT_UNSIGNED_LONG)
84  using global_ordinal_type = unsigned long;
85  #elif defined(HAVE_TPETRA_INST_INT_UNSIGNED)
86  using global_ordinal_type = unsigned;
87  #else
88  #error "Tpetra: No global ordinal types in the set {int, long long, long, unsigned long, unsigned} have been enabled."
89  #endif
90 #else // TPETRA_ENABLE_DEPRECATED_CODE IS NOT DEFINED
91  #if defined(HAVE_TPETRA_INST_INT_LONG_LONG)
92  using global_ordinal_type = long long;
93  #elif defined(HAVE_TPETRA_INST_INT_INT)
94  using global_ordinal_type = int;
95  #elif defined(HAVE_TPETRA_INST_INT_LONG)
96  using global_ordinal_type = long;
97  #elif defined(HAVE_TPETRA_INST_INT_UNSIGNED_LONG)
98  using global_ordinal_type = unsigned long;
99  #elif defined(HAVE_TPETRA_INST_INT_UNSIGNED)
100  using global_ordinal_type = unsigned;
101  #else
102  #error "Tpetra: No global ordinal types in the set {int, long long, long, unsigned long, unsigned} have been enabled."
103  #endif
104 #endif
105 
108 #if defined(HAVE_TPETRA_DEFAULTNODE_CUDAWRAPPERNODE)
109  using execution_space = ::Kokkos::Cuda;
110 #elif defined(HAVE_TPETRA_DEFAULTNODE_OPENMPWRAPPERNODE)
111  using execution_space = ::Kokkos::OpenMP;
112 #elif defined(HAVE_TPETRA_DEFAULTNODE_THREADSWRAPPERNODE)
113  using execution_space = ::Kokkos::Threads;
114 #elif defined(HAVE_TPETRA_DEFAULTNODE_SERIALWRAPPERNODE)
115  using execution_space = ::Kokkos::Serial;
116 #else
117 # error "No default Tpetra Node type specified. Please set the CMake option Tpetra_DefaultNode to a valid Node type."
118 #endif
119 
121  using node_type = ::Kokkos::Compat::KokkosDeviceWrapperNode<execution_space>;
122 
126  template<class ExecutionSpace>
128 #ifdef KOKKOS_ENABLE_CUDA
129  typename std::conditional<
130  std::is_same<typename ExecutionSpace::execution_space, Kokkos::Cuda>::value,
131  Kokkos::CudaSpace,
132  typename ExecutionSpace::memory_space>::type;
133 #else
134  typename ExecutionSpace::memory_space;
135 #endif // KOKKOS_ENABLE_CUDA
136 
137 } // namespace DefaultTypes
138 
139 } // namespace Details
140 
141 } // namespace Tpetra
142 
143 #endif // TPETRA_DETAILS_DEFAULTTYPES_HPP
typename ExecutionSpace::memory_space comm_buffer_memory_space
Memory space used for MPI communication buffers.
int local_ordinal_type
Default value of Scalar template parameter.
::Kokkos::Compat::KokkosDeviceWrapperNode< execution_space > node_type
Default value of Node template parameter.