Isorropia: Partitioning, Load Balancing and more Version 3.0
Isorropia_Colorer.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_Colorer_hpp_
00031 #define _Isorropia_Colorer_hpp_
00032 
00033 #include <Isorropia_ConfigDefs.hpp>
00034 #include <Teuchos_ParameterList.hpp>
00035 #include <Isorropia_Operator.hpp>
00036 
00037 namespace Isorropia {
00038 
00045 class Colorer : virtual public Operator {
00046 public:
00047 
00049   virtual ~Colorer() {}
00050 
00051 
00062   virtual void color(bool forceColoring=false) = 0;
00063 
00064 
00072   virtual int numColors() const {
00073       return numProperties(); }
00074 
00075 
00084   virtual int numElemsWithColor(int color) const
00085   { return numElemsWithProperty(color); }
00086 
00087 
00099   virtual void elemsWithColor(int color,
00100             int* elementList,
00101             int len) const {
00102     return elemsWithProperty(color, elementList, len);}
00103 
00117   virtual int extractColorsView(int& size,
00118              const int*& array) const {
00119     return extractPropertiesView(size, array);
00120   }
00121 
00122 
00137   virtual int extractColorsCopy(int len,
00138              int& size,
00139              int* array) const {
00140     return extractPropertiesCopy(len, size, array);
00141   }
00142 
00143 
00144 };//class Colorer
00145 
00146 }//namespace Isorropia
00147 
00148 #endif
00149