Isorropia: Partitioning, Load Balancing and more
Isorropia_LevelScheduler.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_LevelScheduler_hpp_
41 #define _Isorropia_LevelScheduler_hpp_
42 
43 #include <Isorropia_ConfigDefs.hpp>
44 #include <Isorropia_Operator.hpp>
45 
46 namespace Isorropia {
47 
55 class LevelScheduler : virtual public Operator {
56 public:
57 
59  virtual ~LevelScheduler() {}
60 
61 
72  virtual void schedule(bool forceScheduling=false) = 0;
73 
74 
82  virtual int numLevels() const {
83  return numLocalProperties(); }
84 
93  virtual int numElemsWithLevel(int level) const
94  { return numElemsWithProperty(level); }
95 
96 
108  virtual void elemsWithLevel(int level,
109  int* elementList,
110  int len) const {
111  return elemsWithProperty(level, elementList, len);}
112 
113 };//class LevelScheduler
114 
115 }//namespace Isorropia
116 
117 #endif
118 
virtual int numElemsWithLevel(int level) const
Return the number of elements in a given level.
Definition: Isorropia_LevelScheduler.hpp:93
Interface (abstract base class) for an operator that computes a partitioning of local elements into l...
Definition: Isorropia_LevelScheduler.hpp:55
virtual int numLocalProperties() const =0
Return the number of different values used for &quot;properties&quot; for this process only.
virtual int numLevels() const
Method which returns the number of levels.
Definition: Isorropia_LevelScheduler.hpp:82
virtual void elemsWithLevel(int level, int *elementList, int len) const
Fill user-allocated list (of length len) with the local ID for each element in the given level...
Definition: Isorropia_LevelScheduler.hpp:108
virtual ~LevelScheduler()
Destructor.
Definition: Isorropia_LevelScheduler.hpp:59
Interface (abstract base class) for computing a new partitioning/coloring/ ordering and exploiting th...
Definition: Isorropia_Operator.hpp:58
virtual void schedule(bool forceScheduling=false)=0
Method which does the work of computing a new level schedule.
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 numElemsWithProperty(int property) const =0
Return the number of LOCAL elements with the given property.