Isorropia: Partitioning, Load Balancing and more
Isorropia_EpetraZoltanLib.hpp
Go to the documentation of this file.
00001 //@HEADER
00002 //************************************************************************
00003 //
00004 //              Isorropia: Partitioning and Load Balancing Package
00005 //                Copyright (2006) Sandia Corporation
00006 //
00007 //Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 //license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 //************************************************************************
00038 //@HEADER
00039 
00040 #ifndef _Isorropia_EpetraZoltanLib_hpp_
00041 #define _Isorropia_EpetraZoltanLib_hpp_
00042 
00043 #include <Isorropia_ConfigDefs.hpp>
00044 #include <Teuchos_RCP.hpp>
00045 #include <Teuchos_ParameterList.hpp>
00046 
00047 #include <Isorropia_EpetraCostDescriber.hpp>
00048 #include <Isorropia_EpetraLibrary.hpp>
00049 
00050 #include <QueryObject.hpp>
00051 #include <zoltan_cpp.h>
00052 
00053 #ifdef HAVE_EPETRA
00054 class Epetra_Map;
00055 class Epetra_BlockMap;
00056 class Epetra_Import;
00057 class Epetra_Vector;
00058 class Epetra_MultiVector;
00059 class Epetra_CrsGraph;
00060 class Epetra_CrsMatrix;
00061 class Epetra_RowMatrix;
00062 class Epetra_LinearProblem;
00063 
00064 namespace Isorropia {
00065 
00066 namespace Epetra {
00067   class CostDescriber;
00068 
00069 
00070 class ZoltanLibClass : public Library {
00071 public:
00072 
00073   ZoltanLibClass(Teuchos::RCP<const Epetra_CrsGraph> input_graph, int inputType=unspecified_input_);
00074   ZoltanLibClass(Teuchos::RCP<const Epetra_CrsGraph> input_graph, 
00075      Teuchos::RCP<const Epetra_MultiVector> input_coords, int inputType=unspecified_input_);
00076   ZoltanLibClass(Teuchos::RCP<const Epetra_CrsGraph> input_graph,
00077            Teuchos::RCP<CostDescriber> costs, int inputType=unspecified_input_);
00078   ZoltanLibClass(Teuchos::RCP<const Epetra_CrsGraph> input_graph, Teuchos::RCP<CostDescriber> costs, 
00079                  Teuchos::RCP<const Epetra_MultiVector> input_coords, Teuchos::RCP<const Epetra_MultiVector> weights, 
00080                  int inputType=unspecified_input_);
00081   ZoltanLibClass(Teuchos::RCP<const Epetra_RowMatrix> input_matrix, int inputType=unspecified_input_);
00082   ZoltanLibClass(Teuchos::RCP<const Epetra_RowMatrix> input_matrix, 
00083                  Teuchos::RCP<const Epetra_MultiVector> input_coords, int inputType=unspecified_input_);
00084   ZoltanLibClass(Teuchos::RCP<const Epetra_RowMatrix> input_matrix,
00085            Teuchos::RCP<CostDescriber> costs, int inputType=unspecified_input_);
00086   ZoltanLibClass(Teuchos::RCP<const Epetra_RowMatrix> input_matrix, Teuchos::RCP<CostDescriber> costs, 
00087      Teuchos::RCP<const Epetra_MultiVector> input_coords, Teuchos::RCP<const Epetra_MultiVector> weights,
00088                  int inputType=unspecified_input_);
00089   ZoltanLibClass(Teuchos::RCP<const Epetra_MultiVector> input_coords, int inputType=unspecified_input_);
00090   ZoltanLibClass(Teuchos::RCP<const Epetra_MultiVector> input_coords,
00091             Teuchos::RCP<const Epetra_MultiVector> weights, int inputType=unspecified_input_);
00092   ZoltanLibClass(Teuchos::RCP<const Epetra_BlockMap> input_map, int inputType=unspecified_input_);
00093 
00094 
00095 
00096 
00115   virtual int
00116   repartition(Teuchos::ParameterList& paramlist,
00117         std::vector<int>& newPartitions,
00118         int& exportsSize,
00119         std::vector<int>& imports);
00120 
00128   virtual int
00129   color(Teuchos::ParameterList& paramlist,
00130   std::vector<int>& colorAssignment);
00131 
00139   virtual int
00140   order(Teuchos::ParameterList& paramlist,
00141   std::vector<int>& orderAssignment);
00142 
00143 protected:
00144   virtual int precompute();
00145   virtual int postcompute();
00146   void computeCost();
00147   void preCheckPartition();
00148 
00149   void setParameterList(Teuchos::ParameterList& zoltanParamList);
00150 
00151 private:
00152   Teuchos::ParameterList zoltanParamList_;
00153   std::string partMethod_; // stores partitioning method used, perhaps should be in EpetraLibrary?
00154   Zoltan *zz_;
00155   Teuchos::RCP<ZoltanLib::QueryObject> queryObject_;
00156   int num_obj_;
00157 
00158 };//class ZoltanLibClass
00159 
00160 }//namespace Epetra
00161 }//namespace Isorropia
00162 
00163 #endif //HAVE_EPETRA
00164 
00165 #endif
00166