Zoltan2
Zoltan2_Adapter.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_ADAPTER_HPP_
51 #define _ZOLTAN2_ADAPTER_HPP_
52 
53 #include <Zoltan2_Standards.hpp>
54 #include <Zoltan2_InputTraits.hpp>
56 
57 namespace Zoltan2 {
58 
69 };
70 
71 
81 template <typename User>
82  class BaseAdapter {
83 
84 public:
85  typedef typename InputTraits<User>::lno_t lno_t;
86  typedef typename InputTraits<User>::gno_t gno_t;
88  typedef typename InputTraits<User>::part_t part_t;
89 
92  virtual enum BaseAdapterType adapterType()const = 0;
93 
96  virtual ~BaseAdapter() {};
97 
103  virtual size_t getLocalNumIDs() const = 0;
104 
110  virtual void getIDsView(const gno_t *&Ids) const = 0;
111 
117  virtual int getNumWeightsPerID() const { return 0;};
118 
128  virtual void getWeightsView(const scalar_t *&wgt, int &stride,
129  int idx = 0) const
130  {
132  }
133 
143  void getPartsView(const part_t *&inputPart) const
144  {
145  // Default behavior: return NULL for inputPart array;
146  // assume input part == rank
147  inputPart = NULL;
148  }
149 
168  template <typename Adapter>
169  void applyPartitioningSolution(const User &in, User *&out,
170  const PartitioningSolution<Adapter> &solution) const
171  {
173  }
174 
175 };
176 
177 } //namespace Zoltan2
178 
179 #endif
InputTraits< User >::scalar_t scalar_t
virtual size_t getLocalNumIDs() const =0
Returns the number of objects on this process.
InputTraits< User >::gno_t gno_t
default_part_t part_t
The data type to represent part numbers.
InputTraits< User >::lno_t lno_t
#define Z2_THROW_NOT_IMPLEMENTED
Defines the PartitioningSolution class.
void getPartsView(const part_t *&inputPart) const
Provide pointer to an array containing the input part assignment for each ID. The input part informat...
virtual int getNumWeightsPerID() const
Returns the number of weights per object. Number of weights per object should be zero or greater...
void applyPartitioningSolution(const User &in, User *&out, const PartitioningSolution< Adapter > &solution) const
Apply a PartitioningSolution to an input.
virtual ~BaseAdapter()
Destructor.
virtual void getWeightsView(const scalar_t *&wgt, int &stride, int idx=0) const
Provide pointer to a weight array with stride.
virtual void getIDsView(const gno_t *&Ids) const =0
Provide a pointer to this process&#39; identifiers.
A PartitioningSolution is a solution to a partitioning problem.
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.
identifier data, just a list of IDs
Traits for application input objects.
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.
BaseAdapter defines methods required by all Adapters.
Gathering definitions used in software development.
default_scalar_t scalar_t
The data type for weights and coordinates.
virtual enum BaseAdapterType adapterType() const =0
Returns the type of adapter.