Zoltan2
Zoltan2_BasicKokkosIdentifierAdapter.hpp
Go to the documentation of this file.
1 // @HEADER
2 //
3 // ***********************************************************************
4 //
5 // Zoltan2: A package of combinatorial algorithms for scientific computing
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 Karen Devine (kddevin@sandia.gov)
39 // Erik Boman (egboman@sandia.gov)
40 // Siva Rajamanickam (srajama@sandia.gov)
41 //
42 // ***********************************************************************
43 //
44 // @HEADER
45 
50 #ifndef _ZOLTAN2_BASICKOKKOSIDENTIFIERADAPTER_HPP_
51 #define _ZOLTAN2_BASICKOKKOSIDENTIFIERADAPTER_HPP_
52 
53 #include <Kokkos_Core.hpp>
55 #include <Zoltan2_StridedData.hpp>
56 
57 using Kokkos::ALL;
58 
59 namespace Zoltan2 {
60 
83 template <typename User>
85 
86 public:
88  typedef typename InputTraits<User>::lno_t lno_t;
89  typedef typename InputTraits<User>::gno_t gno_t;
92  typedef User user_t;
93  typedef Kokkos::LayoutLeft weight_layout_t;
94 
108  BasicKokkosIdentifierAdapter(Kokkos::View<gno_t*> &ids,
109  Kokkos::View<scalar_t**, weight_layout_t> &weights);
110 
112  // The Adapter interface.
114 
115  size_t getLocalNumIDs() const { return idsView_.extent(0); }
116 
117  void getIDsKokkosView(Kokkos::View<gno_t *> &ids) const {ids = idsView_;}
118 
119  int getNumWeightsPerID() const { return weightsView_.extent(1); }
120 
121  void getWeightsKokkosView(Kokkos::View<scalar_t *> &wgt, int idx = 0) const {
122  if (idx < 0 || scalar_t(idx) >= weightsView_.extent(0)) {
123  std::ostringstream emsg;
124  emsg << __FILE__ << ":" << __LINE__
125  << " Invalid weight index " << idx << std::endl;
126  throw std::runtime_error(emsg.str());
127  }
128  wgt = Kokkos::subview(weightsView_, ALL, idx);
129  }
130 
131 private:
132  Kokkos::View<gno_t *> idsView_;
133  Kokkos::View<scalar_t **, weight_layout_t> weightsView_;
134 };
135 
137 // Definitions
139 
140 template <typename User>
142  Kokkos::View<gno_t*> &ids,
143  Kokkos::View<scalar_t**, weight_layout_t> &weights):
144  idsView_(ids), weightsView_(weights) {
145 }
146 
147 } //namespace Zoltan2
148 
149 #endif
Zoltan2::InputTraits::scalar_t
default_scalar_t scalar_t
The data type for weights and coordinates.
Definition: Zoltan2_InputTraits.hpp:181
Zoltan2::BasicKokkosIdentifierAdapter::user_t
User user_t
Definition: Zoltan2_BasicKokkosIdentifierAdapter.hpp:92
Zoltan2::BasicKokkosIdentifierAdapter::weight_layout_t
Kokkos::LayoutLeft weight_layout_t
Definition: Zoltan2_BasicKokkosIdentifierAdapter.hpp:93
Zoltan2::InputTraits::part_t
default_part_t part_t
The data type to represent part numbers.
Definition: Zoltan2_InputTraits.hpp:199
Zoltan2::BasicKokkosIdentifierAdapter
This class represents a collection of global Identifiers and their associated weights,...
Definition: Zoltan2_BasicKokkosIdentifierAdapter.hpp:84
Zoltan2::BasicKokkosIdentifierAdapter::gno_t
InputTraits< User >::gno_t gno_t
Definition: Zoltan2_BasicKokkosIdentifierAdapter.hpp:89
Zoltan2::BasicKokkosIdentifierAdapter::BasicKokkosIdentifierAdapter
BasicKokkosIdentifierAdapter(Kokkos::View< gno_t * > &ids, Kokkos::View< scalar_t **, weight_layout_t > &weights)
Constructor.
Definition: Zoltan2_BasicKokkosIdentifierAdapter.hpp:141
Zoltan2::BasicKokkosIdentifierAdapter::getNumWeightsPerID
int getNumWeightsPerID() const
Returns the number of weights per object. Number of weights per object should be zero or greater....
Definition: Zoltan2_BasicKokkosIdentifierAdapter.hpp:119
Zoltan2::BasicKokkosIdentifierAdapter::getWeightsKokkosView
void getWeightsKokkosView(Kokkos::View< scalar_t * > &wgt, int idx=0) const
Definition: Zoltan2_BasicKokkosIdentifierAdapter.hpp:121
Zoltan2::BasicKokkosIdentifierAdapter::getLocalNumIDs
size_t getLocalNumIDs() const
Returns the number of objects on this process.
Definition: Zoltan2_BasicKokkosIdentifierAdapter.hpp:115
Zoltan2_StridedData.hpp
This file defines the StridedData class.
Zoltan2::BasicKokkosIdentifierAdapter::node_t
InputTraits< User >::node_t node_t
Definition: Zoltan2_BasicKokkosIdentifierAdapter.hpp:91
Zoltan2::InputTraits::node_t
default_node_t node_t
The Kokkos node type. This is only meaningful for users of Tpetra objects.
Definition: Zoltan2_InputTraits.hpp:204
Zoltan2::InputTraits::lno_t
default_lno_t lno_t
The ordinal type (e.g., int, long, int64_t) that represents local counts and local indices.
Definition: Zoltan2_InputTraits.hpp:186
Zoltan2::BasicKokkosIdentifierAdapter::scalar_t
InputTraits< User >::scalar_t scalar_t
Definition: Zoltan2_BasicKokkosIdentifierAdapter.hpp:87
Zoltan2::InputTraits::gno_t
default_gno_t gno_t
The ordinal type (e.g., int, long, int64_t) that can represent global counts and identifiers.
Definition: Zoltan2_InputTraits.hpp:191
weights
static ArrayRCP< ArrayRCP< zscalar_t > > weights
Definition: rcbPerformanceZ1.cpp:82
Zoltan2
Definition: Zoltan2_AlgSerialGreedy.hpp:56
Zoltan2::IdentifierAdapter
IdentifierAdapter defines the interface for identifiers.
Definition: Zoltan2_IdentifierAdapter.hpp:96
Zoltan2_IdentifierAdapter.hpp
Defines the IdentifierAdapter interface.
Zoltan2::BasicKokkosIdentifierAdapter::getIDsKokkosView
void getIDsKokkosView(Kokkos::View< gno_t * > &ids) const
Provide a pointer to this process' identifiers.
Definition: Zoltan2_BasicKokkosIdentifierAdapter.hpp:117
Zoltan2::BasicKokkosIdentifierAdapter::lno_t
InputTraits< User >::lno_t lno_t
Definition: Zoltan2_BasicKokkosIdentifierAdapter.hpp:88
Zoltan2::BasicKokkosIdentifierAdapter::part_t
InputTraits< User >::part_t part_t
Definition: Zoltan2_BasicKokkosIdentifierAdapter.hpp:90