Isorropia: Partitioning, Load Balancing and more
Isorropia_Partitioner.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_Partitioner_hpp_
41#define _Isorropia_Partitioner_hpp_
42
44#include <Teuchos_ParameterList.hpp>
45
46namespace Isorropia {
47
59class Partitioner : virtual public Operator {
60public:
61
63 virtual ~Partitioner() {}
64
81 virtual void partition(bool forceRepartitioning=false) = 0;
82
83
94 virtual int numElemsInPart(int part) const = 0;
95
96
111 virtual void elemsInPart(int part,
112 int* elementList,
113 int len) const = 0;
114
115
129 virtual int extractPartsView(int& size,
130 const int*& array) const {
131 return extractPropertiesView(size, array);
132 }
133
134
149 virtual int extractPartsCopy(int len,
150 int& size,
151 int* array) const {
152 return extractPropertiesCopy(len, size, array);
153 }
154
155};//class Partitioner
156
157}//namespace Isorropia
158
159#endif
160
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 extractPropertiesView(int &size, const int *&array) const =0
Give access of the property array that is owned by the current processor.
Interface (abstract base class) for computing a new partitioning and describing the layout of element...
Definition Isorropia_Partitioner.hpp:59
virtual int numElemsInPart(int part) const =0
Return the number of LOCAL elements in a given part.
virtual int extractPartsView(int &size, const int *&array) const
Give access of the part assignments array that is owned by the current processor.
Definition Isorropia_Partitioner.hpp:129
virtual void partition(bool forceRepartitioning=false)=0
Method which does the work of computing a new partitioning.
virtual void elemsInPart(int part, int *elementList, int len) const =0
Fill user-allocated list (of length len) with the local element ids to be located in the given part.
virtual ~Partitioner()
Destructor.
Definition Isorropia_Partitioner.hpp:63
virtual int extractPartsCopy(int len, int &size, int *array) const
Copy a part of the part assignment array.
Definition Isorropia_Partitioner.hpp:149
Isorropia is the namespace that contains general definitions that apply to all partitioners and that ...
Definition Isorropia_Epetra.hpp:60