Ifpack2 Templated Preconditioning Package  Version 1.0
Ifpack2_Details_UserPartitioner_def.hpp
1 /*@HEADER
2 // ***********************************************************************
3 //
4 // Ifpack2: Tempated 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>
55 UserPartitioner (const Teuchos::RCP<const row_graph_type>& graph) :
56  OverlappingPartitioner<GraphType> (graph)
57 {}
58 
59 template<class GraphType>
61 
62 template<class GraphType>
63 void
65 setPartitionParameters (Teuchos::ParameterList& List)
66 {
67  map_ = List.get ("partitioner: map", map_);
68  TEUCHOS_TEST_FOR_EXCEPTION(
69  map_.is_null (), std::runtime_error, "Ifpack2::UserPartitioner::"
70  "computePartitions: Map_ is null.");
71 }
72 
73 template<class GraphType>
75 {
76  TEUCHOS_TEST_FOR_EXCEPTION(
77  map_.is_null (), std::logic_error, "Ifpack2::UserPartitioner::"
78  "computePartitions: Map_ is null.");
79 
80  const size_t localNumRows = this->Graph_->getNodeNumRows ();
81  for (size_t ii = 0; ii < localNumRows; ++ii) {
82  this->Partition_[ii] = map_[ii];
83  }
84  // IGNORING ALL THE SINGLETON STUFF IN IFPACK_USERPARTITIONER.CPP BY
85  // ORDERS OF CHRIS SIEFERT
86 }
87 
88 }// namespace Details
89 }// namespace Ifpack2
90 
91 #endif // IFPACK2_USERPARTITIONER_DEF_HPP
92 
93 
Teuchos::Array< local_ordinal_type > Partition_
Definition: Ifpack2_OverlappingPartitioner_decl.hpp:171
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:74
Ifpack2 implementation details.
Declaration of a user-defined partitioner in which the user can define a nonoverlapping partition of ...
Teuchos::RCP< const row_graph_type > Graph_
The graph to be partitioned.
Definition: Ifpack2_OverlappingPartitioner_decl.hpp:178
virtual ~UserPartitioner()
Destructor.
Definition: Ifpack2_Details_UserPartitioner_def.hpp:60
Definition: Ifpack2_OverlappingPartitioner_decl.hpp:77
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:72
void setPartitionParameters(Teuchos::ParameterList &List)
Sets all the parameters for the partitioner. The only valid parameter is:
Definition: Ifpack2_Details_UserPartitioner_def.hpp:65