Isorropia: Partitioning, Load Balancing and more
Isorropia_Colorer.hpp
Go to the documentation of this file.
1//@HEADER
2//************************************************************************
3//
4// Isorropia: Partitioning and Load Balancing Package
5// Copyright (2006) Sandia Corporation
6//
7//Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8//license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37//************************************************************************
38//@HEADER
39
40#ifndef _Isorropia_Colorer_hpp_
41#define _Isorropia_Colorer_hpp_
42
44#include <Teuchos_ParameterList.hpp>
46
47namespace Isorropia {
48
55class Colorer : virtual public Operator {
56public:
57
59 virtual ~Colorer() {}
60
61
72 virtual void color(bool forceColoring=false) = 0;
73
74
82 virtual int numColors() const {
83 return numProperties(); }
84
85
94 virtual int numElemsWithColor(int theColor) const
95 { return numElemsWithProperty(theColor); }
96
97
109 virtual void elemsWithColor(int theColor,
110 int* elementList,
111 int len) const {
112 return elemsWithProperty(theColor, elementList, len);}
113
127 virtual int extractColorsView(int& size,
128 const int*& array) const {
129 return extractPropertiesView(size, array);
130 }
131
132
147 virtual int extractColorsCopy(int len,
148 int& size,
149 int* array) const {
150 return extractPropertiesCopy(len, size, array);
151 }
152
153
154};//class Colorer
155
156}//namespace Isorropia
157
158#endif
159
Interface (abstract base class) for computing a new coloring and describing the result.
Definition Isorropia_Colorer.hpp:55
virtual ~Colorer()
Destructor.
Definition Isorropia_Colorer.hpp:59
virtual int extractColorsCopy(int len, int &size, int *array) const
Copy a part of the color assignments array.
Definition Isorropia_Colorer.hpp:147
virtual void color(bool forceColoring=false)=0
Method which does the work of computing a new coloring.
virtual int numElemsWithColor(int theColor) const
Return the number of local elements of a given color.
Definition Isorropia_Colorer.hpp:94
virtual void elemsWithColor(int theColor, int *elementList, int len) const
Fill user-allocated list (of length len) with the local element ids for LOCAL elements of the given c...
Definition Isorropia_Colorer.hpp:109
virtual int numColors() const
Method which returns the number (global) of colors used.
Definition Isorropia_Colorer.hpp:82
virtual int extractColorsView(int &size, const int *&array) const
Give access of the color assignments array that is owned by the current processor.
Definition Isorropia_Colorer.hpp:127
Interface (abstract base class) for computing a new partitioning/coloring/ ordering and exploiting th...
Definition Isorropia_Operator.hpp:58
virtual int extractPropertiesCopy(int len, int &size, int *array) const =0
Copy a part of the property array.
virtual int numElemsWithProperty(int property) const =0
Return the number of LOCAL elements with the given property.
virtual int extractPropertiesView(int &size, const int *&array) const =0
Give access of the property array that is owned by the current processor.
virtual void elemsWithProperty(int property, int *elementList, int len) const =0
Fill user-allocated list (of length len) with the local element ids of the LOCAL elements with the gi...
virtual int numProperties() const =0
Return the number of different values used for "properties".
Isorropia is the namespace that contains general definitions that apply to all partitioners and that ...
Definition Isorropia_Epetra.hpp:60