Zoltan2
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 {
00063   HypergraphModelType,
00064   GraphModelType,
00065   CoordinateModelType,
00066   IdentifierModelType,
00067   MAX_NUM_MODEL_TYPES
00068 };
00069 
00070 
00071 
00075 enum ModelFlags{
00076   // General flags
00077   IDS_MUST_BE_GLOBALLY_CONSECUTIVE, 
00079   // Graph model flags
00080   SYMMETRIZE_INPUT_TRANSPOSE, 
00081   SYMMETRIZE_INPUT_BIPARTITE, 
00082   VERTICES_ARE_MATRIX_ROWS,   
00083   VERTICES_ARE_MATRIX_COLUMNS,
00084   VERTICES_ARE_MATRIX_NONZEROS, 
00085   VERTICES_ARE_MESH_NODES,    
00086   VERTICES_ARE_MESH_ELEMENTS, 
00087   SELF_EDGES_MUST_BE_REMOVED, 
00088   GRAPH_IS_A_SUBSET_GRAPH,    
00090   NUM_MODEL_FLAGS
00091 };
00092 
00093 typedef std::bitset<NUM_MODEL_FLAGS> modelFlag_t;
00094 
00109 template <typename Adapter>
00110 class Model
00111 {
00112 public:
00113 
00114 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00115   typedef typename Adapter::lno_t       lno_t;
00116   typedef typename Adapter::gno_t       gno_t;
00117   typedef typename Adapter::gid_t       gid_t;
00118   typedef typename Adapter::scalar_t    scalar_t;
00119   typedef typename Adapter::user_t      user_t;
00120   typedef typename Adapter::userCoord_t userCoord_t;
00121   typedef IdentifierMap<user_t> idmap_t;
00122 #endif
00123 
00126   virtual ~Model() {};
00127 
00130   Model() : idMap_() {}
00131 
00139   RCP<const idmap_t > getIdentifierMap() const { return idMap_; }
00140 
00147   virtual size_t getLocalNumObjects() const = 0;
00148 
00155   virtual global_size_t getGlobalNumObjects() const = 0;
00156 
00157 
00158 protected:
00159 
00165   void setIdentifierMap(RCP<const idmap_t> &map) { idMap_ = map; }
00166 
00167 private:
00168 
00169   RCP<const idmap_t> idMap_;
00170 
00171 };
00172 
00173 }   //  namespace Zoltan2
00174 
00175 #endif