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_INPUTADAPTER_HPP_
00051 #define _ZOLTAN2_INPUTADAPTER_HPP_
00052 
00053 #include <Zoltan2_Standards.hpp>
00054 #include <Zoltan2_InputTraits.hpp>
00055 
00056 namespace Zoltan2 {
00057 
00062 enum InputAdapterType {
00063   InvalidAdapterType = 0,    
00064   IdentifierAdapterType,    
00065   VectorAdapterType,    
00066   CoordinateAdapterType,    
00067   GraphAdapterType,    
00068   MeshAdapterType,    
00069   MatrixAdapterType    
00070 };
00071 
00072 
00083 template <typename User>
00084   class InputAdapter {
00085 
00086 private:
00087 
00088   typedef typename InputTraits<User>::scalar_t    scalar_t;
00089 
00090 public:
00091 
00094   virtual enum InputAdapterType inputAdapterType()const = 0;
00095 
00098   virtual ~InputAdapter() {};
00099 
00102   virtual string inputAdapterName() const = 0;
00103 
00109   virtual size_t getLocalNumberOfObjects() const = 0;
00110 
00115   virtual int getNumberOfWeightsPerObject() const = 0;
00116 
00125   virtual size_t getObjectWeights(int dim, const scalar_t *&wgt, 
00126     int &stride) const = 0;
00127 
00130   static string inputAdapterTypeName(InputAdapterType iaType);
00131 };
00132 
00133 template <typename User>
00134   string InputAdapter<User>::inputAdapterTypeName(InputAdapterType iaType)
00135 {
00136   string typeName;
00137   switch (iaType){
00138     case InvalidAdapterType:
00139       typeName = string("invalid");
00140       break;
00141     case IdentifierAdapterType:
00142       typeName = string("identifier");
00143       break;
00144     case VectorAdapterType:
00145       typeName = string("vector");
00146       break;
00147     case CoordinateAdapterType:
00148       typeName = string("coordinate");
00149       break;
00150     case GraphAdapterType:
00151       typeName = string("graph");
00152       break;
00153     case MeshAdapterType:
00154       typeName = string("mesh");
00155       break;
00156     case MatrixAdapterType:
00157       typeName = string("matrix");
00158       break;
00159     default:
00160       typeName = string("unknown");
00161       break;
00162   }
00163 
00164   return typeName;
00165 }
00166   
00167   
00168 }  //namespace Zoltan2
00169   
00170 #endif