Zoltan2
Zoltan2_VectorAdapter.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 
51 #ifndef _ZOLTAN2_VECTORADAPTER_HPP_
52 #define _ZOLTAN2_VECTORADAPTER_HPP_
53 
54 #include <Zoltan2_Adapter.hpp>
55 
56 namespace Zoltan2 {
57 
97 template <typename User>
98  class VectorAdapter : public BaseAdapter<User> {
99 private:
100 
101 public:
102 
103 #ifndef DOXYGEN_SHOULD_SKIP_THIS
104  typedef typename InputTraits<User>::scalar_t scalar_t;
105  typedef typename InputTraits<User>::lno_t lno_t;
106  typedef typename InputTraits<User>::gno_t gno_t;
107  typedef typename InputTraits<User>::part_t part_t;
108  typedef typename InputTraits<User>::node_t node_t;
109  typedef User user_t;
110  typedef User userCoord_t;
111 #endif
112 
115  virtual ~VectorAdapter() {};
116 
118  // The Adapter interface.
120 
122 
124  // User's adapter interface:
125  // The user must implement these methods in his VectorAdapter
127 
130  virtual int getNumEntriesPerID() const = 0;
131 
141  virtual void getEntriesView(const scalar_t *&elements, int &stride,
142  int idx = 0) const = 0;
143 
145  // Handy pseudonyms, since vectors are often used as coordinates
146  // User should not implement these methods.
148 
149  inline int getDimension() const {return getNumEntriesPerID();}
150 
151  inline void getCoordinatesView(const scalar_t *&elements, int &stride,
152  int idx = 0) const
153  {
154  getEntriesView(elements, stride, idx);
155  }
156 };
157 
158 
159 } //namespace Zoltan2
160 
161 #endif
InputTraits< User >::scalar_t scalar_t
InputTraits< User >::gno_t gno_t
virtual int getNumEntriesPerID() const =0
Return the number of vectors (typically one).
default_part_t part_t
The data type to represent part numbers.
default_lno_t lno_t
The ordinal type (e.g., int, long, int64_t) that represents local counts and local indices...
BaseAdapterType
An enum to identify general types of adapters.
VectorAdapter defines the interface for vector input.
InputTraits< User >::part_t part_t
default_gno_t gno_t
The ordinal type (e.g., int, long, int64_t) that can represent global counts and identifiers.
default_node_t node_t
The Kokkos node type. This is only meaningful for users of Tpetra objects.
void getCoordinatesView(const scalar_t *&elements, int &stride, int idx=0) const
virtual ~VectorAdapter()
Destructor.
BaseAdapter defines methods required by all Adapters.
enum BaseAdapterType adapterType() const
Returns the type of adapter.
virtual void getEntriesView(const scalar_t *&elements, int &stride, int idx=0) const =0
Provide a pointer to the elements of the specified vector.
default_scalar_t scalar_t
The data type for weights and coordinates.