Zoltan2_Adapter.hpp

Go to the documentation of this file.

// @HEADER
//
// ***********************************************************************
//
//   Zoltan2: A package of combinatorial algorithms for scientific computing
//                  Copyright 2012 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Karen Devine      (kddevin@sandia.gov)
//                    Erik Boman        (egboman@sandia.gov)
//                    Siva Rajamanickam (srajama@sandia.gov)
//
// ***********************************************************************
//
// @HEADER
 
#ifndef _ZOLTAN2_ADAPTER_HPP_
#define _ZOLTAN2_ADAPTER_HPP_
 
#include <Kokkos_Core.hpp>
#include <Zoltan2_Standards.hpp>
#include <Zoltan2_InputTraits.hpp>
#include <Zoltan2_PartitioningSolution.hpp>
 
namespace Zoltan2 {
 
enum BaseAdapterType {
  InvalidAdapterType = 0, 
  IdentifierAdapterType,  
  VectorAdapterType,      
  MatrixAdapterType,      
  GraphAdapterType,       
  MeshAdapterType         
};
 
class BaseAdapterRoot {
public:
  virtual ~BaseAdapterRoot() {}; // required virtual declaration
 
  virtual size_t getLocalNumIDs() const = 0;
 
  virtual int getNumWeightsPerID() const { return 0; };
};
 
template <typename User>
  class BaseAdapter : public BaseAdapterRoot {
 
public:
  typedef typename InputTraits<User>::lno_t lno_t;
  typedef typename InputTraits<User>::gno_t gno_t;
  typedef typename InputTraits<User>::scalar_t scalar_t;
  typedef typename InputTraits<User>::part_t part_t;  
  typedef typename InputTraits<User>::offset_t offset_t;
 
  virtual enum BaseAdapterType adapterType() const = 0;
 
  virtual ~BaseAdapter() {};
 
  virtual void getIDsView(const gno_t *&ids) const {
    Kokkos::View<gno_t *> kokkosIds;
    getIDsKokkosView(kokkosIds);
    ids = kokkosIds.data();
  }
 
  virtual void getIDsKokkosView(Kokkos::View<gno_t *> &ids) const {
    Z2_THROW_NOT_IMPLEMENTED
  }
 
  // *    \param wgt on return a pointer to the weights for this idx
  // *    \param stride on return, the value such that
  // *       the \t nth weight should be found at <tt> wgt[n*stride] </tt>.
  // *    \param idx  the weight index, zero or greater
  // *   This function must be implemented in derived adapter if
  // *   getNumWeightsPerID > 0.
  // *   This function should not be called if getNumWeightsPerID is zero.
  // */ 
  virtual void getWeightsView(const scalar_t *&wgt, int &stride,
                              int idx = 0) const {
    Kokkos::View<scalar_t *> tempWeightsView;
    getWeightsKokkosView(tempWeightsView, idx);
    wgt = tempWeightsView.data();
    stride = 1;
  }
 
  // *    \param wgt on return a pointer to the weights for this idx
  // *    \param idx  the weight index, zero or greater
  // *   This function must be implemented in derived adapter if
  // *   getNumWeightsPerID > 0.
  // *   This function should not be called if getNumWeightsPerID is zero.
  // */ 
  virtual void getWeightsKokkosView(Kokkos::View<scalar_t *> &wgt, 
                              int idx = 0) const {
    Z2_THROW_NOT_IMPLEMENTED
  }
 
  void getPartsView(const part_t *&inputPart) const {
    // Default behavior:  return NULL for inputPart array;
    // assume input part == rank
    inputPart = NULL;
  }
 
  template <typename Adapter>
    void applyPartitioningSolution(const User &in, User *&out,
      const PartitioningSolution<Adapter> &solution) const {
    Z2_THROW_NOT_IMPLEMENTED
  }
 
};
  
}  //namespace Zoltan2
  
#endif