Ifpack2 Templated Preconditioning Package Version 1.0
Loading...
Searching...
No Matches
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
50namespace Ifpack2 {
51namespace Details {
52
53template<class GraphType>
55UserPartitioner (const Teuchos::RCP<const row_graph_type>& graph) :
56 OverlappingPartitioner<GraphType> (graph),
57 userProvidedParts_(false),
58 userProvidedMap_(false)
59{}
60
61template<class GraphType>
63
64template<class GraphType>
65void
67setPartitionParameters (Teuchos::ParameterList& List)
68{
69 int partCount = 0;
70 bool globalProvidedParts;
71 userProvidedParts_ = List.isParameter("partitioner: parts");
72 globalProvidedParts = List.isParameter("partitioner: global ID parts");
73 if ( userProvidedParts_) partCount++;
74 if (globalProvidedParts ) { partCount++; userProvidedParts_ = true; }
75
76 userProvidedMap_ = List.isParameter("partitioner: map");
77 if ( userProvidedMap_) partCount++;
78 if (partCount > 1) {
79 TEUCHOS_TEST_FOR_EXCEPTION(true, std::runtime_error, "Ifpack2::UserPartitioner::setPartitionParameters: "
80 "you may specify only one of \"partitioner: parts\", \"partitioner: global ID parts\" and \"partitioner: map\","
81 " not two of them");
82 }
83 if (userProvidedMap_) {
84 map_ = List.get ("partitioner: map", map_);
85 TEUCHOS_TEST_FOR_EXCEPTION(
86 map_.is_null (), std::runtime_error, "Ifpack2::UserPartitioner::"
87 "setPartitionParameters: map_ is null.");
88 }
89 if (userProvidedParts_) {
90 typedef Teuchos::Array<typename Teuchos::ArrayRCP<typename GraphType::local_ordinal_type>> parts_type;
91 typedef Teuchos::Array<typename Teuchos::ArrayRCP<typename GraphType::global_ordinal_type>> gparts_type;
92 //FIXME JJH 9-Dec-2015 - This is a potentially expensive deep copy. Use an ArrayRCP<ArrayRCP<int>> instead.
93
94 // convert glboal ids to local ids before storing in Parts_
95 if (globalProvidedParts ) {
96 gparts_type gparts;
97 gparts = List.get<gparts_type>("partitioner: global ID parts");
98 typedef Teuchos::RCP< Tpetra::Map<typename GraphType::local_ordinal_type, typename GraphType::global_ordinal_type, typename GraphType::node_type> const > map_type;
99 map_type OverlapMap = List.get<map_type>("OverlapRowMap");
100 this->Parts_.resize(gparts.size());
101 for (int ii = 0; ii < (int) gparts.size(); ii++) {
102 this->Parts_[ii].resize(gparts[ii].size());
103 for (int jj = 0; jj < (int) gparts[ii].size(); jj++) {
104 local_ordinal_type itmp = (int) OverlapMap->getLocalElement( gparts[ii][jj] );
105 if (itmp == Teuchos::OrdinalTraits<local_ordinal_type>::invalid()) printf("global id %d (%d,%d) not found\n",(int) gparts[ii][jj],(int) ii, (int) jj);
106 TEUCHOS_TEST_FOR_EXCEPTION(itmp == Teuchos::OrdinalTraits<local_ordinal_type>::invalid(), std::runtime_error, " \"partitioner: global ID parts\" requires that all global IDs within a block reside on the MPI rank owning the block. This can be done using overlapping Schwarz with a BLOCK_RELAXATION subdomain solver making sure that \"schwarz: overlap level\" is sufficient. Note: zeroed out Dirichlet columns will never be included in overlap parts of domains.");
107 this->Parts_[ii][jj] = itmp;
108 }
109 }
110 List.remove("partitioner: global ID parts"); //JJH I observed that iterating through the ParameterList is much more
111 //expensive when "partitioner: collection" is a Parameter object.
112 //Thus, I remove it once it's fetched from the list.
113 }
114 else {
115 this->Parts_ = List.get<parts_type>("partitioner: parts");
116 List.remove("partitioner: parts"); //JJH I observed that iterating through the ParameterList is much more
117 //expensive when "partitioner: collection" is a Parameter object.
118 //Thus, I remove it once it's fetched from the list.
119 }
120 }
121
122}
123
124template<class GraphType>
126{
127 if (userProvidedParts_) {
128 this->NumLocalParts_ = this->Parts_.size();
129 //The user has explicitly defined Parts_, so there is no need to for Partition_.
130 this->Partition_.resize(0);
131 } else {
132 TEUCHOS_TEST_FOR_EXCEPTION(
133 map_.is_null (), std::logic_error, "Ifpack2::UserPartitioner::"
134 "computePartitions: map_ is null.");
135 const size_t localNumRows = this->Graph_->getLocalNumRows ();
136 for (size_t ii = 0; ii < localNumRows; ++ii) {
137 this->Partition_[ii] = map_[ii];
138 }
139 }
140 // IGNORING ALL THE SINGLETON STUFF IN IFPACK_USERPARTITIONER.CPP BY
141 // ORDERS OF CHRIS SIEFERT
142}
143
144}// namespace Details
145}// namespace Ifpack2
146
147#endif // IFPACK2_USERPARTITIONER_DEF_HPP
148
149
Declaration of a user-defined partitioner in which the user can define a partition of the graph....
virtual ~UserPartitioner()
Destructor.
Definition Ifpack2_Details_UserPartitioner_def.hpp:62
void computePartitions()
Compute the partitions.
Definition Ifpack2_Details_UserPartitioner_def.hpp:125
void setPartitionParameters(Teuchos::ParameterList &List)
Sets all the parameters for the partitioner. The only valid parameters are:
Definition Ifpack2_Details_UserPartitioner_def.hpp:67
UserPartitioner(const Teuchos::RCP< const row_graph_type > &graph)
Constructor.
Definition Ifpack2_Details_UserPartitioner_def.hpp:55
Create overlapping partitions of a local graph.
Definition Ifpack2_OverlappingPartitioner_decl.hpp:78
Ifpack2 implementation details.
Preconditioners and smoothers for Tpetra sparse matrices.
Definition Ifpack2_AdditiveSchwarz_decl.hpp:74