Isorropia_Partitioner.hpp

Go to the documentation of this file.
00001 //@HEADER
00002 /*
00003 ************************************************************************
00004 
00005               Isorropia: Partitioning and Load Balancing Package
00006                 Copyright (2006) Sandia Corporation
00007 
00008 Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00009 license for use of this work by or on behalf of the U.S. Government.
00010 
00011 This library is free software; you can redistribute it and/or modify
00012 it under the terms of the GNU Lesser General Public License as
00013 published by the Free Software Foundation; either version 2.1 of the
00014 License, or (at your option) any later version.
00015 
00016 This library is distributed in the hope that it will be useful, but
00017 WITHOUT ANY WARRANTY; without even the implied warranty of
00018 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00019 Lesser General Public License for more details.
00020 
00021 You should have received a copy of the GNU Lesser General Public
00022 License along with this library; if not, write to the Free Software
00023 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00024 USA
00025 
00026 ************************************************************************
00027 */
00028 //@HEADER
00029 
00030 #ifndef _Isorropia_Partitioner_hpp_
00031 #define _Isorropia_Partitioner_hpp_
00032 
00033 #include <Isorropia_ConfigDefs.hpp>
00034 #include <Teuchos_ParameterList.hpp>
00035 
00036 namespace Isorropia {
00037 
00049 class Partitioner : virtual public Operator {
00050 public:
00051 
00053   virtual ~Partitioner() {}
00054 
00071   virtual void partition(bool forceRepartitioning=false) = 0;
00072 
00073 
00074 
00076 
00088   virtual  int newPartNumber(int myElem) const = 0;
00090 
00091 
00102   virtual  int numElemsInPart(int part) const = 0;
00103 
00104 
00119   virtual  void elemsInPart(int part,
00120           int* elementList,
00121           int len) const = 0;
00122 
00124 
00137   virtual __deprecated void compute_partitioning(bool forceRepartitioning=false) {
00138     return (partition(forceRepartitioning));
00139   }
00140 
00148   virtual __deprecated bool partitioning_already_computed() const = 0 ;
00149 
00150 
00161   virtual __deprecated int newPartitionNumber(int myElem) {
00162     return (newPartNumber(myElem));
00163   }
00164 
00165 
00173   virtual __deprecated int numElemsInPartition(int partition) {
00174     return (numElemsInPart(partition));
00175   }
00176 
00185   virtual __deprecated void elemsInPartition(int part,
00186                                 int* elementList,
00187                                 int len) {
00188     return (elemsInPart(part, elementList, len));
00189   }
00190 
00192 
00193 };//class Partitioner
00194 
00195 }//namespace Isorropia
00196 
00197 #endif
00198