Zoltan2 Version of the Day
Zoltan2_Model.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_MODEL_HPP_
00051 #define _ZOLTAN2_MODEL_HPP_
00052 
00053 #include <Zoltan2_Standards.hpp>
00054 #include <Zoltan2_IdentifierMap.hpp>
00055 #include <bitset>
00056 
00057 namespace Zoltan2 {
00058 
00061 enum ModelType {
00062   InvalidModel = 0,
00063   HypergraphModelType,
00064   GraphModelType,
00065   CoordinateModelType,
00066   IdentifierModelType
00067 } ;
00068 
00072 enum ModelFlags{
00073   // General flags
00074   IDS_MUST_BE_GLOBALLY_CONSECUTIVE, 
00076   // Graph model flags
00077   SYMMETRIZE_INPUT_TRANSPOSE, 
00078   SYMMETRIZE_INPUT_BIPARTITE, 
00079   VERTICES_ARE_MATRIX_ROWS,   
00080   VERTICES_ARE_MATRIX_COLUMNS,
00081   VERTICES_ARE_MATRIX_NONZEROS, 
00082   VERTICES_ARE_MESH_NODES,    
00083   VERTICES_ARE_MESH_ELEMENTS, 
00084   SELF_EDGES_MUST_BE_REMOVED, 
00085   GRAPH_IS_A_SUBSET_GRAPH,    
00087   NUM_MODEL_FLAGS
00088 };
00089 
00090 typedef std::bitset<NUM_MODEL_FLAGS> modelFlag_t;
00091 
00106 template <typename Adapter>
00107 class Model
00108 {
00109 public:
00110 
00111 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00112   typedef typename Adapter::lno_t    lno_t;
00113   typedef typename Adapter::gno_t    gno_t;
00114   typedef typename Adapter::gid_t    gid_t;
00115   typedef typename Adapter::scalar_t    scalar_t;
00116   typedef typename Adapter::user_t    user_t;
00117   typedef IdentifierMap<user_t> idmap_t;
00118 #endif
00119 
00122   virtual ~Model() {};
00123 
00126   Model() : idMap_(), weightDim_(0), uniform_() {}
00127 
00135   RCP<const idmap_t > getIdentifierMap() const { return idMap_; }
00136 
00144   int getNumWeights() const { return weightDim_;}
00145 
00151   bool uniformWeight(int weightDim) const { return uniform_[weightDim];}
00152 
00159   virtual size_t getLocalNumObjects() const = 0;
00160 
00167   virtual global_size_t getGlobalNumObjects() const = 0;
00168 
00175   virtual void getGlobalObjectIds(ArrayView<const gno_t> &gnos) const = 0;
00176 
00177 protected:
00178 
00184   void setIdentifierMap(RCP<const idmap_t> &map) { idMap_ = map; }
00185 
00193   void setWeightArrayLengths(const Array<lno_t> &len, 
00194     const Teuchos::Comm<int> &comm)
00195   {
00196     weightDim_ = len.size();
00197 
00198     if (weightDim_ < 1)
00199       weightDim_ = 1;          // uniform weights are implied
00200 
00201     int *lval = new int [weightDim_];
00202     uniform_ = arcp(lval, 0, weightDim_);
00203 
00204     if (len.size() < 1){
00205       uniform_[0] = 1;
00206       return;
00207     }
00208 
00209     for (int i=0; i < weightDim_; i++){
00210       if (len[i] > 0)
00211         lval[i] = 1;
00212       else
00213         lval[i] = 0;
00214     }
00215 
00216     int *rval = new int [weightDim_];
00217 
00218     try{
00219       reduceAll<int, int>(comm, Teuchos::REDUCE_MAX, weightDim_, lval, rval);
00220     }
00221     Z2_FORWARD_EXCEPTIONS
00222 
00223     for (int i=0; i < weightDim_; i++){
00224       if (rval[i] > 0)
00225         uniform_[i] = 0;
00226       else
00227         uniform_[i] = 1;
00228     }
00229  
00230     delete [] rval;
00231   }
00232 
00240   template <typename T>
00241     static void maxCount(const Comm<int> &comm, Array<T> &countValues)
00242   {
00243     size_t len = countValues.size();
00244     if (comm.getSize() < 2 || len < 1)
00245       return;
00246     Array<T> globalValues(len);
00247     Teuchos::reduceAll<int, T>(comm, Teuchos::REDUCE_MAX, len,
00248       countValues.getRawPtr(), globalValues.getRawPtr());
00249 
00250     countValues = globalValues;
00251   }
00252 
00260   template <typename T>
00261     static void maxCount(const Comm<int> &comm, T &value1)
00262   {
00263     Array<T> values(1, value1);
00264     maxCount<T>(comm, values);
00265     value1 = values[0];
00266   }
00267 
00275   template <typename T>
00276     static void maxCount(const Comm<int> &comm, T &value1, T &value2)
00277   {
00278     Array<T> values(2);
00279     values[0] = value1;
00280     values[1] = value2;
00281     maxCount<T>(comm, values);
00282     value1 = values[0];
00283     value2 = values[1];
00284   }
00285 
00286 private:
00287 
00288   RCP<const idmap_t> idMap_;
00289 
00290   int weightDim_;       
00291   ArrayRCP<int> uniform_;   
00292 };
00293 
00294 }   //  namespace Zoltan2
00295 
00296 #endif