Isorropia: Partitioning, Load Balancing and more
Isorropia_Operator.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_Operator_hpp_
41#define _Isorropia_Operator_hpp_
42
44#include <Teuchos_ParameterList.hpp>
45
46namespace Isorropia {
47
58class Operator {
59public:
60
62 virtual ~Operator() {}
63
71 virtual void setParameters(const Teuchos::ParameterList& paramlist) = 0;
72
85 virtual void compute(bool forceRecomputing=false) = 0;
86
87
89
94 virtual bool alreadyComputed() const = 0;
95
96
108 virtual int numProperties() const = 0;
109
116 virtual int numLocalProperties() const = 0;
117
118
126 virtual const int& operator[](int myElem) const = 0;
127
128
135 virtual int numElemsWithProperty(int property) const = 0;
136
137
153 virtual void elemsWithProperty(int property,
154 int* elementList,
155 int len) const = 0;
156
157
171 virtual int extractPropertiesView(int& size,
172 const int*& array) const = 0;
173
174
189 virtual int extractPropertiesCopy(int len,
190 int& size,
191 int* array) const = 0;
192
194
195};//class Operator
196
197}//namespace Isorropia
198
199#endif
200
Interface (abstract base class) for computing a new partitioning/coloring/ ordering and exploiting th...
Definition Isorropia_Operator.hpp:58
virtual ~Operator()
Destructor.
Definition Isorropia_Operator.hpp:62
virtual void setParameters(const Teuchos::ParameterList &paramlist)=0
Set parameters for the Operator instance.
virtual bool alreadyComputed() const =0
Query whether the computation has already been called.
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 const int & operator[](int myElem) const =0
Return the "property" for a given element that resided locally.
virtual int numLocalProperties() const =0
Return the number of different values used for "properties" for this process only.
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 void compute(bool forceRecomputing=false)=0
Method which does the work of computing a new partitioning/coloring/ordering, depending on the child ...
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