/usr/include/trilinos/Isorropia_Partitioner.hpp is in libtrilinos-dev 10.4.0.dfsg-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 | //@HEADER
/*
************************************************************************
Isorropia: Partitioning and Load Balancing Package
Copyright (2006) Sandia Corporation
Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
license for use of this work by or on behalf of the U.S. Government.
This library is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation; either version 2.1 of the
License, or (at your option) any later version.
This library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA
************************************************************************
*/
//@HEADER
#ifndef _Isorropia_Partitioner_hpp_
#define _Isorropia_Partitioner_hpp_
#include <Isorropia_ConfigDefs.hpp>
#include <Teuchos_ParameterList.hpp>
namespace Isorropia {
/** Interface (abstract base class) for computing a new partitioning and
describing the layout of elements in the new partition (the parts).
If the methods which describe the new partitioning (e.g.,
operator [], elemsInPart()) are called before compute_partitioning()
has been called, behavior is not well defined. Implementations will
either return empty/erroneous data, or throw an exception. In most
cases, implementations will probably call compute_partitioning()
internally in a constructor or factory method, so this won't usually
be an issue.
*/
class Partitioner : virtual public Operator {
public:
/** Destructor */
virtual ~Partitioner() {}
/** Method which does the work of computing a new partitioning.
Implementations of this interface will typically be constructed
with an object or information describing the existing ('old')
partitioning. This method computes a 'new' rebalanced
partitioning for that input data.
\param forceRepartitioning Optional argument defaults to false.
Depending on the implementation, partitioning() should
only perform a repartitioning the first time it is called, and
subsequent repeated calls are no-ops. If the user's intent is
to re-compute the partitioning (e.g., if parameters or other
inputs have been changed), then setting this flag to true
will force a new partitioning to be computed.
\sa Isorropia::Operator::compute()
*/
virtual void partition(bool forceRepartitioning=false) = 0;
/** Return the number of LOCAL elements in a given part.
\param[in] part the part ID we want to know the number of local
elements.
\return number of local elements that belongs to the
given part.
\sa Isorropia::Operator::numElemsWithProperty()
*/
virtual int numElemsInPart(int part) const = 0;
/** Fill user-allocated list (of length len) with the
local element ids to be located in the given part
\param[in] part the part ID we consider
\param[out] elementList array of elements that belongs to this
part ID, must be allocated by user with size at least @c len
\param[in] len maximum number of elements we can put in the
array. Usually, may be the result of
Isorropia::Partitioner::numElemsInPart(). .
\sa Isorropia::Operator::elemsWithProperty()
*/
virtual void elemsInPart(int part,
int* elementList,
int len) const = 0;
/** Give access of the part assignments array that is owned by the current
processor.
\param[out] size Number of elements in the array.
\param[out] array Pointer to the the part assignements array inside
the object.
\remark This pointer is only significant if the object still exists.
Otherwise, you must use \see Isorropia::Operator::extractPartsCopy()
\sa Isorropia::Operator::extractPropertiesView()
*/
virtual int extractPartsView(int& size,
const int*& array) const {
return extractPropertiesView(size, array);
}
/** Copy a part of the part assignment array.
\param[in] len of the array given by the user.
\param[out] size Number of elements in the array.
\param[out] array Array of part assignments. Allocated by the user with
a size of at least @c len elements.
\remark Memory space which is not useful in the array is not
initialized or used in this method.
\sa Isorropia::Operator::extractPropertiesCopy()
*/
virtual int extractPartsCopy(int len,
int& size,
int* array) const {
return extractPropertiesCopy(len, size, array);
}
};//class Partitioner
}//namespace Isorropia
#endif
|