Zoltan2 Version of the Day
Zoltan2_InputAdapter.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 //
00003 // ***********************************************************************
00004 //
00005 //   Zoltan2: A package of combinatorial algorithms for scientific computing
00006 //                  Copyright 2012 Sandia Corporation
00007 //
00008 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00009 // the U.S. Government retains certain rights in this software.
00010 //
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Karen Devine      (kddevin@sandia.gov)
00039 //                    Erik Boman        (egboman@sandia.gov)
00040 //                    Siva Rajamanickam (srajama@sandia.gov)
00041 //
00042 // ***********************************************************************
00043 //
00044 // @HEADER
00045 
00050 #ifndef _ZOLTAN2_ADAPTER_HPP_
00051 #define _ZOLTAN2_ADAPTER_HPP_
00052 
00053 #include <Zoltan2_Standards.hpp>
00054 #include <Zoltan2_InputTraits.hpp>
00055 #include <Zoltan2_PartitioningSolution.hpp>
00056 
00057 namespace Zoltan2 {
00058 
00062 enum BaseAdapterType {
00063   InvalidAdapterType = 0, 
00064   IdentifierAdapterType,  
00065   CoordinateAdapterType,  
00066   VectorAdapterType,      
00067   MatrixAdapterType,      
00068   GraphAdapterType,       
00069   MeshAdapterType         
00070 };
00071 
00072 
00083 template <typename User>
00084   class BaseAdapter {
00085 
00086 private:
00087 
00088   typedef typename InputTraits<User>::gid_t    gid_t;
00089   typedef typename InputTraits<User>::scalar_t scalar_t;
00090 
00091 public:
00092 
00095   virtual enum BaseAdapterType adapterType()const = 0;
00096 
00099   virtual ~BaseAdapter() {};
00100 
00106   virtual size_t getLocalNum() const = 0;
00107 
00113   virtual void getIDsView(const gid_t *&Ids) const = 0;
00114 
00119   virtual int getNumWeightsPerID() const = 0;
00120 
00127   virtual void getWeightsView(const scalar_t *&wgt, int &stride,
00128                               int idx = 0) const = 0;
00129 
00148   template <typename Adapter>
00149     size_t applyPartitioningSolution(const User &in, User *&out,
00150       const PartitioningSolution<Adapter> &solution) const
00151   {
00152     return 0;
00153   }
00154 
00155 };
00156   
00157 }  //namespace Zoltan2
00158   
00159 #endif