Ifpack2 Templated Preconditioning Package Version 1.0
Loading...
Searching...
No Matches
Ifpack2_Partitioner.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_PARTITIONER_HPP
44#define IFPACK2_PARTITIONER_HPP
45
46#include "Ifpack2_ConfigDefs.hpp"
47#include "Teuchos_ParameterList.hpp"
48#include "Teuchos_ArrayRCP.hpp"
49#include <iostream>
50
51namespace Ifpack2 {
52
54
178template <class GraphType>
179class Partitioner : public Teuchos::Describable {
180public:
181 typedef typename GraphType::local_ordinal_type LocalOrdinal;
182 typedef typename GraphType::global_ordinal_type GlobalOrdinal;
183 typedef typename GraphType::node_type Node;
184
186 virtual ~Partitioner() {};
187
192 virtual int numLocalParts () const = 0;
193
195 virtual int overlappingLevel() const = 0;
196
201 virtual LocalOrdinal operator() (LocalOrdinal MyRow) const = 0;
202
204 virtual LocalOrdinal operator() (LocalOrdinal i, LocalOrdinal j) const = 0;
205
207 virtual size_t numRowsInPart (const LocalOrdinal Part) const = 0;
208
210 virtual void
211 rowsInPart (const LocalOrdinal Part,
212 Teuchos::ArrayRCP<LocalOrdinal>& List) const = 0;
213
215 virtual Teuchos::ArrayView<const LocalOrdinal>
217
219 virtual void setParameters (Teuchos::ParameterList& List) = 0;
220
222 virtual void compute () = 0;
223
225 virtual bool isComputed () const = 0;
226
228 virtual std::ostream& print (std::ostream& os) const = 0;
229
230};
231
232// Overloaded output stream operator for Partitioner
233template <class GraphType>
234inline std::ostream&
235operator<< (std::ostream& os,
237{
238 return obj.print (os);
239}
240
241} // namespace Ifpack2
242
243#endif // IFPACK2_PARTITIONER_HPP
Ifpack2::Partitioner:
Definition: Ifpack2_Partitioner.hpp:179
virtual LocalOrdinal operator()(LocalOrdinal MyRow) const =0
The local (nonoverlapping) partition index of the specified local row.
virtual int numLocalParts() const =0
Number of computed local partitions.
virtual Teuchos::ArrayView< const LocalOrdinal > nonOverlappingPartition() const =0
The nonoverlapping partition indices of each local row.
virtual ~Partitioner()
Destructor.
Definition: Ifpack2_Partitioner.hpp:186
virtual bool isComputed() const =0
Return true if partitions have been computed successfully.
virtual void compute()=0
Compute the partitions.
virtual void rowsInPart(const LocalOrdinal Part, Teuchos::ArrayRCP< LocalOrdinal > &List) const =0
Copy into List the rows in the (overlapping) partition Part.
virtual std::ostream & print(std::ostream &os) const =0
Print basic information about the partitioning object.
virtual void setParameters(Teuchos::ParameterList &List)=0
Set all the parameters for the partitioner.
virtual size_t numRowsInPart(const LocalOrdinal Part) const =0
The number of rows contained in the specified partition.
virtual int overlappingLevel() const =0
The level of overlap.
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:74