Ifpack2 Templated Preconditioning Package  Version 1.0
Ifpack2_DropFilter_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_DROPFILTER_DEF_HPP
44 #define IFPACK2_DROPFILTER_DEF_HPP
45 #include "Ifpack2_DropFilter_decl.hpp"
46 #include <vector>
47 
48 #include "Tpetra_ConfigDefs.hpp"
49 #include "Tpetra_RowMatrix.hpp"
50 #include "Tpetra_Map.hpp"
51 #include "Tpetra_MultiVector.hpp"
52 #include "Tpetra_Vector.hpp"
53 
54 namespace Ifpack2 {
55 
56 //==========================================================================
57 template<class MatrixType>
58 DropFilter<MatrixType>::DropFilter(const Teuchos::RCP<const Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> >& Matrix,
59  magnitudeType DropTol):
60  A_(Matrix),
61  DropTol_(DropTol),
62  NumRows_(0),
63  NumNonzeros_(0),
64  MaxNumEntries_(0),
65  MaxNumEntriesA_(0)
66 {
67 
68  // use this filter only on serial matrices
69  if (A_->getComm()->getSize() != 1 || A_->getNodeNumRows() != A_->getGlobalNumRows()) {
70  throw std::runtime_error("Ifpack2::DropFilter can be used with Comm().getSize() == 1 only. This class is a tool for Ifpack2_AdditiveSchwarz, and it is not meant to be used otherwise.");
71  }
72 
73 
74  // localized matrix has all the local rows of Matrix
75  NumRows_ = A_->getNodeNumRows();
76 
77  // NodeNumEntries_ will contain the actual number of nonzeros
78  // for each localized row (that is, without external nodes,
79  // and always with the diagonal entry)
80  NumEntries_.resize(NumRows_);
81 
82  // tentative value for MaxNumEntries. This is the number of
83  // nonzeros in the local matrix
84  MaxNumEntries_ = A_->getNodeMaxNumRowEntries();
85  MaxNumEntriesA_ = A_->getNodeMaxNumRowEntries();
86 
87  // ExtractMyRowCopy() will use these vectors
88  Indices_.resize(MaxNumEntries_);
89  Values_.resize(MaxNumEntries_);
90 
91  size_t ActualMaxNumEntries = 0;
92  for (size_t i = 0 ; i < NumRows_ ; ++i) {
93  NumEntries_[i] = MaxNumEntriesA_;
94  size_t Nnz, NewNnz=0;
95  A_->getLocalRowCopy(i,Indices_,Values_,Nnz);
96  for (size_t j = 0 ; j < Nnz ; ++j) {
97  if (((size_t)Indices_[j] == i) || (Teuchos::ScalarTraits<Scalar>::magnitude(Values_[j]) >= DropTol_))
98  NewNnz++;
99  }
100 
101  NumNonzeros_ += NewNnz;
102  NumEntries_[i] = NewNnz;
103  if (NewNnz > ActualMaxNumEntries)
104  ActualMaxNumEntries = NewNnz;
105  }
106 
107  MaxNumEntries_ = ActualMaxNumEntries;
108 }
109 
110 //=========================================================================
111 template<class MatrixType>
113 
114 //==========================================================================
115 template<class MatrixType>
118 {
119  return A_->getComm ();
120 }
121 
122 //==========================================================================
123 template<class MatrixType>
126 {
127  return A_->getNode ();
128 }
129 
130 //==========================================================================
131 template<class MatrixType>
132 Teuchos::RCP<const Tpetra::Map<typename MatrixType::local_ordinal_type,
133  typename MatrixType::global_ordinal_type,
134  typename MatrixType::node_type> >
136 {
137  return A_->getRowMap();
138 }
139 
140 //==========================================================================
141 template<class MatrixType>
142 Teuchos::RCP<const Tpetra::Map<typename MatrixType::local_ordinal_type,
143  typename MatrixType::global_ordinal_type,
144  typename MatrixType::node_type> >
146 {
147  return A_->getColMap();
148 }
149 
150 //==========================================================================
151 template<class MatrixType>
152 Teuchos::RCP<const Tpetra::Map<typename MatrixType::local_ordinal_type,
153  typename MatrixType::global_ordinal_type,
154  typename MatrixType::node_type> >
156 {
157  return A_->getDomainMap();
158 }
159 
160 //==========================================================================
161 template<class MatrixType>
162 Teuchos::RCP<const Tpetra::Map<typename MatrixType::local_ordinal_type,
163  typename MatrixType::global_ordinal_type,
164  typename MatrixType::node_type> >
166 {
167  return A_->getRangeMap();
168 }
169 
170 //==========================================================================
171 template<class MatrixType>
172 Teuchos::RCP<const Tpetra::RowGraph<typename MatrixType::local_ordinal_type,
173  typename MatrixType::global_ordinal_type,
174  typename MatrixType::node_type> >
176 {
177  throw std::runtime_error("Ifpack2::DropFilter: does not support getGraph.");
178 }
179 
180 //==========================================================================
181 template<class MatrixType>
183 {
184  return NumRows_;
185 }
186 
187 //==========================================================================
188 template<class MatrixType>
190 {
191  return NumRows_;
192 }
193 
194 //==========================================================================
195 template<class MatrixType>
197 {
198  return NumRows_;
199 }
200 
201 //==========================================================================
202 
203 template<class MatrixType>
205 {
206  return NumRows_;
207 }
208 
209 //==========================================================================
210 template<class MatrixType>
211 typename MatrixType::global_ordinal_type DropFilter<MatrixType>::getIndexBase() const
212 {
213  return A_->getIndexBase();
214 }
215 
216 //==========================================================================
217 template<class MatrixType>
219 {
220  return NumNonzeros_;
221 }
222 
223 //==========================================================================
224 template<class MatrixType>
226 {
227  return NumNonzeros_;
228 }
229 
230 //==========================================================================
231 template<class MatrixType>
232 size_t DropFilter<MatrixType>::getNumEntriesInGlobalRow(GlobalOrdinal /* globalRow */) const
233 {
234  throw std::runtime_error("Ifpack2::DropFilter does not implement getNumEntriesInGlobalRow.");
235 }
236 
237 //==========================================================================
238 template<class MatrixType>
239 size_t DropFilter<MatrixType>::getNumEntriesInLocalRow(LocalOrdinal localRow) const
240 {
241  return NumEntries_[localRow];
242 }
243 
244 //==========================================================================
245 template<class MatrixType>
247 {
248  return MaxNumEntries_;
249 }
250 
251 //==========================================================================
252 template<class MatrixType>
254 {
255  return MaxNumEntries_;
256 }
257 
258 //==========================================================================
259 template<class MatrixType>
261 {
262  return true;
263 }
264 
265 //==========================================================================
266 template<class MatrixType>
268 {
269  return A_->isLocallyIndexed();
270 }
271 
272 //==========================================================================
273 template<class MatrixType>
275 {
276  return A_->isGloballyIndexed();
277 }
278 
279 //==========================================================================
280 template<class MatrixType>
282 {
283  return A_->isFillComplete();
284 }
285 
286 //==========================================================================
287 template<class MatrixType>
288 void DropFilter<MatrixType>::getGlobalRowCopy(GlobalOrdinal /* GlobalRow */,
289  const Teuchos::ArrayView<GlobalOrdinal> &/* Indices */,
290  const Teuchos::ArrayView<Scalar> &/* Values */,
291  size_t &/* NumEntries */) const
292 {
293  throw std::runtime_error("Ifpack2::DropFilter does not implement getGlobalRowCopy.");
294 }
295 
296 //==========================================================================
297 template<class MatrixType>
298 void DropFilter<MatrixType>::getLocalRowCopy(LocalOrdinal LocalRow,
299  const Teuchos::ArrayView<LocalOrdinal> &Indices,
300  const Teuchos::ArrayView<Scalar> &Values,
301  size_t &NumEntries) const
302 {
303  TEUCHOS_TEST_FOR_EXCEPTION((LocalRow < 0 || (size_t) LocalRow >= NumRows_ || (size_t) Indices.size() < NumEntries_[LocalRow]), std::runtime_error, "Ifpack2::DropFilter::getLocalRowCopy invalid row or array size.");
304 
305  // Note: This function will work correctly if called by apply, say, with Indices_ and Values_ as
306  // parameters. The structure of the loop below should make that obvious.
307 
308  // always extract using the object Values_ and Indices_.
309  // This is because I need more space than that given by
310  // the user (for the external nodes)
311  size_t A_NumEntries=0;
312  A_->getLocalRowCopy(LocalRow,Indices_(),Values_(),A_NumEntries);
313 
314  // loop over all nonzero elements of row MyRow,
315  // and drop elements below specified threshold.
316  // Also, add value to zero diagonal
317  NumEntries = 0;
318  for (size_t i = 0 ; i < A_NumEntries ; ++i) {
319  // if element is above specified tol, add to the
320  // user's defined arrays. Check that we are not
321  // exceeding allocated space. Do not drop any diagonal entry.
322  if ((Indices_[i] == LocalRow) || (Teuchos::ScalarTraits<Scalar>::magnitude(Values_[i]) >= DropTol_)) {
323  Values[NumEntries] = Values_[i];
324  Indices[NumEntries] = Indices_[i];
325  NumEntries++;
326  }
327  }
328 }
329 
330 //==========================================================================
331 template<class MatrixType>
332 void DropFilter<MatrixType>::getGlobalRowView(GlobalOrdinal /* GlobalRow */,
334  Teuchos::ArrayView<const Scalar> &/* values */) const
335 {
336  throw std::runtime_error("Ifpack2::DropFilter: does not support getGlobalRowView.");
337 }
338 
339 //==========================================================================
340 template<class MatrixType>
341 void DropFilter<MatrixType>::getLocalRowView(LocalOrdinal /* LocalRow */,
343  Teuchos::ArrayView<const Scalar> &/* values */) const
344 {
345  throw std::runtime_error("Ifpack2::DropFilter: does not support getLocalRowView.");
346 }
347 
348 //==========================================================================
349 template<class MatrixType>
350 void DropFilter<MatrixType>::getLocalDiagCopy(Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &diag) const
351 {
352  // This is somewhat dubious as to how the maps match.
353  return A_->getLocalDiagCopy(diag);
354 }
355 
356 //==========================================================================
357 template<class MatrixType>
358 void DropFilter<MatrixType>::leftScale(const Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& /* x */)
359 {
360  throw std::runtime_error("Ifpack2::DropFilter does not support leftScale.");
361 }
362 
363 //==========================================================================
364 template<class MatrixType>
365 void DropFilter<MatrixType>::rightScale(const Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& /* x */)
366 {
367  throw std::runtime_error("Ifpack2::DropFilter does not support rightScale.");
368 }
369 
370 //==========================================================================
371 template<class MatrixType>
372 void DropFilter<MatrixType>::apply(const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &X,
373  Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y,
374  Teuchos::ETransp mode,
375  Scalar /* alpha */,
376  Scalar /* beta */) const
377 {
378  // Note: This isn't AztecOO compliant. But neither was Ifpack's version.
379  // Note: The localized maps mean the matvec is trivial (and has no import)
380  TEUCHOS_TEST_FOR_EXCEPTION(X.getNumVectors() != Y.getNumVectors(), std::runtime_error,
381  "Ifpack2::DropFilter::apply ERROR: X.getNumVectors() != Y.getNumVectors().");
382 
385  Teuchos::ArrayRCP<Teuchos::ArrayRCP<Scalar> > y_ptr = Y.get2dViewNonConst();
386 
387  Y.putScalar(zero);
388  size_t NumVectors = Y.getNumVectors();
389 
390  for (size_t i = 0 ; i < NumRows_ ; ++i) {
391  size_t Nnz;
392  // Use this class's getrow to make the below code simpler
393  getLocalRowCopy(i,Indices_(),Values_(),Nnz);
394  if (mode==Teuchos::NO_TRANS){
395  for (size_t j = 0 ; j < Nnz ; ++j)
396  for (size_t k = 0 ; k < NumVectors ; ++k)
397  y_ptr[k][i] += Values_[j] * x_ptr[k][Indices_[j]];
398  }
399  else if (mode==Teuchos::TRANS){
400  for (size_t j = 0 ; j < Nnz ; ++j)
401  for (size_t k = 0 ; k < NumVectors ; ++k)
402  y_ptr[k][Indices_[j]] += Values_[j] * x_ptr[k][i];
403  }
404  else { //mode==Teuchos::CONJ_TRANS
405  for (size_t j = 0 ; j < Nnz ; ++j)
406  for (size_t k = 0 ; k < NumVectors ; ++k)
407  y_ptr[k][Indices_[j]] += Teuchos::ScalarTraits<Scalar>::conjugate(Values_[j]) * x_ptr[k][i];
408  }
409  }
410 }
411 
412 
413 //==========================================================================
414 template<class MatrixType>
416 {
417  return true;
418 }
419 
420 //==========================================================================
421 template<class MatrixType>
423 {
424  return false;
425 }
426 
427 //==========================================================================
428 template<class MatrixType>
429 typename DropFilter<MatrixType>::mag_type DropFilter<MatrixType>::getFrobeniusNorm() const
430 {
431  throw std::runtime_error("Ifpack2::DropFilter does not implement getFrobeniusNorm.");
432 }
433 
434 
435 #define IFPACK2_DROPFILTER_INSTANT(S,LO,GO,N) \
436  template class Ifpack2::DropFilter< Tpetra::RowMatrix<S, LO, GO, N> >;
437 
438 
439 } // namespace Ifpack2
440 
441 #endif
virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getRangeMap() const
Returns the Map that describes the range distribution in this matrix.
Definition: Ifpack2_DropFilter_def.hpp:165
virtual void getLocalRowCopy(LocalOrdinal DropRow, const Teuchos::ArrayView< LocalOrdinal > &Indices, const Teuchos::ArrayView< Scalar > &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_DropFilter_def.hpp:298
virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const
Returns the current number of entries on this node in the specified local row.
Definition: Ifpack2_DropFilter_def.hpp:239
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
virtual bool hasTransposeApply() const
Indicates whether this operator supports applying the adjoint operator.
Definition: Ifpack2_DropFilter_def.hpp:415
virtual void getGlobalRowView(GlobalOrdinal GlobalRow, Teuchos::ArrayView< const GlobalOrdinal > &indices, Teuchos::ArrayView< const Scalar > &values) const
Extract a const, non-persisting view of global indices in a specified row of the matrix.
Definition: Ifpack2_DropFilter_def.hpp:332
size_type size() const
virtual size_t getNodeNumCols() const
Returns the number of columns needed to apply the forward operator on this node, i.e., the number of elements listed in the column map.
Definition: Ifpack2_DropFilter_def.hpp:204
DropFilter(const Teuchos::RCP< const Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &Matrix, magnitudeType DropTol)
Constructor.
Definition: Ifpack2_DropFilter_def.hpp:58
virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const
Returns the current number of entries on this node in the specified global row.
Definition: Ifpack2_DropFilter_def.hpp:232
virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getDomainMap() const
Returns the Map that describes the domain distribution in this matrix.
Definition: Ifpack2_DropFilter_def.hpp:155
virtual void getGlobalRowCopy(GlobalOrdinal GlobalRow, const Teuchos::ArrayView< GlobalOrdinal > &Indices, const Teuchos::ArrayView< Scalar > &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_DropFilter_def.hpp:288
virtual void leftScale(const Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)
Scales the RowMatrix on the left with the Vector x.
Definition: Ifpack2_DropFilter_def.hpp:358
virtual bool isLocallyIndexed() const
If matrix indices are in the local range, this function returns true. Otherwise, this function return...
Definition: Ifpack2_DropFilter_def.hpp:267
virtual bool isFillComplete() const
Returns true if fillComplete() has been called.
Definition: Ifpack2_DropFilter_def.hpp:281
virtual global_size_t getGlobalNumRows() const
Returns the number of global rows in this matrix.
Definition: Ifpack2_DropFilter_def.hpp:182
virtual void rightScale(const Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)
Scales the RowMatrix on the right with the Vector x.
Definition: Ifpack2_DropFilter_def.hpp:365
virtual size_t getNodeNumEntries() const
Returns the local number of entries in this matrix.
Definition: Ifpack2_DropFilter_def.hpp:225
LinearOp zero(const VectorSpace &vs)
virtual size_t getNodeNumRows() const
Returns the number of rows owned on the calling node.
Definition: Ifpack2_DropFilter_def.hpp:196
void resize(size_type new_size, const value_type &x=value_type())
virtual global_size_t getGlobalNumEntries() const
Returns the global number of entries in this matrix.
Definition: Ifpack2_DropFilter_def.hpp:218
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_DropFilter_def.hpp:372
virtual Teuchos::RCP< const Teuchos::Comm< int > > getComm() const
Returns the communicator.
Definition: Ifpack2_DropFilter_def.hpp:117
virtual bool hasColMap() const
Indicates whether this matrix has a well-defined column map.
Definition: Ifpack2_DropFilter_def.hpp:260
virtual bool supportsRowViews() const
Returns true if RowViews are supported.
Definition: Ifpack2_DropFilter_def.hpp:422
virtual global_size_t getGlobalNumCols() const
Returns the number of global columns in this matrix.
Definition: Ifpack2_DropFilter_def.hpp:189
virtual size_t getGlobalMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on all nodes.
Definition: Ifpack2_DropFilter_def.hpp:246
virtual Teuchos::RCP< Node > getNode() const
Returns the underlying node.
Definition: Ifpack2_DropFilter_def.hpp:125
virtual size_t getNodeMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on this node.
Definition: Ifpack2_DropFilter_def.hpp:253
virtual bool isGloballyIndexed() const
If matrix indices are in the global range, this function returns true. Otherwise, this function retur...
Definition: Ifpack2_DropFilter_def.hpp:274
virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getColMap() const
Returns the Map that describes the column distribution in this matrix.
Definition: Ifpack2_DropFilter_def.hpp:145
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_DropFilter_def.hpp:350
virtual mag_type getFrobeniusNorm() const
Returns the Frobenius norm of the matrix.
Definition: Ifpack2_DropFilter_def.hpp:429
virtual Teuchos::RCP< const Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node > > getGraph() const
Returns the RowGraph associated with this matrix.
Definition: Ifpack2_DropFilter_def.hpp:175
virtual void getLocalRowView(LocalOrdinal DropRow, Teuchos::ArrayView< const LocalOrdinal > &indices, Teuchos::ArrayView< const Scalar > &values) const
Extract a const, non-persisting view of local indices in a specified row of the matrix.
Definition: Ifpack2_DropFilter_def.hpp:341
virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getRowMap() const
Returns the Map that describes the row distribution in this matrix.
Definition: Ifpack2_DropFilter_def.hpp:135
virtual GlobalOrdinal getIndexBase() const
Returns the index base for global indices for this matrix.
Definition: Ifpack2_DropFilter_def.hpp:211
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:72
virtual ~DropFilter()
Destructor.
Definition: Ifpack2_DropFilter_def.hpp:112