Ifpack2 Templated Preconditioning Package Version 1.0
Loading...
Searching...
No Matches
Ifpack2_ReorderFilter_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_REORDERFILTER_DECL_HPP
44#define IFPACK2_REORDERFILTER_DECL_HPP
45
46#include "Ifpack2_ConfigDefs.hpp"
47#include "Ifpack2_Details_RowMatrix.hpp"
48#include <type_traits>
49
50namespace Ifpack2 {
51
68template<class MatrixType>
70 virtual public Ifpack2::Details::RowMatrix<MatrixType> {
71public:
72 typedef typename MatrixType::scalar_type scalar_type;
73 typedef typename MatrixType::local_ordinal_type local_ordinal_type;
74 typedef typename MatrixType::global_ordinal_type global_ordinal_type;
75 typedef typename MatrixType::node_type node_type;
76 typedef typename MatrixType::global_inds_host_view_type global_inds_host_view_type;
77 typedef typename MatrixType::local_inds_host_view_type local_inds_host_view_type;
78 typedef typename MatrixType::values_host_view_type values_host_view_type;
79
80 typedef typename MatrixType::nonconst_global_inds_host_view_type nonconst_global_inds_host_view_type;
81 typedef typename MatrixType::nonconst_local_inds_host_view_type nonconst_local_inds_host_view_type;
82 typedef typename MatrixType::nonconst_values_host_view_type nonconst_values_host_view_type;
83
84 typedef typename Teuchos::ScalarTraits<scalar_type>::magnitudeType magnitude_type;
85 typedef Tpetra::RowMatrix<scalar_type,
86 local_ordinal_type,
87 global_ordinal_type,
88 node_type> row_matrix_type;
89
90 static_assert(std::is_same<MatrixType, row_matrix_type>::value, "Ifpack2::ReorderFilter: The template parameter MatrixType must be a Tpetra::RowMatrix specialization. Please don't use Tpetra::CrsMatrix (a subclass of Tpetra::RowMatrix) here anymore. The constructor can take either a RowMatrix or a CrsMatrix just fine.");
91
92 typedef Tpetra::Map<local_ordinal_type,
93 global_ordinal_type,
94 node_type> map_type;
95
96 typedef typename row_matrix_type::mag_type mag_type;
97
99
100
116 ReorderFilter (const Teuchos::RCP<const row_matrix_type>& A,
117 const Teuchos::ArrayRCP<local_ordinal_type>& perm,
118 const Teuchos::ArrayRCP<local_ordinal_type>& reverseperm);
119
121 virtual ~ReorderFilter ();
122
124
126
128 virtual Teuchos::RCP<const Teuchos::Comm<int> > getComm() const;
129
130
132 virtual Teuchos::RCP<const map_type> getRowMap() const;
133
135 virtual Teuchos::RCP<const map_type> getColMap() const;
136
138 virtual Teuchos::RCP<const map_type> getDomainMap() const;
139
141 virtual Teuchos::RCP<const map_type> getRangeMap() const;
142
144 virtual Teuchos::RCP<const Tpetra::RowGraph<local_ordinal_type,global_ordinal_type,node_type> > getGraph() const;
145
147 virtual global_size_t getGlobalNumRows() const;
148
150 virtual global_size_t getGlobalNumCols() const;
151
153 virtual size_t getLocalNumRows() const;
154
156 virtual size_t getLocalNumCols() const;
157
159 virtual global_ordinal_type getIndexBase() const;
160
162 virtual global_size_t getGlobalNumEntries() const;
163
165 virtual size_t getLocalNumEntries() const;
166
173 virtual size_t getNumEntriesInGlobalRow (global_ordinal_type globalRow) const;
174
181 virtual size_t getNumEntriesInLocalRow (local_ordinal_type localRow) const;
182
184 virtual size_t getGlobalMaxNumRowEntries() const;
185
187 virtual size_t getLocalMaxNumRowEntries() const;
188
190 virtual bool hasColMap() const;
191
193 virtual bool isLocallyIndexed() const;
194
196 virtual bool isGloballyIndexed() const;
197
199 virtual bool isFillComplete() const;
200
202 virtual bool supportsRowViews() const;
203
205
207
208
210
220 virtual void
221 getGlobalRowCopy (global_ordinal_type GlobalRow,
222 nonconst_global_inds_host_view_type &Indices,
223 nonconst_values_host_view_type &Values,
224 size_t& NumEntries) const;
225
227
237 virtual void
238 getLocalRowCopy (local_ordinal_type LocalRow,
239 nonconst_local_inds_host_view_type &Indices,
240 nonconst_values_host_view_type &Values,
241 size_t& NumEntries) const;
242
244
252 virtual void
253 getGlobalRowView (global_ordinal_type GlobalRow,
254 global_inds_host_view_type &indices,
255 values_host_view_type &values) const;
256
258
267 virtual void
268 getLocalRowView (local_ordinal_type LocalRow,
269 local_inds_host_view_type & indices,
270 values_host_view_type & values) const;
271
273
275 virtual void getLocalDiagCopy(Tpetra::Vector<scalar_type,local_ordinal_type,global_ordinal_type,node_type> &diag) const;
276
278
280
281
291 virtual void leftScale(const Tpetra::Vector<scalar_type, local_ordinal_type, global_ordinal_type, node_type>& x);
292
302 virtual void rightScale(const Tpetra::Vector<scalar_type, local_ordinal_type, global_ordinal_type, node_type>& x);
303
305
308 virtual mag_type getFrobeniusNorm() const;
309
331 virtual void
332 apply (const Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type> &X,
333 Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type> &Y,
334 Teuchos::ETransp mode = Teuchos::NO_TRANS,
335 scalar_type alpha = Teuchos::ScalarTraits<scalar_type>::one(),
336 scalar_type beta = Teuchos::ScalarTraits<scalar_type>::zero()) const;
337
339 virtual bool hasTransposeApply() const;
340
342 virtual void permuteOriginalToReordered(const Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type> &originalX,
343 Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type> &reorderedY) const;
344
345 template <class DomainScalar, class RangeScalar>
346 void
347 permuteOriginalToReorderedTempl (const Tpetra::MultiVector<DomainScalar,local_ordinal_type,global_ordinal_type,node_type> &originalX,
348 Tpetra::MultiVector<RangeScalar,local_ordinal_type,global_ordinal_type,node_type> &reorderedY) const;
349
351 virtual void permuteReorderedToOriginal(const Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type> &reorderedX,
352 Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type> &originalY) const;
353
354 template <class DomainScalar, class RangeScalar>
355 void permuteReorderedToOriginalTempl(const Tpetra::MultiVector<DomainScalar,local_ordinal_type,global_ordinal_type,node_type> &reorderedX,
356 Tpetra::MultiVector<RangeScalar,local_ordinal_type,global_ordinal_type,node_type> &originalY) const;
358
359private:
361 Teuchos::RCP<const row_matrix_type> A_;
363 Teuchos::ArrayRCP<local_ordinal_type> perm_;
365 Teuchos::ArrayRCP<local_ordinal_type> reverseperm_;
366
368 mutable nonconst_local_inds_host_view_type Indices_;
370 mutable nonconst_values_host_view_type Values_;
371};// class ReorderFilter
372
373}// namespace Ifpack2
374
375#endif /* IFPACK2_REORDERFILTER_DECL_HPP */
All Ifpack2 implementations of Tpetra::RowMatrix must inherit from this class.
Definition: Ifpack2_Details_RowMatrix.hpp:67
Wraps a Tpetra::RowMatrix in a filter that reorders local rows and columns.
Definition: Ifpack2_ReorderFilter_decl.hpp:70
virtual size_t getLocalNumCols() const
Returns the number of columns needed to apply the forward operator on this node, i....
Definition: Ifpack2_ReorderFilter_def.hpp:180
virtual size_t getNumEntriesInGlobalRow(global_ordinal_type globalRow) const
The current number of entries in this matrix, stored on the calling process, in the row whose global ...
Definition: Ifpack2_ReorderFilter_def.hpp:209
virtual mag_type getFrobeniusNorm() const
Returns the Frobenius norm of the matrix.
Definition: Ifpack2_ReorderFilter_def.hpp:476
virtual size_t getGlobalMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on all nodes.
Definition: Ifpack2_ReorderFilter_def.hpp:246
virtual Teuchos::RCP< const map_type > getColMap() const
Returns the Map that describes the column distribution in this matrix.
Definition: Ifpack2_ReorderFilter_def.hpp:114
virtual void rightScale(const Tpetra::Vector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > &x)
Scales the RowMatrix on the right with the Vector x.
Definition: Ifpack2_ReorderFilter_def.hpp:397
virtual bool hasColMap() const
Indicates whether this matrix has a well-defined column map.
Definition: Ifpack2_ReorderFilter_def.hpp:260
virtual size_t getLocalMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on this node.
Definition: Ifpack2_ReorderFilter_def.hpp:253
virtual void permuteReorderedToOriginal(const Tpetra::MultiVector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > &reorderedX, Tpetra::MultiVector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > &originalY) const
Permute multivector: reordered-to-original.
Definition: Ifpack2_ReorderFilter_def.hpp:510
virtual void permuteOriginalToReordered(const Tpetra::MultiVector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > &originalX, Tpetra::MultiVector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > &reorderedY) const
Permute multivector: original-to-reordered.
Definition: Ifpack2_ReorderFilter_def.hpp:485
virtual Teuchos::RCP< const map_type > getDomainMap() const
Returns the Map that describes the domain distribution in this matrix.
Definition: Ifpack2_ReorderFilter_def.hpp:126
virtual bool supportsRowViews() const
Returns true if RowViews are supported.
Definition: Ifpack2_ReorderFilter_def.hpp:469
virtual global_ordinal_type getIndexBase() const
Returns the index base for global indices for this matrix.
Definition: Ifpack2_ReorderFilter_def.hpp:187
virtual void getLocalDiagCopy(Tpetra::Vector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > &diag) const
Get a copy of the diagonal entries owned by this node, with local row indices.
Definition: Ifpack2_ReorderFilter_def.hpp:382
virtual bool isGloballyIndexed() const
If matrix indices are in the global range, this function returns true. Otherwise, this function retur...
Definition: Ifpack2_ReorderFilter_def.hpp:274
virtual Teuchos::RCP< const map_type > getRowMap() const
Returns the Map that describes the row distribution in this matrix.
Definition: Ifpack2_ReorderFilter_def.hpp:102
virtual size_t getLocalNumRows() const
Returns the number of rows owned on the calling node.
Definition: Ifpack2_ReorderFilter_def.hpp:173
virtual Teuchos::RCP< const map_type > getRangeMap() const
Returns the Map that describes the range distribution in this matrix.
Definition: Ifpack2_ReorderFilter_def.hpp:138
virtual Teuchos::RCP< const Teuchos::Comm< int > > getComm() const
The matrix's communicator.
Definition: Ifpack2_ReorderFilter_def.hpp:92
virtual bool isFillComplete() const
Returns true if fillComplete() has been called.
Definition: Ifpack2_ReorderFilter_def.hpp:281
virtual bool isLocallyIndexed() const
If matrix indices are in the local range, this function returns true. Otherwise, this function return...
Definition: Ifpack2_ReorderFilter_def.hpp:267
virtual size_t getLocalNumEntries() const
Returns the local number of entries in this matrix.
Definition: Ifpack2_ReorderFilter_def.hpp:201
virtual ~ReorderFilter()
Destructor.
Definition: Ifpack2_ReorderFilter_def.hpp:88
virtual void getGlobalRowCopy(global_ordinal_type GlobalRow, nonconst_global_inds_host_view_type &Indices, nonconst_values_host_view_type &Values, size_t &NumEntries) const
Extract a list of entries in a specified global row of this matrix. Put into pre-allocated storage.
Definition: Ifpack2_ReorderFilter_def.hpp:289
virtual void getLocalRowView(local_ordinal_type LocalRow, local_inds_host_view_type &indices, values_host_view_type &values) const
Extract a const, non-persisting view of local indices in a specified row of the matrix.
Definition: Ifpack2_ReorderFilter_def.hpp:371
virtual size_t getNumEntriesInLocalRow(local_ordinal_type localRow) const
The current number of entries in this matrix, stored on the calling process, in the row whose local i...
Definition: Ifpack2_ReorderFilter_def.hpp:230
virtual void getLocalRowCopy(local_ordinal_type LocalRow, nonconst_local_inds_host_view_type &Indices, nonconst_values_host_view_type &Values, size_t &NumEntries) const
Extract a list of entries in a specified local row of the graph. Put into storage allocated by callin...
Definition: Ifpack2_ReorderFilter_def.hpp:321
virtual Teuchos::RCP< const Tpetra::RowGraph< local_ordinal_type, global_ordinal_type, node_type > > getGraph() const
Returns the RowGraph associated with this matrix.
Definition: Ifpack2_ReorderFilter_def.hpp:152
virtual void apply(const Tpetra::MultiVector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > &X, Tpetra::MultiVector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, scalar_type alpha=Teuchos::ScalarTraits< scalar_type >::one(), scalar_type beta=Teuchos::ScalarTraits< scalar_type >::zero()) const
, where Op(A) is either A, , or .
Definition: Ifpack2_ReorderFilter_def.hpp:405
virtual global_size_t getGlobalNumRows() const
Returns the number of global rows in this matrix.
Definition: Ifpack2_ReorderFilter_def.hpp:159
virtual bool hasTransposeApply() const
Whether apply() can apply the transpose or conjugate transpose.
Definition: Ifpack2_ReorderFilter_def.hpp:462
virtual global_size_t getGlobalNumCols() const
Returns the number of global columns in this matrix.
Definition: Ifpack2_ReorderFilter_def.hpp:166
virtual global_size_t getGlobalNumEntries() const
Returns the global number of entries in this matrix.
Definition: Ifpack2_ReorderFilter_def.hpp:194
virtual void leftScale(const Tpetra::Vector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > &x)
Scales the RowMatrix on the left with the Vector x.
Definition: Ifpack2_ReorderFilter_def.hpp:390
virtual void getGlobalRowView(global_ordinal_type GlobalRow, global_inds_host_view_type &indices, values_host_view_type &values) const
Extract a const, non-persisting view of global indices in a specified row of the matrix.
Definition: Ifpack2_ReorderFilter_def.hpp:361
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:74