Ifpack2 Templated Preconditioning Package  Version 1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Ifpack2_Details_UserPartitioner_def.hpp
1 /*@HEADER
2 // ***********************************************************************
3 //
4 // Ifpack2: Templated Object-Oriented Algebraic Preconditioner Package
5 // Copyright (2009) 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 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 //@HEADER
41 */
42 
43 #ifndef IFPACK2_USER_PARTITIONER_DEF_HPP
44 #define IFPACK2_USER_PARTITIONER_DEF_HPP
45 
46 #include <Ifpack2_ConfigDefs.hpp>
48 #include <Ifpack2_OverlappingPartitioner.hpp>
49 
50 namespace Ifpack2 {
51 namespace Details {
52 
53 template<class GraphType>
56  OverlappingPartitioner<GraphType> (graph),
57  userProvidedParts_(false),
58  userProvidedMap_(false)
59 {}
60 
61 template<class GraphType>
63 
64 template<class GraphType>
65 void
68 {
69  userProvidedParts_ = List.isParameter("partitioner: parts");
70  userProvidedMap_ = List.isParameter("partitioner: map");
71  if (userProvidedParts_ && userProvidedMap_) {
72  TEUCHOS_TEST_FOR_EXCEPTION(true, std::runtime_error, "Ifpack2::UserPartitioner::setPartitionParameters: "
73  "you may specify only one of \"partitioner: parts\" and \"partitioner: map\","
74  " not both");
75  }
76  if (userProvidedMap_) {
77  map_ = List.get ("partitioner: map", map_);
79  map_.is_null (), std::runtime_error, "Ifpack2::UserPartitioner::"
80  "setPartitionParameters: map_ is null.");
81  }
82  if (userProvidedParts_) {
84  //FIXME JJH 9-Dec-2015 - This is a potentially expensive deep copy. Use an ArrayRCP<ArrayRCP<int>> instead.
85  this->Parts_ = List.get<parts_type>("partitioner: parts");
86  List.remove("partitioner: parts"); //JJH I observed that iterating through the ParameterList is much more
87  //expensive when "partitioner: collection" is a Parameter object.
88  //Thus, I remove it once it's fetched from the list.
89  }
90 }
91 
92 template<class GraphType>
94 {
95  if (userProvidedParts_) {
96  this->NumLocalParts_ = this->Parts_.size();
97  //The user has explicitly defined Parts_, so there is no need to for Partition_.
98  this->Partition_.resize(0);
99  } else {
101  map_.is_null (), std::logic_error, "Ifpack2::UserPartitioner::"
102  "computePartitions: map_ is null.");
103  const size_t localNumRows = this->Graph_->getNodeNumRows ();
104  for (size_t ii = 0; ii < localNumRows; ++ii) {
105  this->Partition_[ii] = map_[ii];
106  }
107  }
108  // IGNORING ALL THE SINGLETON STUFF IN IFPACK_USERPARTITIONER.CPP BY
109  // ORDERS OF CHRIS SIEFERT
110 }
111 
112 }// namespace Details
113 }// namespace Ifpack2
114 
115 #endif // IFPACK2_USERPARTITIONER_DEF_HPP
116 
117 
T & get(const std::string &name, T def_value)
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
UserPartitioner(const Teuchos::RCP< const row_graph_type > &graph)
Constructor.
Definition: Ifpack2_Details_UserPartitioner_def.hpp:55
void computePartitions()
Compute the partitions.
Definition: Ifpack2_Details_UserPartitioner_def.hpp:93
Declaration of a user-defined partitioner in which the user can define a partition of the graph...
bool isParameter(const std::string &name) const
bool remove(std::string const &name, bool throwIfNotExists=true)
virtual ~UserPartitioner()
Destructor.
Definition: Ifpack2_Details_UserPartitioner_def.hpp:62
Create overlapping partitions of a local graph.
Definition: Ifpack2_OverlappingPartitioner_decl.hpp:78
void setPartitionParameters(Teuchos::ParameterList &List)
Sets all the parameters for the partitioner. The only valid parameters are:
Definition: Ifpack2_Details_UserPartitioner_def.hpp:67