MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_LocalLWGraph_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_LOCALLWGRAPH_KOKKOS_DECL_HPP
47#define MUELU_LOCALLWGRAPH_KOKKOS_DECL_HPP
48
49#include "MueLu_ConfigDefs.hpp"
50
51#include <Kokkos_StaticCrsGraph.hpp>
52#include <KokkosCompat_ClassicNodeAPI_Wrapper.hpp>
53
54#include <Xpetra_ConfigDefs.hpp> // global_size_t
55#include <Xpetra_Map.hpp>
56
59
60#include "MueLu_Exceptions.hpp"
61
62namespace MueLu {
63
71 template<class LocalOrdinal, class GlobalOrdinal, class Node>
73
74 // Partial specialization for DeviceType
75 template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>
76 class LocalLWGraph_kokkos<LocalOrdinal, GlobalOrdinal, Kokkos::Compat::KokkosDeviceWrapperNode<DeviceType>> {
77 public:
80 using execution_space = typename DeviceType::execution_space;
81 using memory_space = typename DeviceType::memory_space;
82 using device_type = Kokkos::Device<execution_space, memory_space>;
83 using range_type = Kokkos::RangePolicy<local_ordinal_type, execution_space>;
84 using node_type = Kokkos::Compat::KokkosDeviceWrapperNode<DeviceType>;
85 using size_type = size_t;
86
87 using local_graph_type = Kokkos::StaticCrsGraph<LocalOrdinal,
88 Kokkos::LayoutLeft,
89 device_type, void, size_t>;
90 using boundary_nodes_type = Kokkos::View<const bool*, memory_space>;
91 using row_type = Kokkos::View<const LocalOrdinal*, memory_space>;
92 using map_type = Xpetra::Map<LocalOrdinal, GlobalOrdinal, node_type>;
93
94 private:
95 // For compatibility
96 typedef node_type Node;
97#undef MUELU_LOCALLWGRAPH_KOKKOS_SHORT
99
100 public:
101
103
104
106 //
107 // @param[in] graph: local graph of type Kokkos::StaticCrsGraph containing CRS data
109 const RCP<const map_type>& domainMap);
110
113
115 KOKKOS_INLINE_FUNCTION size_type GetNodeNumVertices() const {
116 return graph_.numRows();
117 }
119 KOKKOS_INLINE_FUNCTION size_type GetNodeNumEdges() const {
120 return graph_.row_map(GetNodeNumVertices());
121 }
122
124 KOKKOS_INLINE_FUNCTION size_type getLocalMaxNumRowEntries () const {
125 return maxNumRowEntries_;
126 }
127
129 KOKKOS_INLINE_FUNCTION typename local_graph_type::row_map_type getRowPtrs() const {
130 return graph_.row_map;
131 }
132
134 KOKKOS_INLINE_FUNCTION typename local_graph_type::entries_type getEntries() const {
135 return graph_.entries;
136 }
137
139 // Unfortunately, C++11 does not support the following:
140 // auto getNeighborVertices(LO i) const -> decltype(rowView)
141 // auto return with decltype was only introduced in C++14
142 KOKKOS_INLINE_FUNCTION
143 Kokkos::GraphRowViewConst<local_graph_type> getNeighborVertices(LO i) const {
144 auto rowView = graph_.rowConst(i);
145
146 return rowView;
147 }
148
150 KOKKOS_INLINE_FUNCTION bool isLocalNeighborVertex(LO i) const {
151 return i >= minLocalIndex_ && i <= maxLocalIndex_;
152 }
153
155 KOKKOS_INLINE_FUNCTION void SetBoundaryNodeMap(const boundary_nodes_type bndry) {
156 dirichletBoundaries_ = bndry;
157 }
158
160 KOKKOS_INLINE_FUNCTION const boundary_nodes_type GetBoundaryNodeMap() const {
161 return dirichletBoundaries_;
162 }
163
164 const local_graph_type& getGraph() const {
165 return graph_;
166 }
167
168 private:
169
172
175
177 LO minLocalIndex_, maxLocalIndex_;
179
180 };
181
182}
183
184#define MUELU_LOCALLWGRAPH_KOKKOS_SHORT
185#endif // MUELU_LOCALLWGRAPH_KOKKOS_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultGlobalOrdinal GlobalOrdinal
KOKKOS_INLINE_FUNCTION size_type getLocalMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on this node.
KOKKOS_INLINE_FUNCTION void SetBoundaryNodeMap(const boundary_nodes_type bndry)
Set boolean array indicating which rows correspond to Dirichlet boundaries.
KOKKOS_INLINE_FUNCTION bool isLocalNeighborVertex(LO i) const
Return true if vertex with local id 'v' is on current process.
KOKKOS_INLINE_FUNCTION local_graph_type::row_map_type getRowPtrs() const
Return the row pointers of the local graph.
KOKKOS_INLINE_FUNCTION Kokkos::GraphRowViewConst< local_graph_type > getNeighborVertices(LO i) const
Return the list of vertices adjacent to the vertex 'v'.
KOKKOS_INLINE_FUNCTION local_graph_type::entries_type getEntries() const
Return the list entries in the local graph.
Kokkos::StaticCrsGraph< LocalOrdinal, Kokkos::LayoutLeft, device_type, void, size_t > local_graph_type
KOKKOS_INLINE_FUNCTION const boundary_nodes_type GetBoundaryNodeMap() const
Returns map with global ids of boundary nodes.
Lightweight MueLu representation of a compressed row storage graph.
Namespace for MueLu classes and methods.