Ifpack2 Templated Preconditioning Package Version 1.0
Loading...
Searching...
No Matches
Ifpack2_DiagonalFilter_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_DIAGONALFILTER_DEF_HPP
44#define IFPACK2_DIAGONALFILTER_DEF_HPP
45#include "Ifpack2_DiagonalFilter_decl.hpp"
46#include <vector>
47
48#include "Teuchos_Comm.hpp"
49#include "Tpetra_Map.hpp"
50#include "Tpetra_MultiVector.hpp"
51#include "Tpetra_Vector.hpp"
52
53
54namespace Ifpack2 {
55
56template<class MatrixType>
58DiagonalFilter (const Teuchos::RCP<const Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> >& Matrix,
59 typename Teuchos::ScalarTraits<Scalar>::magnitudeType AbsoluteThreshold,
60 typename Teuchos::ScalarTraits<Scalar>::magnitudeType RelativeThreshold):
61 A_(Matrix),
62 AbsoluteThreshold_(AbsoluteThreshold),
63 RelativeThreshold_(RelativeThreshold)
64{
65 pos_.resize(getLocalNumRows());
66 val_=Teuchos::rcp(new Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node>(A_->getRowMap()));
67
68 nonconst_local_inds_host_view_type Indices("Indices",getLocalMaxNumRowEntries());
69 nonconst_values_host_view_type Values("Values",getLocalMaxNumRowEntries());
70 size_t NumEntries;
71 magnitudeType mysign;
72
73
74 for (size_t MyRow = 0 ; MyRow < getLocalNumRows() ; ++MyRow) {
75 pos_[MyRow] = -1;
76 A_->getLocalRowCopy(MyRow,Indices,Values,NumEntries);
77
78 for (size_t i = 0 ; i < NumEntries ; ++i) {
79 if ((size_t)Indices[i] == MyRow) {
80 pos_[MyRow] = i;
81 if (Teuchos::ScalarTraits<Scalar>::real(Values[i]) < 0) {
82 mysign=-Teuchos::ScalarTraits<magnitudeType>::one();
83 }
84 else {
85 mysign=Teuchos::ScalarTraits<magnitudeType>::one();
86 }
87 val_->replaceLocalValue (MyRow, Values[i] * (RelativeThreshold_ - 1) +
88 AbsoluteThreshold_ * mysign);
89 break;
90 }
91 }
92 }
93}
94
95template<class MatrixType>
97
98template<class MatrixType>
99Teuchos::RCP<const Teuchos::Comm<int> > DiagonalFilter<MatrixType>::getComm() const
100{
101 return A_->getComm();
102}
103
104
105template<class MatrixType>
106Teuchos::RCP<const Tpetra::Map<typename MatrixType::local_ordinal_type,
107 typename MatrixType::global_ordinal_type,
108 typename MatrixType::node_type> >
110{
111 return A_->getRowMap();
112}
113
114template<class MatrixType>
115Teuchos::RCP<const Tpetra::Map<typename MatrixType::local_ordinal_type,
116 typename MatrixType::global_ordinal_type,
117 typename MatrixType::node_type> >
119{
120 return A_->getColMap();
121}
122
123template<class MatrixType>
124Teuchos::RCP<const Tpetra::Map<typename MatrixType::local_ordinal_type,
125 typename MatrixType::global_ordinal_type,
126 typename MatrixType::node_type> >
128{
129 return A_->getDomainMap();
130}
131
132template<class MatrixType>
133Teuchos::RCP<const Tpetra::Map<typename MatrixType::local_ordinal_type,
134 typename MatrixType::global_ordinal_type,
135 typename MatrixType::node_type> >
137{
138 return A_->getRangeMap();
139}
140
141template<class MatrixType>
142Teuchos::RCP<const Tpetra::RowGraph<typename MatrixType::local_ordinal_type,
143 typename MatrixType::global_ordinal_type,
144 typename MatrixType::node_type> >
146{
147 return A_->getGraph();
148}
149
150template<class MatrixType>
152{
153 return A_->getGlobalNumRows();
154}
155
156template<class MatrixType>
158{
159 return A_->getGlobalNumCols();
160}
161
162template<class MatrixType>
164{
165 return A_->getLocalNumRows();
166}
167
168template<class MatrixType>
170{
171 return A_->getLocalNumCols();
172}
173
174template<class MatrixType>
175typename MatrixType::global_ordinal_type DiagonalFilter<MatrixType>::getIndexBase() const
176{
177 return A_->getIndexBase();
178}
179
180template<class MatrixType>
182{
183 return A_->getGlobalNumEntries();
184}
185
186template<class MatrixType>
188{
189 return A_->getLocalNumEntries();
190}
191
192template<class MatrixType>
193size_t DiagonalFilter<MatrixType>::getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const
194{
195 return A_->getNumEntriesInGlobalRow(globalRow);
196}
197
198template<class MatrixType>
200{
201 return A_->getNumEntriesInLocalRow(localRow);
202}
203
204template<class MatrixType>
206{
207 return A_->getGlobalMaxNumRowEntries();
208}
209
210template<class MatrixType>
212{
213 return A_->getLocalMaxNumRowEntries();
214}
215
216template<class MatrixType>
218{
219 return A_->hasColMap();
220}
221
222template<class MatrixType>
224{
225 return A_->isLocallyIndexed();
226}
227
228template<class MatrixType>
230{
231 return A_->isGloballyIndexed();
232}
233
234template<class MatrixType>
236{
237 return A_->isFillComplete();
238}
239
240template<class MatrixType>
242 getGlobalRowCopy (GlobalOrdinal GlobalRow,
243 nonconst_global_inds_host_view_type &Indices,
244 nonconst_values_host_view_type &Values,
245 size_t& NumEntries) const
246
247{
248 Teuchos::ArrayRCP< const Scalar > myvals=val_->get1dView();
249 LocalOrdinal LocalRow=getRowMap()->getLocalElement(GlobalRow);
250
251 A_->getGlobalRowCopy(GlobalRow, Indices,Values,NumEntries);
252
253 if (pos_[LocalRow] != -1)
254 Values[pos_[LocalRow]] += myvals[LocalRow];
255}
256
257
258template<class MatrixType>
260 getLocalRowCopy (LocalOrdinal LocalRow,
261 nonconst_local_inds_host_view_type &Indices,
262 nonconst_values_host_view_type &Values,
263 size_t& NumEntries) const
264{
265 Teuchos::ArrayRCP< const Scalar > myvals=val_->get1dView();
266
267 A_->getLocalRowCopy(LocalRow, Indices,Values,NumEntries);
268
269 if (pos_[LocalRow] != -1)
270 Values[pos_[LocalRow]] += myvals[LocalRow];
271}
272
273
274template<class MatrixType>
275void DiagonalFilter<MatrixType>::getGlobalRowView(GlobalOrdinal /* GlobalRow */,
276 global_inds_host_view_type &/*indices*/,
277 values_host_view_type &/*values*/) const
278{
279 throw std::runtime_error("Ifpack2::DiagonalFilter: does not support getGlobalRowView.");
280}
281
282
283template<class MatrixType>
284void DiagonalFilter<MatrixType>::getLocalRowView(LocalOrdinal /* LocalRow */,
285 local_inds_host_view_type & /*indices*/,
286 values_host_view_type & /*values*/) const
287{
288 throw std::runtime_error("Ifpack2::DiagonalFilter: does not support getLocalRowView.");
289}
290
291
292template<class MatrixType>
293void DiagonalFilter<MatrixType>::getLocalDiagCopy(Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &diag) const
294{
295 // Returns the matrix's actual diagonal, rather than the "filtered" diagonal.
296 // This is dubious, but it duplicates the functionality of Old Ifpack.
297 return A_->getLocalDiagCopy(diag);
298}
299
300template<class MatrixType>
301void DiagonalFilter<MatrixType>::leftScale(const Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& /* x */)
302{
303 throw std::runtime_error("Ifpack2::DiagonalFilter does not support leftScale.");
304}
305
306template<class MatrixType>
307void DiagonalFilter<MatrixType>::rightScale(const Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& /* x */)
308{
309 throw std::runtime_error("Ifpack2::DiagonalFilter does not support rightScale.");
310}
311
312template<class MatrixType>
314apply (const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &X,
315 Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y,
316 Teuchos::ETransp mode,
317 Scalar alpha,
318 Scalar beta) const
319{
320 // FIXME (mfh 27 Jul 2015) If this is a "diagonal filter," why do we
321 // need to apply the whole matrix???
322
323 Scalar one = Teuchos::ScalarTraits<Scalar>::one();
324 A_->apply(X,Y,mode,alpha,beta);
325 Y.elementWiseMultiply(one,*val_,X,one);
326}
327
328template<class MatrixType>
330{
331 return A_->hasTransposeApply();
332}
333
334template<class MatrixType>
336{
337 return false;
338}
339
340template<class MatrixType>
341typename DiagonalFilter<MatrixType>::mag_type DiagonalFilter<MatrixType>::getFrobeniusNorm() const
342{
343 throw std::runtime_error("Ifpack2::DiagonalFilter does not implement getFrobeniusNorm.");
344}
345
346} // namespace Ifpack2
347
348#define IFPACK2_DIAGONALFILTER_INSTANT(S,LO,GO,N) \
349 template class Ifpack2::DiagonalFilter< Tpetra::RowMatrix<S, LO, GO, N> >;
350
351#endif
virtual global_size_t getGlobalNumRows() const
Returns the number of global rows in this matrix.
Definition Ifpack2_DiagonalFilter_def.hpp:151
virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const
Returns the current number of entries on this node in the specified global row.
Definition Ifpack2_DiagonalFilter_def.hpp:193
virtual size_t getLocalNumEntries() const
Returns the local number of entries in this matrix.
Definition Ifpack2_DiagonalFilter_def.hpp:187
virtual ~DiagonalFilter()
Destructor.
Definition Ifpack2_DiagonalFilter_def.hpp:96
virtual size_t getGlobalMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on all nodes.
Definition Ifpack2_DiagonalFilter_def.hpp:205
virtual void apply(const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=Teuchos::ScalarTraits< Scalar >::one(), Scalar beta=Teuchos::ScalarTraits< Scalar >::zero()) const
Computes the operator-multivector application.
Definition Ifpack2_DiagonalFilter_def.hpp:314
virtual Teuchos::RCP< const Teuchos::Comm< int > > getComm() const
Returns the communicator.
Definition Ifpack2_DiagonalFilter_def.hpp:99
virtual size_t getLocalNumRows() const
Returns the number of rows owned on the calling node.
Definition Ifpack2_DiagonalFilter_def.hpp:163
virtual global_size_t getGlobalNumCols() const
Returns the number of global columns in this matrix.
Definition Ifpack2_DiagonalFilter_def.hpp:157
DiagonalFilter(const Teuchos::RCP< const Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &Matrix, magnitudeType AbsoluteThreshold, magnitudeType RelativeThreshold)
Constructor.
Definition Ifpack2_DiagonalFilter_def.hpp:58
virtual void getLocalDiagCopy(Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &diag) const
Get a copy of the diagonal entries owned by this node, with local row indices.
Definition Ifpack2_DiagonalFilter_def.hpp:293
virtual bool hasColMap() const
Indicates whether this matrix has a well-defined column map.
Definition Ifpack2_DiagonalFilter_def.hpp:217
virtual mag_type getFrobeniusNorm() const
Returns the Frobenius norm of the matrix.
Definition Ifpack2_DiagonalFilter_def.hpp:341
virtual void getLocalRowView(LocalOrdinal 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_DiagonalFilter_def.hpp:284
virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getColMap() const
Returns the Map that describes the column distribution in this matrix.
Definition Ifpack2_DiagonalFilter_def.hpp:118
virtual GlobalOrdinal getIndexBase() const
Returns the index base for global indices for this matrix.
Definition Ifpack2_DiagonalFilter_def.hpp:175
virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getRangeMap() const
Returns the Map that describes the range distribution in this matrix.
Definition Ifpack2_DiagonalFilter_def.hpp:136
virtual void leftScale(const Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)
Scales the RowMatrix on the left with the Vector x.
Definition Ifpack2_DiagonalFilter_def.hpp:301
virtual global_size_t getGlobalNumEntries() const
Returns the global number of entries in this matrix.
Definition Ifpack2_DiagonalFilter_def.hpp:181
virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const
Returns the current number of entries on this node in the specified local row.
Definition Ifpack2_DiagonalFilter_def.hpp:199
virtual size_t getLocalMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on this node.
Definition Ifpack2_DiagonalFilter_def.hpp:211
virtual bool isLocallyIndexed() const
If matrix indices are in the local range, this function returns true. Otherwise, this function return...
Definition Ifpack2_DiagonalFilter_def.hpp:223
virtual void getGlobalRowCopy(GlobalOrdinal 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_DiagonalFilter_def.hpp:242
virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getRowMap() const
Returns the Map that describes the row distribution in this matrix.
Definition Ifpack2_DiagonalFilter_def.hpp:109
virtual bool isFillComplete() const
Returns true if fillComplete() has been called.
Definition Ifpack2_DiagonalFilter_def.hpp:235
virtual Teuchos::RCP< const Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node > > getGraph() const
Returns the RowGraph associated with this matrix.
Definition Ifpack2_DiagonalFilter_def.hpp:145
virtual size_t getLocalNumCols() const
Returns the number of columns needed to apply the forward operator on this node, i....
Definition Ifpack2_DiagonalFilter_def.hpp:169
virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getDomainMap() const
Returns the Map that describes the domain distribution in this matrix.
Definition Ifpack2_DiagonalFilter_def.hpp:127
virtual void getGlobalRowView(GlobalOrdinal 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_DiagonalFilter_def.hpp:275
virtual void rightScale(const Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)
Scales the RowMatrix on the right with the Vector x.
Definition Ifpack2_DiagonalFilter_def.hpp:307
virtual bool hasTransposeApply() const
Indicates whether this operator supports applying the adjoint operator.
Definition Ifpack2_DiagonalFilter_def.hpp:329
virtual bool supportsRowViews() const
Returns true if RowViews are supported.
Definition Ifpack2_DiagonalFilter_def.hpp:335
virtual bool isGloballyIndexed() const
If matrix indices are in the global range, this function returns true. Otherwise, this function retur...
Definition Ifpack2_DiagonalFilter_def.hpp:229
virtual void getLocalRowCopy(LocalOrdinal 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_DiagonalFilter_def.hpp:260
Preconditioners and smoothers for Tpetra sparse matrices.
Definition Ifpack2_AdditiveSchwarz_decl.hpp:74