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  Indices_.resize(MaxNumEntriesA_);
79  Values_.resize(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>
143 SingletonFilter<MatrixType>::~SingletonFilter() { }
144 
145 template<class MatrixType>
146 Teuchos::RCP<const Teuchos::Comm<int> >
147 SingletonFilter<MatrixType>::getComm() const
148 {
149  return A_->getComm();
150 }
151 
152 #ifdef TPETRA_ENABLE_DEPRECATED_CODE
153 template<class MatrixType>
154 TPETRA_DEPRECATED
155 Teuchos::RCP<typename MatrixType::node_type>
156 SingletonFilter<MatrixType>::getNode() const
157 {
158  return Teuchos::null;
159 }
160 #endif // TPETRA_ENABLE_DEPRECATED_CODE
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> >
166 SingletonFilter<MatrixType>::getRowMap() const
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> >
175 SingletonFilter<MatrixType>::getColMap() const
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> >
184 SingletonFilter<MatrixType>::getDomainMap() const
185 {
186  return ReducedMap_;
187 }
188 
189 template<class MatrixType>
190 Teuchos::RCP<const Tpetra::Map<typename MatrixType::local_ordinal_type,
191  typename MatrixType::global_ordinal_type,
192  typename MatrixType::node_type> >
193 SingletonFilter<MatrixType>::getRangeMap() const
194 {
195  return ReducedMap_;
196 }
197 
198 template<class MatrixType>
199 Teuchos::RCP<const Tpetra::RowGraph<typename MatrixType::local_ordinal_type,
200  typename MatrixType::global_ordinal_type,
201  typename MatrixType::node_type> >
202 SingletonFilter<MatrixType>::getGraph() const
203 {
204  throw std::runtime_error("Ifpack2::SingletonFilter: does not support getGraph.");
205 }
206 
207 template<class MatrixType>
208 global_size_t SingletonFilter<MatrixType>::getGlobalNumRows() const
209 {
210  return NumRows_;
211 }
212 
213 template<class MatrixType>
214 global_size_t SingletonFilter<MatrixType>::getGlobalNumCols() const
215 {
216  return NumRows_;
217 }
218 
219 template<class MatrixType>
220 size_t SingletonFilter<MatrixType>::getNodeNumRows() const
221 {
222  return NumRows_;
223 }
224 
225 template<class MatrixType>
226 size_t SingletonFilter<MatrixType>::getNodeNumCols() const
227 {
228  return NumRows_;
229 }
230 
231 template<class MatrixType>
232 typename MatrixType::global_ordinal_type SingletonFilter<MatrixType>::getIndexBase() const
233 {
234  return A_->getIndexBase();
235 }
236 
237 template<class MatrixType>
238 global_size_t SingletonFilter<MatrixType>::getGlobalNumEntries() const
239 {
240  return NumNonzeros_;
241 }
242 
243 template<class MatrixType>
244 size_t SingletonFilter<MatrixType>::getNodeNumEntries() const
245 {
246  return NumNonzeros_;
247 }
248 
249 template<class MatrixType>
250 size_t SingletonFilter<MatrixType>::getNumEntriesInGlobalRow(GlobalOrdinal /* globalRow */) const
251 {
252  throw std::runtime_error("Ifpack2::SingletonFilter does not implement getNumEntriesInGlobalRow.");
253 }
254 
255 template<class MatrixType>
256 size_t SingletonFilter<MatrixType>::getNumEntriesInLocalRow(LocalOrdinal localRow) const
257 {
258  return NumEntries_[localRow];
259 }
260 
261 template<class MatrixType>
262 size_t SingletonFilter<MatrixType>::getGlobalMaxNumRowEntries() const
263 {
264  return MaxNumEntries_;
265 }
266 
267 template<class MatrixType>
268 size_t SingletonFilter<MatrixType>::getNodeMaxNumRowEntries() const
269 {
270  return MaxNumEntries_;
271 }
272 
273 template<class MatrixType>
274 bool SingletonFilter<MatrixType>::hasColMap() const
275 {
276  return true;
277 }
278 
279 template<class MatrixType>
280 bool SingletonFilter<MatrixType>::isLocallyIndexed() const
281 {
282  return A_->isLocallyIndexed();
283 }
284 
285 template<class MatrixType>
286 bool SingletonFilter<MatrixType>::isGloballyIndexed() const
287 {
288  return A_->isGloballyIndexed();
289 }
290 
291 template<class MatrixType>
292 bool SingletonFilter<MatrixType>::isFillComplete() const
293 {
294  return A_->isFillComplete();
295 }
296 
297 template<class MatrixType>
298 void SingletonFilter<MatrixType>::getGlobalRowCopy(GlobalOrdinal /* GlobalRow */,
299  const Teuchos::ArrayView<GlobalOrdinal> &/* Indices */,
300  const Teuchos::ArrayView<Scalar> &/* Values */,
301  size_t &/* NumEntries */) const
302 {
303  throw std::runtime_error("Ifpack2::SingletonFilter does not implement getGlobalRowCopy.");
304 }
305 
306 template<class MatrixType>
307 void SingletonFilter<MatrixType>::getLocalRowCopy(LocalOrdinal LocalRow,
308  const Teuchos::ArrayView<LocalOrdinal> &Indices,
309  const Teuchos::ArrayView<Scalar> &Values,
310  size_t &NumEntries) const
311 {
312  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.");
313 
314  size_t Nnz;
315  LocalOrdinal ARow = InvReorder_[LocalRow];
316  A_->getLocalRowCopy(ARow,Indices_(),Values_(),Nnz);
317 
318  // populate the user's vectors
319  NumEntries = 0;
320  for (size_t i = 0 ; i < Nnz ; ++i) {
321  LocalOrdinal ii = Reorder_[Indices_[i]];
322  if ( ii >= 0) {
323  Indices[NumEntries] = ii;
324  Values[NumEntries] = Values_[i];
325  NumEntries++;
326  }
327  }
328 
329 }
330 
331 template<class MatrixType>
332 void SingletonFilter<MatrixType>::getGlobalRowView(GlobalOrdinal /* GlobalRow */,
333  Teuchos::ArrayView<const GlobalOrdinal> &/* indices */,
334  Teuchos::ArrayView<const Scalar> &/* values */) const
335 {
336  throw std::runtime_error("Ifpack2::SingletonFilter: does not support getGlobalRowView.");
337 }
338 
339 template<class MatrixType>
340 void SingletonFilter<MatrixType>::getLocalRowView(LocalOrdinal /* LocalRow */,
341  Teuchos::ArrayView<const LocalOrdinal> &/* indices */,
342  Teuchos::ArrayView<const Scalar> &/* values */) const
343 {
344  throw std::runtime_error("Ifpack2::SingletonFilter: does not support getLocalRowView.");
345 }
346 
347 template<class MatrixType>
348 void SingletonFilter<MatrixType>::getLocalDiagCopy(Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &diag) const
349 {
350  // This is somewhat dubious as to how the maps match.
351  return A_->getLocalDiagCopy(diag);
352 }
353 
354 template<class MatrixType>
355 void SingletonFilter<MatrixType>::leftScale(const Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& /* x */)
356 {
357  throw std::runtime_error("Ifpack2::SingletonFilter does not support leftScale.");
358 }
359 
360 template<class MatrixType>
361 void SingletonFilter<MatrixType>::rightScale(const Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& /* x */)
362 {
363  throw std::runtime_error("Ifpack2::SingletonFilter does not support rightScale.");
364 }
365 
366 template<class MatrixType>
367 void SingletonFilter<MatrixType>::apply(const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &X,
368  Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y,
369  Teuchos::ETransp mode,
370  Scalar /* alpha */,
371  Scalar /* beta */) const
372 {
373  typedef Scalar DomainScalar;
374  typedef Scalar RangeScalar;
375 
376  // Note: This isn't AztecOO compliant. But neither was Ifpack's version.
377 
378  TEUCHOS_TEST_FOR_EXCEPTION(X.getNumVectors() != Y.getNumVectors(), std::runtime_error,
379  "Ifpack2::SingletonFilter::apply ERROR: X.getNumVectors() != Y.getNumVectors().");
380 
381  RangeScalar zero = Teuchos::ScalarTraits<RangeScalar>::zero();
382  Teuchos::ArrayRCP<Teuchos::ArrayRCP<const DomainScalar> > x_ptr = X.get2dView();
383  Teuchos::ArrayRCP<Teuchos::ArrayRCP<RangeScalar> > y_ptr = Y.get2dViewNonConst();
384 
385  Y.putScalar(zero);
386  size_t NumVectors = Y.getNumVectors();
387 
388 
389  for (size_t i = 0 ; i < NumRows_ ; ++i) {
390  size_t Nnz;
391  // Use this class's getrow to make the below code simpler
392  getLocalRowCopy(i,Indices_(),Values_(),Nnz);
393  if (mode==Teuchos::NO_TRANS){
394  for (size_t j = 0 ; j < Nnz ; ++j)
395  for (size_t k = 0 ; k < NumVectors ; ++k)
396  y_ptr[k][i] += (RangeScalar)Values_[j] * (RangeScalar)x_ptr[k][Indices_[j]];
397  }
398  else if (mode==Teuchos::TRANS){
399  for (size_t j = 0 ; j < Nnz ; ++j)
400  for (size_t k = 0 ; k < NumVectors ; ++k)
401  y_ptr[k][Indices_[j]] += (RangeScalar)Values_[j] * (RangeScalar)x_ptr[k][i];
402  }
403  else { //mode==Teuchos::CONJ_TRANS
404  for (size_t j = 0 ; j < Nnz ; ++j)
405  for (size_t k = 0 ; k < NumVectors ; ++k)
406  y_ptr[k][Indices_[j]] += Teuchos::ScalarTraits<RangeScalar>::conjugate((RangeScalar)Values_[j]) * (RangeScalar)x_ptr[k][i];
407  }
408  }
409 }
410 
411 template<class MatrixType>
412 bool SingletonFilter<MatrixType>::hasTransposeApply() const
413 {
414  return true;
415 }
416 
417 template<class MatrixType>
418 bool SingletonFilter<MatrixType>::supportsRowViews() const
419 {
420  return false;
421 }
422 
423 template<class MatrixType>
424 void SingletonFilter<MatrixType>::SolveSingletons(const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& RHS,
425  Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& LHS)
426 {
427  this->template SolveSingletonsTempl<Scalar,Scalar>(RHS, LHS);
428 }
429 
430 template<class MatrixType>
431 template<class DomainScalar, class RangeScalar>
432 void SingletonFilter<MatrixType>::SolveSingletonsTempl(const Tpetra::MultiVector<DomainScalar,LocalOrdinal,GlobalOrdinal,Node>& RHS,
433  Tpetra::MultiVector<RangeScalar,LocalOrdinal,GlobalOrdinal,Node>& LHS)
434 {
435  Teuchos::ArrayRCP<Teuchos::ArrayRCP<const DomainScalar> > RHS_ptr = RHS.get2dView();
436  Teuchos::ArrayRCP<Teuchos::ArrayRCP<RangeScalar> > LHS_ptr = LHS.get2dViewNonConst();
437 
438  for (size_t i = 0 ; i < NumSingletons_ ; ++i) {
439  LocalOrdinal ii = SingletonIndex_[i];
440  // get the diagonal value for the singleton
441  size_t Nnz;
442  A_->getLocalRowCopy(ii,Indices_(),Values_(),Nnz);
443  for (size_t j = 0 ; j < Nnz ; ++j) {
444  if (Indices_[j] == ii) {
445  for (size_t k = 0 ; k < LHS.getNumVectors() ; ++k)
446  LHS_ptr[k][ii] = (RangeScalar)RHS_ptr[k][ii] / (RangeScalar)Values_[j];
447  }
448  }
449  }
450 }
451 
452 template<class MatrixType>
453 void SingletonFilter<MatrixType>::CreateReducedRHS(const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& LHS,
454  const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& RHS,
455  Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& ReducedRHS)
456 {
457  this->template CreateReducedRHSTempl<Scalar,Scalar>(LHS, RHS, ReducedRHS);
458 }
459 
460 template<class MatrixType>
461 template<class DomainScalar, class RangeScalar>
462 void SingletonFilter<MatrixType>::CreateReducedRHSTempl(const Tpetra::MultiVector<DomainScalar,LocalOrdinal,GlobalOrdinal,Node>& LHS,
463  const Tpetra::MultiVector<RangeScalar,LocalOrdinal,GlobalOrdinal,Node>& RHS,
464  Tpetra::MultiVector<RangeScalar,LocalOrdinal,GlobalOrdinal,Node>& ReducedRHS)
465 {
466  Teuchos::ArrayRCP<Teuchos::ArrayRCP<const RangeScalar > > RHS_ptr = RHS.get2dView();
467  Teuchos::ArrayRCP<Teuchos::ArrayRCP<const DomainScalar> > LHS_ptr = LHS.get2dView();
468  Teuchos::ArrayRCP<Teuchos::ArrayRCP<RangeScalar> > ReducedRHS_ptr = ReducedRHS.get2dViewNonConst();
469 
470  size_t NumVectors = LHS.getNumVectors();
471 
472  for (size_t i = 0 ; i < NumRows_ ; ++i)
473  for (size_t k = 0 ; k < NumVectors ; ++k)
474  ReducedRHS_ptr[k][i] = RHS_ptr[k][InvReorder_[i]];
475 
476  for (size_t i = 0 ; i < NumRows_ ; ++i) {
477  LocalOrdinal ii = InvReorder_[i];
478  size_t Nnz;
479  A_->getLocalRowCopy(ii,Indices_(),Values_(),Nnz);
480 
481  for (size_t j = 0 ; j < Nnz ; ++j) {
482  if (Reorder_[Indices_[j]] == -1) {
483  for (size_t k = 0 ; k < NumVectors ; ++k)
484  ReducedRHS_ptr[k][i] -= (RangeScalar)Values_[j] * (RangeScalar)LHS_ptr[k][Indices_[j]];
485  }
486  }
487  }
488 }
489 
490 template<class MatrixType>
491 void SingletonFilter<MatrixType>::UpdateLHS(const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& ReducedLHS,
492  Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& LHS)
493 {
494  this->template UpdateLHSTempl<Scalar,Scalar>(ReducedLHS, LHS);
495 }
496 
497 template<class MatrixType>
498 template<class DomainScalar, class RangeScalar>
499 void SingletonFilter<MatrixType>::UpdateLHSTempl(const Tpetra::MultiVector<DomainScalar,LocalOrdinal,GlobalOrdinal,Node>& ReducedLHS,
500  Tpetra::MultiVector<RangeScalar,LocalOrdinal,GlobalOrdinal,Node>& LHS)
501 {
502 
503  Teuchos::ArrayRCP<Teuchos::ArrayRCP<RangeScalar> > LHS_ptr = LHS.get2dViewNonConst();
504  Teuchos::ArrayRCP<Teuchos::ArrayRCP<const DomainScalar> > ReducedLHS_ptr = ReducedLHS.get2dView();
505 
506  for (size_t i = 0 ; i < NumRows_ ; ++i)
507  for (size_t k = 0 ; k < LHS.getNumVectors() ; ++k)
508  LHS_ptr[k][InvReorder_[i]] = (RangeScalar)ReducedLHS_ptr[k][i];
509 }
510 
511 template<class MatrixType>
512 typename SingletonFilter<MatrixType>::mag_type SingletonFilter<MatrixType>::getFrobeniusNorm() const
513 {
514  throw std::runtime_error("Ifpack2::SingletonFilter does not implement getFrobeniusNorm.");
515 }
516 
517 } // namespace Ifpack2
518 
519 #define IFPACK2_SINGLETONFILTER_INSTANT(S,LO,GO,N) \
520  template class Ifpack2::SingletonFilter< Tpetra::RowMatrix<S, LO, GO, N> >;
521 
522 #endif
Ifpack2::SingletonFilter::isFillComplete
virtual bool isFillComplete() const
Returns true if fillComplete() has been called.
Definition: Ifpack2_SingletonFilter_def.hpp:292
Ifpack2::SingletonFilter::getGlobalNumCols
virtual global_size_t getGlobalNumCols() const
Returns the number of global columns in this matrix.
Definition: Ifpack2_SingletonFilter_def.hpp:214
Ifpack2::SingletonFilter::rightScale
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:361
Ifpack2::SingletonFilter::SolveSingletons
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:424
Ifpack2::SingletonFilter::getRowMap
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:166
Ifpack2::SingletonFilter::getLocalRowView
virtual void getLocalRowView(LocalOrdinal LocalRow, 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_SingletonFilter_def.hpp:340
Ifpack2::SingletonFilter::getLocalDiagCopy
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:348
Ifpack2::SingletonFilter::getGlobalRowCopy
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_SingletonFilter_def.hpp:298
Ifpack2::SingletonFilter::getGraph
virtual Teuchos::RCP< const Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node > > getGraph() const
Returns the RowGraph associated with this matrix.
Definition: Ifpack2_SingletonFilter_def.hpp:202
Ifpack2::SingletonFilter::getNodeNumCols
virtual size_t getNodeNumCols() const
Returns the number of columns needed to apply the forward operator on this node, i....
Definition: Ifpack2_SingletonFilter_def.hpp:226
Ifpack2::SingletonFilter::getNumEntriesInGlobalRow
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:250
Ifpack2::SingletonFilter::UpdateLHS
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:491
Ifpack2::SingletonFilter::getColMap
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:175
Ifpack2::SingletonFilter::getNodeMaxNumRowEntries
virtual size_t getNodeMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on this node.
Definition: Ifpack2_SingletonFilter_def.hpp:268
Ifpack2
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:73
Ifpack2::SingletonFilter::hasTransposeApply
virtual bool hasTransposeApply() const
Indicates whether this operator supports applying the adjoint operator.
Definition: Ifpack2_SingletonFilter_def.hpp:412
Ifpack2::SingletonFilter
Filter based on matrix entries.
Definition: Ifpack2_SingletonFilter_decl.hpp:65
Ifpack2::SingletonFilter::apply
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:367
Ifpack2::SingletonFilter::getComm
virtual Teuchos::RCP< const Teuchos::Comm< int > > getComm() const
Returns the communicator.
Definition: Ifpack2_SingletonFilter_def.hpp:147
Ifpack2::SingletonFilter::isGloballyIndexed
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:286
Ifpack2::SingletonFilter::getRangeMap
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:193
Ifpack2::SingletonFilter::getFrobeniusNorm
virtual mag_type getFrobeniusNorm() const
Returns the Frobenius norm of the matrix.
Definition: Ifpack2_SingletonFilter_def.hpp:512
Ifpack2::SingletonFilter::getNumEntriesInLocalRow
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:256
Ifpack2::SingletonFilter::getDomainMap
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:184
Ifpack2::SingletonFilter::getGlobalNumRows
virtual global_size_t getGlobalNumRows() const
Returns the number of global rows in this matrix.
Definition: Ifpack2_SingletonFilter_def.hpp:208
Ifpack2::SingletonFilter::SingletonFilter
SingletonFilter(const Teuchos::RCP< const Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &Matrix)
Constructor.
Definition: Ifpack2_SingletonFilter_def.hpp:56
Ifpack2::SingletonFilter::getNodeNumRows
virtual size_t getNodeNumRows() const
Returns the number of rows owned on the calling node.
Definition: Ifpack2_SingletonFilter_def.hpp:220
Ifpack2::SingletonFilter::getGlobalRowView
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_SingletonFilter_def.hpp:332
Ifpack2::SingletonFilter::CreateReducedRHS
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:453
Ifpack2::SingletonFilter::getLocalRowCopy
virtual void getLocalRowCopy(LocalOrdinal LocalRow, 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_SingletonFilter_def.hpp:307
Ifpack2::SingletonFilter::getNodeNumEntries
virtual size_t getNodeNumEntries() const
Returns the local number of entries in this matrix.
Definition: Ifpack2_SingletonFilter_def.hpp:244
Ifpack2::SingletonFilter::getIndexBase
virtual GlobalOrdinal getIndexBase() const
Returns the index base for global indices for this matrix.
Definition: Ifpack2_SingletonFilter_def.hpp:232
Ifpack2::SingletonFilter::supportsRowViews
virtual bool supportsRowViews() const
Returns true if RowViews are supported.
Definition: Ifpack2_SingletonFilter_def.hpp:418
Ifpack2::SingletonFilter::leftScale
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:355
Ifpack2::SingletonFilter::hasColMap
virtual bool hasColMap() const
Indicates whether this matrix has a well-defined column map.
Definition: Ifpack2_SingletonFilter_def.hpp:274
Ifpack2::SingletonFilter::getGlobalNumEntries
virtual global_size_t getGlobalNumEntries() const
Returns the global number of entries in this matrix.
Definition: Ifpack2_SingletonFilter_def.hpp:238
Ifpack2::SingletonFilter::getGlobalMaxNumRowEntries
virtual size_t getGlobalMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on all nodes.
Definition: Ifpack2_SingletonFilter_def.hpp:262
Ifpack2::SingletonFilter::~SingletonFilter
virtual ~SingletonFilter()
Destructor.
Definition: Ifpack2_SingletonFilter_def.hpp:143
Ifpack2::SingletonFilter::isLocallyIndexed
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:280
Generated by doxygen 1.8.20