Isorropia: Partitioning, Load Balancing and more
Isorropia_Colorer.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_Colorer_hpp_
00041 #define _Isorropia_Colorer_hpp_
00042 
00043 #include <Isorropia_ConfigDefs.hpp>
00044 #include <Teuchos_ParameterList.hpp>
00045 #include <Isorropia_Operator.hpp>
00046 
00047 namespace Isorropia {
00048 
00055 class Colorer : virtual public Operator {
00056 public:
00057 
00059   virtual ~Colorer() {}
00060 
00061 
00072   virtual void color(bool forceColoring=false) = 0;
00073 
00074 
00082   virtual int numColors() const {
00083       return numProperties(); }
00084 
00085 
00094   virtual int numElemsWithColor(int color) const
00095   { return numElemsWithProperty(color); }
00096 
00097 
00109   virtual void elemsWithColor(int color,
00110             int* elementList,
00111             int len) const {
00112     return elemsWithProperty(color, elementList, len);}
00113 
00127   virtual int extractColorsView(int& size,
00128              const int*& array) const {
00129     return extractPropertiesView(size, array);
00130   }
00131 
00132 
00147   virtual int extractColorsCopy(int len,
00148              int& size,
00149              int* array) const {
00150     return extractPropertiesCopy(len, size, array);
00151   }
00152 
00153 
00154 };//class Colorer
00155 
00156 }//namespace Isorropia
00157 
00158 #endif
00159