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 // Throw an error for input adapter functions that have been
58 // called by the model but not implemented in the adapter.
59 #define Z2_THROW_NOT_IMPLEMENTED_IN_ADAPTER \
60  { \
61  std::ostringstream emsg; \
62  emsg << __FILE__ << "," << __LINE__ \
63  << " error: " << __func__zoltan2__ << " not implemented in adapter " \
64  << std::endl; \
65  throw std::runtime_error(emsg.str()); \
66  }
67 
68 namespace Zoltan2 {
69 
80 };
81 
82 
92 template <typename User>
93  class BaseAdapter {
94 
95 public:
96  typedef typename InputTraits<User>::gno_t gno_t;
98  typedef typename InputTraits<User>::part_t part_t;
99 
102  virtual enum BaseAdapterType adapterType()const = 0;
103 
106  virtual ~BaseAdapter() {};
107 
113  virtual size_t getLocalNumIDs() const = 0;
114 
120  virtual void getIDsView(const gno_t *&Ids) const = 0;
121 
126  virtual int getNumWeightsPerID() const = 0;
127 
134  virtual void getWeightsView(const scalar_t *&wgt, int &stride,
135  int idx = 0) const = 0;
136 
146  void getPartsView(const part_t *&inputPart) const
147  {
148  // Default behavior: return NULL for inputPart array;
149  // assume input part == rank
150  inputPart = NULL;
151  }
152 
171  template <typename Adapter>
172  void applyPartitioningSolution(const User &in, User *&out,
173  const PartitioningSolution<Adapter> &solution) const
174  {
176  }
177 
178 };
179 
180 } //namespace Zoltan2
181 
182 #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.
virtual int getNumWeightsPerID() const =0
Returns the number of weights per object. Number of weights per object should be zero or greater...
Defines the PartitioningSolution class.
virtual ~BaseAdapter()
Destructor.
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.
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
void getPartsView(const part_t *&inputPart) const
Provide pointer to an array containing the input part assignment for each ID. The input part informat...
default_gno_t gno_t
The ordinal type (e.g., int, long, int64_t) that can represent global counts and identifiers.
#define Z2_THROW_NOT_IMPLEMENTED_IN_ADAPTER
void applyPartitioningSolution(const User &in, User *&out, const PartitioningSolution< Adapter > &solution) const
Apply a PartitioningSolution to an input.
BaseAdapter defines methods required by all Adapters.
Gathering definitions used in software development.
virtual void getWeightsView(const scalar_t *&wgt, int &stride, int idx=0) const =0
Provide pointer to a weight array with stride.
default_scalar_t scalar_t
The data type for weights and coordinates.
virtual enum BaseAdapterType adapterType() const =0
Returns the type of adapter.