Ifpack2 Templated Preconditioning Package Version 1.0
Loading...
Searching...
No Matches
Ifpack2_LinePartitioner_decl.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_LINEPARTITIONER_DECL_HPP
44#define IFPACK2_LINEPARTITIONER_DECL_HPP
45
46#include "Ifpack2_ConfigDefs.hpp"
47#include "Ifpack2_OverlappingPartitioner.hpp"
48#include "Teuchos_ScalarTraits.hpp"
49#include "Tpetra_MultiVector.hpp"
50
51namespace Ifpack2 {
52
54
76
77 template<class GraphType,class Scalar>
78class LinePartitioner : public OverlappingPartitioner<GraphType> {
79public:
80 typedef typename GraphType::local_ordinal_type local_ordinal_type;
81 typedef typename GraphType::global_ordinal_type global_ordinal_type;
82 typedef typename GraphType::node_type node_type;
83 typedef Tpetra::RowGraph<local_ordinal_type, global_ordinal_type, node_type> row_graph_type;
84 typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType magnitude_type;
85 typedef Tpetra::MultiVector<magnitude_type,local_ordinal_type, global_ordinal_type, node_type> multivector_type;
86
87 typedef typename row_graph_type::nonconst_global_inds_host_view_type nonconst_global_inds_host_view_type;
88 typedef typename row_graph_type::nonconst_local_inds_host_view_type nonconst_local_inds_host_view_type;
89
91 LinePartitioner(const Teuchos::RCP<const row_graph_type>& graph);
92
94 virtual ~LinePartitioner();
95
97 void setPartitionParameters(Teuchos::ParameterList& List);
98
100 void computePartitions();
101
102private:
103 // Useful functions
104 int Compute_Blocks_AutoLine(Teuchos::ArrayView<local_ordinal_type> blockIndices) const;
105 void local_automatic_line_search(int NumEqns, Teuchos::ArrayView <local_ordinal_type> blockIndices, local_ordinal_type last, local_ordinal_type next, local_ordinal_type LineID, double tol, Teuchos::Array<local_ordinal_type> itemp, Teuchos::Array<magnitude_type> dtemp) const;
106
107
108
109 // User data
110 int NumEqns_;
111 Teuchos::RCP<multivector_type> coord_;
112 double threshold_;
113
114};
115
116}// namespace Ifpack2
117
118#endif // IFPACK2_LINEPARTITIONER_DECL_HPP
Ifpack2::LinePartitioner: A class to define partitions into a set of lines.
Definition Ifpack2_LinePartitioner_decl.hpp:78
LinePartitioner(const Teuchos::RCP< const row_graph_type > &graph)
Constructor.
Definition Ifpack2_LinePartitioner_def.hpp:60
void setPartitionParameters(Teuchos::ParameterList &List)
Set the partitioner's parameters (none for linear partitioning).
Definition Ifpack2_LinePartitioner_def.hpp:72
virtual ~LinePartitioner()
Destructor.
Definition Ifpack2_LinePartitioner_def.hpp:66
void computePartitions()
Compute the partitions.
Definition Ifpack2_LinePartitioner_def.hpp:86
Create overlapping partitions of a local graph.
Definition Ifpack2_OverlappingPartitioner_decl.hpp:78
Preconditioners and smoothers for Tpetra sparse matrices.
Definition Ifpack2_AdditiveSchwarz_decl.hpp:74