MueLu  Version of the Day
MueLu_LWGraph_kokkos_decl.hpp
Go to the documentation of this file.
1 // @HEADER
2 //
3 // ***********************************************************************
4 //
5 // MueLu: A package for multigrid based preconditioning
6 // Copyright 2012 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
39 // Jonathan Hu (jhu@sandia.gov)
40 // Andrey Prokopenko (aprokop@sandia.gov)
41 // Ray Tuminaro (rstumin@sandia.gov)
42 //
43 // ***********************************************************************
44 //
45 // @HEADER
46 #ifndef MUELU_LWGRAPH_KOKKOS_DECL_HPP
47 #define MUELU_LWGRAPH_KOKKOS_DECL_HPP
48 
49 #include "MueLu_ConfigDefs.hpp"
50 #ifdef HAVE_MUELU_KOKKOS_REFACTOR
51 
52 #include <Kokkos_StaticCrsGraph.hpp>
53 #include <KokkosCompat_ClassicNodeAPI_Wrapper.hpp>
54 
55 #include <Xpetra_ConfigDefs.hpp> // global_size_t
56 #include <Xpetra_Map.hpp>
57 
59 
60 #include "MueLu_Exceptions.hpp"
61 
62 namespace MueLu {
63 
71  template<class LocalOrdinal, class GlobalOrdinal, class Node>
72  class LWGraph_kokkos;
73 
74  // Partial specialization for DeviceType
75  template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>
76  class LWGraph_kokkos<LocalOrdinal, GlobalOrdinal, Kokkos::Compat::KokkosDeviceWrapperNode<DeviceType>> {
77  public:
78  typedef LocalOrdinal local_ordinal_type;
79  typedef GlobalOrdinal global_ordinal_type;
80  typedef typename DeviceType::execution_space execution_space;
81  typedef Kokkos::Compat::KokkosDeviceWrapperNode<DeviceType> node_type;
82  typedef size_t size_type;
83 
84  typedef Xpetra::Map<LocalOrdinal, GlobalOrdinal, node_type> map_type;
86  typedef Kokkos::View<const bool*, DeviceType> boundary_nodes_type;
88 
89  private:
90  // For compatibility
91  typedef node_type Node;
92 #undef MUELU_LWGRAPH_KOKKOS_SHORT
94 
95  public:
96 
98 
99  LWGraph_kokkos(const local_graph_type& graph,
100  const RCP<const map_type>& domainMap,
101  const RCP<const map_type>& rangeMap,
102  const std::string& objectLabel = "");
103 
104  ~LWGraph_kokkos() { }
106 
107  const RCP<const Teuchos::Comm<int> > GetComm() const {
108  return domainMap_->getComm();
109  }
110  const RCP<const Map> GetDomainMap() const {
111  return domainMap_;
112  }
114  const RCP<const Map> GetImportMap() const {
115  return importMap_;
116  }
117 
119  KOKKOS_INLINE_FUNCTION size_type GetNodeNumVertices() const {
120  return graph_.numRows();
121  }
123  KOKKOS_INLINE_FUNCTION size_type GetNodeNumEdges() const {
124  return graph_.row_map(GetNodeNumVertices());
125  }
126 
128  KOKKOS_INLINE_FUNCTION row_type getNeighborVertices(LO i) const {
129  auto rowPointers = graph_.row_map;
130  auto colIndices = graph_.entries;
131 
132  return Kokkos::subview(colIndices, Kokkos::make_pair<size_t,size_t>(rowPointers(i), rowPointers(i+1)));
133  }
134 
136  KOKKOS_INLINE_FUNCTION bool isLocalNeighborVertex(LO i) const {
137  return i >= minLocalIndex_ && i <= maxLocalIndex_;
138  }
139 
141  KOKKOS_INLINE_FUNCTION void SetBoundaryNodeMap(const boundary_nodes_type bndry) {
142  dirichletBoundaries_ = bndry;
143  }
144 
146  KOKKOS_INLINE_FUNCTION size_type getNodeMaxNumRowEntries () const {
147  return maxNumRowEntries_;
148  }
149 
151  KOKKOS_INLINE_FUNCTION const boundary_nodes_type GetBoundaryNodeMap() const {
152  return dirichletBoundaries_;
153  }
154 
156  std::string description() const {
157  return "LWGraph (" + objectLabel_ + ")";
158  }
159 
161  // void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;
162 
163  private:
164 
166  const local_graph_type graph_;
167 
169  const RCP<const map_type> domainMap_;
170  const RCP<const map_type> importMap_;
171 
173  boundary_nodes_type dirichletBoundaries_;
174 
176  LO minLocalIndex_, maxLocalIndex_;
177  size_type maxNumRowEntries_;
178 
180  const std::string& objectLabel_;
181  };
182 
183 }
184 
185 #define MUELU_LWGRAPH_KOKKOS_SHORT
186 #endif // HAVE_MUELU_KOKKOS_REFACTOR
187 #endif // MUELU_LWGRAPH_KOKKOS_DECL_HPP
Namespace for MueLu classes and methods.