Ifpack2 Templated Preconditioning Package  Version 1.0
Ifpack2_SingletonFilter_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_SINGLETONFILTER_DEF_HPP
44 #define IFPACK2_SINGLETONFILTER_DEF_HPP
45 #include "Ifpack2_SingletonFilter_decl.hpp"
46 
47 #include "Tpetra_ConfigDefs.hpp"
48 #include "Tpetra_RowMatrix.hpp"
49 #include "Tpetra_Map.hpp"
50 #include "Tpetra_MultiVector.hpp"
51 #include "Tpetra_Vector.hpp"
52 
53 namespace Ifpack2 {
54 
55 template<class MatrixType>
56 SingletonFilter<MatrixType>::SingletonFilter(const Teuchos::RCP<const Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> >& Matrix):
57  A_(Matrix),
58  NumSingletons_(0),
59  NumRows_(0),
60  NumNonzeros_(0),
61  MaxNumEntries_(0),
62  MaxNumEntriesA_(0)
63 {
64 
65  // use this filter only on serial matrices
66  if (A_->getComm()->getSize() != 1 || A_->getNodeNumRows() != A_->getGlobalNumRows()) {
67  throw std::runtime_error("Ifpack2::SingeltonFilter 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.");
68  }
69 
70  // Number of rows in A
71  size_t NumRowsA_ = A_->getNodeNumRows();
72 
73  // tentative value for MaxNumEntries. This is the number of
74  // nonzeros in the local matrix
75  MaxNumEntriesA_ = A_->getNodeMaxNumRowEntries();
76 
77  // ExtractMyRowCopy() will use these vectors
78  Kokkos::resize(Indices_,MaxNumEntriesA_);
79  Kokkos::resize(Values_,MaxNumEntriesA_);
80 
81  // Initialize reordering vector to -1
82  Reorder_.resize(NumRowsA_);
83  Reorder_.assign(Reorder_.size(),-1);
84 
85  // first check how may singletons I do have
86  NumRows_=0;
87  for (size_t i = 0 ; i < NumRowsA_ ; ++i) {
88  size_t Nnz;
89  A_->getLocalRowCopy(i,Indices_,Values_,Nnz);
90  if (Nnz != 1) {
91  Reorder_[i] = NumRows_++;
92  }
93  else {
94  NumSingletons_++;
95  }
96  }
97 
98  // build the inverse reordering
99  InvReorder_.resize(NumRows_);
100  for (size_t i = 0 ; i < NumRowsA_ ; ++i) {
101  if (Reorder_[i] < 0)
102  continue;
103  InvReorder_[Reorder_[i]] = i;
104  }
105  NumEntries_.resize(NumRows_);
106  SingletonIndex_.resize(NumSingletons_);
107 
108 
109  // now compute the nonzeros per row
110  size_t count = 0;
111  for (size_t i = 0 ; i < NumRowsA_ ; ++i) {
112  size_t Nnz;
113  A_->getLocalRowCopy(i,Indices_,Values_,Nnz);
114  LocalOrdinal ii = Reorder_[i];
115  if (ii >= 0) {
116  NumEntries_[ii] = Nnz;
117  NumNonzeros_ += Nnz;
118  if (Nnz > MaxNumEntries_)
119  MaxNumEntries_ = Nnz;
120  }
121  else {
122  SingletonIndex_[count] = i;
123  count++;
124  }
125  }
126 
127  // Build the reduced map. This map should be serial
128  ReducedMap_ = Teuchos::rcp( new Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node>(NumRows_,0,A_->getComm()) );
129 
130  // and finish up with the diagonal entry
131  Diagonal_ = Teuchos::rcp( new Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node>(ReducedMap_) );
132 
133  Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> DiagonalA(A_->getRowMap());
134  A_->getLocalDiagCopy(DiagonalA);
135  const Teuchos::ArrayRCP<const Scalar> & DiagonalAview = DiagonalA.get1dView();
136  for (size_t i = 0 ; i < NumRows_ ; ++i) {
137  LocalOrdinal ii = InvReorder_[i];
138  Diagonal_->replaceLocalValue((LocalOrdinal)i,DiagonalAview[ii]);
139  }
140 }
141 
142 template<class MatrixType>
144 
145 template<class MatrixType>
146 Teuchos::RCP<const Teuchos::Comm<int> >
148 {
149  return A_->getComm();
150 }
151 
152 
153 template<class MatrixType>
154 Teuchos::RCP<const Tpetra::Map<typename MatrixType::local_ordinal_type,
155  typename MatrixType::global_ordinal_type,
156  typename MatrixType::node_type> >
158 {
159  return ReducedMap_;
160 }
161 
162 template<class MatrixType>
163 Teuchos::RCP<const Tpetra::Map<typename MatrixType::local_ordinal_type,
164  typename MatrixType::global_ordinal_type,
165  typename MatrixType::node_type> >
167 {
168  return ReducedMap_;
169 }
170 
171 template<class MatrixType>
172 Teuchos::RCP<const Tpetra::Map<typename MatrixType::local_ordinal_type,
173  typename MatrixType::global_ordinal_type,
174  typename MatrixType::node_type> >
176 {
177  return ReducedMap_;
178 }
179 
180 template<class MatrixType>
181 Teuchos::RCP<const Tpetra::Map<typename MatrixType::local_ordinal_type,
182  typename MatrixType::global_ordinal_type,
183  typename MatrixType::node_type> >
185 {
186  return ReducedMap_;
187 }
188 
189 template<class MatrixType>
190 Teuchos::RCP<const Tpetra::RowGraph<typename MatrixType::local_ordinal_type,
191  typename MatrixType::global_ordinal_type,
192  typename MatrixType::node_type> >
194 {
195  throw std::runtime_error("Ifpack2::SingletonFilter: does not support getGraph.");
196 }
197 
198 template<class MatrixType>
200 {
201  return NumRows_;
202 }
203 
204 template<class MatrixType>
206 {
207  return NumRows_;
208 }
209 
210 template<class MatrixType>
212 {
213  return NumRows_;
214 }
215 
216 template<class MatrixType>
218 {
219  return NumRows_;
220 }
221 
222 template<class MatrixType>
223 typename MatrixType::global_ordinal_type SingletonFilter<MatrixType>::getIndexBase() const
224 {
225  return A_->getIndexBase();
226 }
227 
228 template<class MatrixType>
230 {
231  return NumNonzeros_;
232 }
233 
234 template<class MatrixType>
236 {
237  return NumNonzeros_;
238 }
239 
240 template<class MatrixType>
241 size_t SingletonFilter<MatrixType>::getNumEntriesInGlobalRow(GlobalOrdinal /* globalRow */) const
242 {
243  throw std::runtime_error("Ifpack2::SingletonFilter does not implement getNumEntriesInGlobalRow.");
244 }
245 
246 template<class MatrixType>
247 size_t SingletonFilter<MatrixType>::getNumEntriesInLocalRow(LocalOrdinal localRow) const
248 {
249  return NumEntries_[localRow];
250 }
251 
252 template<class MatrixType>
254 {
255  return MaxNumEntries_;
256 }
257 
258 template<class MatrixType>
260 {
261  return MaxNumEntries_;
262 }
263 
264 template<class MatrixType>
266 {
267  return true;
268 }
269 
270 template<class MatrixType>
272 {
273  return A_->isLocallyIndexed();
274 }
275 
276 template<class MatrixType>
278 {
279  return A_->isGloballyIndexed();
280 }
281 
282 template<class MatrixType>
284 {
285  return A_->isFillComplete();
286 }
287 
288 template<class MatrixType>
290 getGlobalRowCopy (GlobalOrdinal /*LocalRow*/,
291  nonconst_global_inds_host_view_type &/*Indices*/,
292  nonconst_values_host_view_type &/*Values*/,
293  size_t& /*NumEntries*/) const
294 {
295  throw std::runtime_error("Ifpack2::SingletonFilter does not implement getGlobalRowCopy.");
296 }
297 
298 #ifdef TPETRA_ENABLE_DEPRECATED_CODE
299 template<class MatrixType>
300 void SingletonFilter<MatrixType>::getGlobalRowCopy(GlobalOrdinal /* GlobalRow */,
301  const Teuchos::ArrayView<GlobalOrdinal> &/* Indices */,
302  const Teuchos::ArrayView<Scalar> &/* Values */,
303  size_t &/* NumEntries */) const
304 {
305  throw std::runtime_error("Ifpack2::SingletonFilter does not implement getGlobalRowCopy.");
306 }
307 #endif
308 
309 template<class MatrixType>
311  getLocalRowCopy (LocalOrdinal LocalRow,
312  nonconst_local_inds_host_view_type &Indices,
313  nonconst_values_host_view_type &Values,
314  size_t& NumEntries) const
315 {
316  TEUCHOS_TEST_FOR_EXCEPTION((LocalRow < 0 || (size_t) LocalRow >= NumRows_ || (size_t) Indices.size() < NumEntries_[LocalRow]), std::runtime_error, "Ifpack2::SingletonFilter::getLocalRowCopy invalid row or array size.");
317 
318  size_t Nnz;
319  LocalOrdinal ARow = InvReorder_[LocalRow];
320  A_->getLocalRowCopy(ARow,Indices_,Values_,Nnz);
321 
322  // populate the user's vectors
323  NumEntries = 0;
324  for (size_t i = 0 ; i < Nnz ; ++i) {
325  LocalOrdinal ii = Reorder_[Indices_[i]];
326  if ( ii >= 0) {
327  Indices[NumEntries] = ii;
328  Values[NumEntries] = Values_[i];
329  NumEntries++;
330  }
331  }
332 }
333 
334 
335 #ifdef TPETRA_ENABLE_DEPRECATED_CODE
336 template<class MatrixType>
337 void SingletonFilter<MatrixType>::getLocalRowCopy(LocalOrdinal LocalRow,
338  const Teuchos::ArrayView<LocalOrdinal> &Indices,
339  const Teuchos::ArrayView<Scalar> &Values,
340  size_t &NumEntries) const
341 {
342  using IST = typename row_matrix_type::impl_scalar_type;
343  nonconst_local_inds_host_view_type ind_in(Indices.data(),Indices.size());
344  nonconst_values_host_view_type val_in(reinterpret_cast<IST*>(Values.data()),Values.size());
345  getLocalRowCopy(LocalRow,ind_in,val_in,NumEntries);
346 }
347 #endif
348 
349 template<class MatrixType>
350 void SingletonFilter<MatrixType>::getGlobalRowView(GlobalOrdinal /* GlobalRow */,
351  global_inds_host_view_type &/*indices*/,
352  values_host_view_type &/*values*/) const
353 {
354  throw std::runtime_error("Ifpack2::SingletonFilter: does not support getGlobalRowView.");
355 }
356 
357 #ifdef TPETRA_ENABLE_DEPRECATED_CODE
358 template<class MatrixType>
359 void SingletonFilter<MatrixType>::getGlobalRowView(GlobalOrdinal /* GlobalRow */,
360  Teuchos::ArrayView<const GlobalOrdinal> &/* indices */,
361  Teuchos::ArrayView<const Scalar> &/* values */) const
362 {
363  throw std::runtime_error("Ifpack2::SingletonFilter: does not support getGlobalRowView.");
364 }
365 #endif
366 
367 template<class MatrixType>
368 void SingletonFilter<MatrixType>::getLocalRowView(LocalOrdinal /* LocalRow */,
369  local_inds_host_view_type & /*indices*/,
370  values_host_view_type & /*values*/) const
371 {
372  throw std::runtime_error("Ifpack2::SingletonFilter: does not support getLocalRowView.");
373 }
374 
375 #ifdef TPETRA_ENABLE_DEPRECATED_CODE
376 template<class MatrixType>
377 void SingletonFilter<MatrixType>::getLocalRowView(LocalOrdinal /* LocalRow */,
378  Teuchos::ArrayView<const LocalOrdinal> &/* indices */,
379  Teuchos::ArrayView<const Scalar> &/* values */) const
380 {
381  throw std::runtime_error("Ifpack2::SingletonFilter: does not support getLocalRowView.");
382 }
383 #endif
384 
385 template<class MatrixType>
386 void SingletonFilter<MatrixType>::getLocalDiagCopy(Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &diag) const
387 {
388  // This is somewhat dubious as to how the maps match.
389  return A_->getLocalDiagCopy(diag);
390 }
391 
392 template<class MatrixType>
393 void SingletonFilter<MatrixType>::leftScale(const Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& /* x */)
394 {
395  throw std::runtime_error("Ifpack2::SingletonFilter does not support leftScale.");
396 }
397 
398 template<class MatrixType>
399 void SingletonFilter<MatrixType>::rightScale(const Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& /* x */)
400 {
401  throw std::runtime_error("Ifpack2::SingletonFilter does not support rightScale.");
402 }
403 
404 template<class MatrixType>
405 void SingletonFilter<MatrixType>::apply(const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &X,
406  Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y,
407  Teuchos::ETransp mode,
408  Scalar /* alpha */,
409  Scalar /* beta */) const
410 {
411  typedef Scalar DomainScalar;
412  typedef Scalar RangeScalar;
413 
414  // Note: This isn't AztecOO compliant. But neither was Ifpack's version.
415 
416  TEUCHOS_TEST_FOR_EXCEPTION(X.getNumVectors() != Y.getNumVectors(), std::runtime_error,
417  "Ifpack2::SingletonFilter::apply ERROR: X.getNumVectors() != Y.getNumVectors().");
418 
419  RangeScalar zero = Teuchos::ScalarTraits<RangeScalar>::zero();
420  Teuchos::ArrayRCP<Teuchos::ArrayRCP<const DomainScalar> > x_ptr = X.get2dView();
421  Teuchos::ArrayRCP<Teuchos::ArrayRCP<RangeScalar> > y_ptr = Y.get2dViewNonConst();
422 
423  Y.putScalar(zero);
424  size_t NumVectors = Y.getNumVectors();
425 
426 
427  for (size_t i = 0 ; i < NumRows_ ; ++i) {
428  size_t Nnz;
429  // Use this class's getrow to make the below code simpler
430  getLocalRowCopy(i,Indices_,Values_,Nnz);
431  if (mode==Teuchos::NO_TRANS){
432  for (size_t j = 0 ; j < Nnz ; ++j)
433  for (size_t k = 0 ; k < NumVectors ; ++k)
434  y_ptr[k][i] += (RangeScalar)Values_[j] * (RangeScalar)x_ptr[k][Indices_[j]];
435  }
436  else if (mode==Teuchos::TRANS){
437  for (size_t j = 0 ; j < Nnz ; ++j)
438  for (size_t k = 0 ; k < NumVectors ; ++k)
439  y_ptr[k][Indices_[j]] += (RangeScalar)Values_[j] * (RangeScalar)x_ptr[k][i];
440  }
441  else { //mode==Teuchos::CONJ_TRANS
442  for (size_t j = 0 ; j < Nnz ; ++j)
443  for (size_t k = 0 ; k < NumVectors ; ++k)
444  y_ptr[k][Indices_[j]] += Teuchos::ScalarTraits<RangeScalar>::conjugate((RangeScalar)Values_[j]) * (RangeScalar)x_ptr[k][i];
445  }
446  }
447 }
448 
449 template<class MatrixType>
451 {
452  return true;
453 }
454 
455 template<class MatrixType>
457 {
458  return false;
459 }
460 
461 template<class MatrixType>
462 void SingletonFilter<MatrixType>::SolveSingletons(const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& RHS,
463  Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& LHS)
464 {
465  this->template SolveSingletonsTempl<Scalar,Scalar>(RHS, LHS);
466 }
467 
468 template<class MatrixType>
469 template<class DomainScalar, class RangeScalar>
470 void SingletonFilter<MatrixType>::SolveSingletonsTempl(const Tpetra::MultiVector<DomainScalar,LocalOrdinal,GlobalOrdinal,Node>& RHS,
471  Tpetra::MultiVector<RangeScalar,LocalOrdinal,GlobalOrdinal,Node>& LHS)
472 {
473  Teuchos::ArrayRCP<Teuchos::ArrayRCP<const DomainScalar> > RHS_ptr = RHS.get2dView();
474  Teuchos::ArrayRCP<Teuchos::ArrayRCP<RangeScalar> > LHS_ptr = LHS.get2dViewNonConst();
475 
476  for (size_t i = 0 ; i < NumSingletons_ ; ++i) {
477  LocalOrdinal ii = SingletonIndex_[i];
478  // get the diagonal value for the singleton
479  size_t Nnz;
480  A_->getLocalRowCopy(ii,Indices_,Values_,Nnz);
481  for (size_t j = 0 ; j < Nnz ; ++j) {
482  if (Indices_[j] == ii) {
483  for (size_t k = 0 ; k < LHS.getNumVectors() ; ++k)
484  LHS_ptr[k][ii] = (RangeScalar)RHS_ptr[k][ii] / (RangeScalar)Values_[j];
485  }
486  }
487  }
488 }
489 
490 template<class MatrixType>
491 void SingletonFilter<MatrixType>::CreateReducedRHS(const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& LHS,
492  const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& RHS,
493  Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& ReducedRHS)
494 {
495  this->template CreateReducedRHSTempl<Scalar,Scalar>(LHS, RHS, ReducedRHS);
496 }
497 
498 template<class MatrixType>
499 template<class DomainScalar, class RangeScalar>
500 void SingletonFilter<MatrixType>::CreateReducedRHSTempl(const Tpetra::MultiVector<DomainScalar,LocalOrdinal,GlobalOrdinal,Node>& LHS,
501  const Tpetra::MultiVector<RangeScalar,LocalOrdinal,GlobalOrdinal,Node>& RHS,
502  Tpetra::MultiVector<RangeScalar,LocalOrdinal,GlobalOrdinal,Node>& ReducedRHS)
503 {
504  Teuchos::ArrayRCP<Teuchos::ArrayRCP<const RangeScalar > > RHS_ptr = RHS.get2dView();
505  Teuchos::ArrayRCP<Teuchos::ArrayRCP<const DomainScalar> > LHS_ptr = LHS.get2dView();
506  Teuchos::ArrayRCP<Teuchos::ArrayRCP<RangeScalar> > ReducedRHS_ptr = ReducedRHS.get2dViewNonConst();
507 
508  size_t NumVectors = LHS.getNumVectors();
509 
510  for (size_t i = 0 ; i < NumRows_ ; ++i)
511  for (size_t k = 0 ; k < NumVectors ; ++k)
512  ReducedRHS_ptr[k][i] = RHS_ptr[k][InvReorder_[i]];
513 
514  for (size_t i = 0 ; i < NumRows_ ; ++i) {
515  LocalOrdinal ii = InvReorder_[i];
516  size_t Nnz;
517  A_->getLocalRowCopy(ii,Indices_,Values_,Nnz);
518 
519  for (size_t j = 0 ; j < Nnz ; ++j) {
520  if (Reorder_[Indices_[j]] == -1) {
521  for (size_t k = 0 ; k < NumVectors ; ++k)
522  ReducedRHS_ptr[k][i] -= (RangeScalar)Values_[j] * (RangeScalar)LHS_ptr[k][Indices_[j]];
523  }
524  }
525  }
526 }
527 
528 template<class MatrixType>
529 void SingletonFilter<MatrixType>::UpdateLHS(const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& ReducedLHS,
530  Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& LHS)
531 {
532  this->template UpdateLHSTempl<Scalar,Scalar>(ReducedLHS, LHS);
533 }
534 
535 template<class MatrixType>
536 template<class DomainScalar, class RangeScalar>
537 void SingletonFilter<MatrixType>::UpdateLHSTempl(const Tpetra::MultiVector<DomainScalar,LocalOrdinal,GlobalOrdinal,Node>& ReducedLHS,
538  Tpetra::MultiVector<RangeScalar,LocalOrdinal,GlobalOrdinal,Node>& LHS)
539 {
540 
541  Teuchos::ArrayRCP<Teuchos::ArrayRCP<RangeScalar> > LHS_ptr = LHS.get2dViewNonConst();
542  Teuchos::ArrayRCP<Teuchos::ArrayRCP<const DomainScalar> > ReducedLHS_ptr = ReducedLHS.get2dView();
543 
544  for (size_t i = 0 ; i < NumRows_ ; ++i)
545  for (size_t k = 0 ; k < LHS.getNumVectors() ; ++k)
546  LHS_ptr[k][InvReorder_[i]] = (RangeScalar)ReducedLHS_ptr[k][i];
547 }
548 
549 template<class MatrixType>
550 typename SingletonFilter<MatrixType>::mag_type SingletonFilter<MatrixType>::getFrobeniusNorm() const
551 {
552  throw std::runtime_error("Ifpack2::SingletonFilter does not implement getFrobeniusNorm.");
553 }
554 
555 } // namespace Ifpack2
556 
557 #define IFPACK2_SINGLETONFILTER_INSTANT(S,LO,GO,N) \
558  template class Ifpack2::SingletonFilter< Tpetra::RowMatrix<S, LO, GO, N> >;
559 
560 #endif
virtual void rightScale(const Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)
Scales the RowMatrix on the right with the Vector x.
Definition: Ifpack2_SingletonFilter_def.hpp:399
virtual ~SingletonFilter()
Destructor.
Definition: Ifpack2_SingletonFilter_def.hpp:143
virtual bool isLocallyIndexed() const
If matrix indices are in the local range, this function returns true. Otherwise, this function return...
Definition: Ifpack2_SingletonFilter_def.hpp:271
virtual global_size_t getGlobalNumRows() const
Returns the number of global rows in this matrix.
Definition: Ifpack2_SingletonFilter_def.hpp:199
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_SingletonFilter_def.hpp:350
virtual size_t getGlobalMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on all nodes.
Definition: Ifpack2_SingletonFilter_def.hpp:253
virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getRangeMap() const
Returns the Map that describes the range distribution in this matrix.
Definition: Ifpack2_SingletonFilter_def.hpp:184
virtual void UpdateLHS(const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &ReducedLHS, Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &LHS)
Updates a full LHS from a reduces LHS.
Definition: Ifpack2_SingletonFilter_def.hpp:529
virtual void CreateReducedRHS(const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &LHS, const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &RHS, Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &ReducedRHS)
Creates a RHS for the reduced singleton-free system.
Definition: Ifpack2_SingletonFilter_def.hpp:491
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_SingletonFilter_def.hpp:368
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_SingletonFilter_def.hpp:311
virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getDomainMap() const
Returns the Map that describes the domain distribution in this matrix.
Definition: Ifpack2_SingletonFilter_def.hpp:175
virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getRowMap() const
Returns the Map that describes the row distribution in this matrix.
Definition: Ifpack2_SingletonFilter_def.hpp:157
virtual size_t getNodeNumRows() const
Returns the number of rows owned on the calling node.
Definition: Ifpack2_SingletonFilter_def.hpp:211
virtual bool hasTransposeApply() const
Indicates whether this operator supports applying the adjoint operator.
Definition: Ifpack2_SingletonFilter_def.hpp:450
virtual Teuchos::RCP< const Teuchos::Comm< int > > getComm() const
Returns the communicator.
Definition: Ifpack2_SingletonFilter_def.hpp:147
virtual mag_type getFrobeniusNorm() const
Returns the Frobenius norm of the matrix.
Definition: Ifpack2_SingletonFilter_def.hpp:550
virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const
Returns the current number of entries on this node in the specified global row.
Definition: Ifpack2_SingletonFilter_def.hpp:241
virtual size_t getNodeNumEntries() const
Returns the local number of entries in this matrix.
Definition: Ifpack2_SingletonFilter_def.hpp:235
virtual global_size_t getGlobalNumCols() const
Returns the number of global columns in this matrix.
Definition: Ifpack2_SingletonFilter_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_SingletonFilter_def.hpp:405
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_SingletonFilter_def.hpp:386
virtual bool hasColMap() const
Indicates whether this matrix has a well-defined column map.
Definition: Ifpack2_SingletonFilter_def.hpp:265
virtual Teuchos::RCP< const Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node > > getGraph() const
Returns the RowGraph associated with this matrix.
Definition: Ifpack2_SingletonFilter_def.hpp:193
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_SingletonFilter_def.hpp:217
SingletonFilter(const Teuchos::RCP< const Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &Matrix)
Constructor.
Definition: Ifpack2_SingletonFilter_def.hpp:56
virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const
Returns the current number of entries on this node in the specified local row.
Definition: Ifpack2_SingletonFilter_def.hpp:247
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_SingletonFilter_def.hpp:290
virtual void SolveSingletons(const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &RHS, Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &LHS)
Solve the singleton components of the linear system.
Definition: Ifpack2_SingletonFilter_def.hpp:462
virtual bool supportsRowViews() const
Returns true if RowViews are supported.
Definition: Ifpack2_SingletonFilter_def.hpp:456
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:73
virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getColMap() const
Returns the Map that describes the column distribution in this matrix.
Definition: Ifpack2_SingletonFilter_def.hpp:166
Filter based on matrix entries.
Definition: Ifpack2_SingletonFilter_decl.hpp:64
virtual void leftScale(const Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)
Scales the RowMatrix on the left with the Vector x.
Definition: Ifpack2_SingletonFilter_def.hpp:393
virtual bool isFillComplete() const
Returns true if fillComplete() has been called.
Definition: Ifpack2_SingletonFilter_def.hpp:283
virtual size_t getNodeMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on this node.
Definition: Ifpack2_SingletonFilter_def.hpp:259
virtual global_size_t getGlobalNumEntries() const
Returns the global number of entries in this matrix.
Definition: Ifpack2_SingletonFilter_def.hpp:229
virtual GlobalOrdinal getIndexBase() const
Returns the index base for global indices for this matrix.
Definition: Ifpack2_SingletonFilter_def.hpp:223
virtual bool isGloballyIndexed() const
If matrix indices are in the global range, this function returns true. Otherwise, this function retur...
Definition: Ifpack2_SingletonFilter_def.hpp:277