43 #ifndef IFPACK2_SINGLETONFILTER_DEF_HPP
44 #define IFPACK2_SINGLETONFILTER_DEF_HPP
45 #include "Ifpack2_SingletonFilter_decl.hpp"
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"
55 template<
class MatrixType>
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.");
71 size_t NumRowsA_ = A_->getNodeNumRows();
75 MaxNumEntriesA_ = A_->getNodeMaxNumRowEntries();
78 Indices_.
resize(MaxNumEntriesA_);
79 Values_.
resize(MaxNumEntriesA_);
82 Reorder_.resize(NumRowsA_);
83 Reorder_.assign(Reorder_.size(),-1);
87 for (
size_t i = 0 ; i < NumRowsA_ ; ++i) {
89 A_->getLocalRowCopy(i,Indices_,Values_,Nnz);
91 Reorder_[i] = NumRows_++;
99 InvReorder_.resize(NumRows_);
100 for (
size_t i = 0 ; i < NumRowsA_ ; ++i) {
103 InvReorder_[Reorder_[i]] = i;
105 NumEntries_.resize(NumRows_);
106 SingletonIndex_.resize(NumSingletons_);
111 for (
size_t i = 0 ; i < NumRowsA_ ; ++i) {
113 A_->getLocalRowCopy(i,Indices_,Values_,Nnz);
114 LocalOrdinal ii = Reorder_[i];
116 NumEntries_[ii] = Nnz;
118 if (Nnz > MaxNumEntries_)
119 MaxNumEntries_ = Nnz;
122 SingletonIndex_[count] = i;
128 ReducedMap_ =
Teuchos::rcp(
new Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node>(NumRows_,0,A_->getComm()) );
131 Diagonal_ =
Teuchos::rcp(
new Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node>(ReducedMap_) );
133 Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> DiagonalA(A_->getRowMap());
134 A_->getLocalDiagCopy(DiagonalA);
136 for (
size_t i = 0 ; i < NumRows_ ; ++i) {
137 LocalOrdinal ii = InvReorder_[i];
138 Diagonal_->replaceLocalValue((LocalOrdinal)i,DiagonalAview[ii]);
142 template<
class MatrixType>
145 template<
class MatrixType>
149 return A_->getComm();
152 #ifdef TPETRA_ENABLE_DEPRECATED_CODE
153 template<
class MatrixType>
158 return Teuchos::null;
160 #endif // TPETRA_ENABLE_DEPRECATED_CODE
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> >
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> >
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> >
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> >
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> >
204 throw std::runtime_error(
"Ifpack2::SingletonFilter: does not support getGraph.");
207 template<
class MatrixType>
213 template<
class MatrixType>
219 template<
class MatrixType>
225 template<
class MatrixType>
231 template<
class MatrixType>
234 return A_->getIndexBase();
237 template<
class MatrixType>
243 template<
class MatrixType>
249 template<
class MatrixType>
252 throw std::runtime_error(
"Ifpack2::SingletonFilter does not implement getNumEntriesInGlobalRow.");
255 template<
class MatrixType>
258 return NumEntries_[localRow];
261 template<
class MatrixType>
264 return MaxNumEntries_;
267 template<
class MatrixType>
270 return MaxNumEntries_;
273 template<
class MatrixType>
279 template<
class MatrixType>
282 return A_->isLocallyIndexed();
285 template<
class MatrixType>
288 return A_->isGloballyIndexed();
291 template<
class MatrixType>
294 return A_->isFillComplete();
297 template<
class MatrixType>
303 throw std::runtime_error(
"Ifpack2::SingletonFilter does not implement getGlobalRowCopy.");
306 template<
class MatrixType>
310 size_t &NumEntries)
const
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.");
315 LocalOrdinal ARow = InvReorder_[LocalRow];
316 A_->getLocalRowCopy(ARow,Indices_(),Values_(),Nnz);
320 for (
size_t i = 0 ; i < Nnz ; ++i) {
321 LocalOrdinal ii = Reorder_[Indices_[i]];
323 Indices[NumEntries] = ii;
324 Values[NumEntries] = Values_[i];
331 template<
class MatrixType>
336 throw std::runtime_error(
"Ifpack2::SingletonFilter: does not support getGlobalRowView.");
339 template<
class MatrixType>
344 throw std::runtime_error(
"Ifpack2::SingletonFilter: does not support getLocalRowView.");
347 template<
class MatrixType>
351 return A_->getLocalDiagCopy(diag);
354 template<
class MatrixType>
357 throw std::runtime_error(
"Ifpack2::SingletonFilter does not support leftScale.");
360 template<
class MatrixType>
363 throw std::runtime_error(
"Ifpack2::SingletonFilter does not support rightScale.");
366 template<
class MatrixType>
368 Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y,
373 typedef Scalar DomainScalar;
374 typedef Scalar RangeScalar;
379 "Ifpack2::SingletonFilter::apply ERROR: X.getNumVectors() != Y.getNumVectors().");
386 size_t NumVectors = Y.getNumVectors();
389 for (
size_t i = 0 ; i < NumRows_ ; ++i) {
392 getLocalRowCopy(i,Indices_(),Values_(),Nnz);
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]];
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];
404 for (
size_t j = 0 ; j < Nnz ; ++j)
405 for (
size_t k = 0 ; k < NumVectors ; ++k)
411 template<
class MatrixType>
417 template<
class MatrixType>
423 template<
class MatrixType>
425 Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& LHS)
427 this->
template SolveSingletonsTempl<Scalar,Scalar>(RHS, LHS);
430 template<
class MatrixType>
431 template<
class DomainScalar,
class RangeScalar>
433 Tpetra::MultiVector<RangeScalar,LocalOrdinal,GlobalOrdinal,Node>& LHS)
438 for (
size_t i = 0 ; i < NumSingletons_ ; ++i) {
439 LocalOrdinal ii = SingletonIndex_[i];
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];
452 template<
class MatrixType>
454 const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& RHS,
455 Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& ReducedRHS)
457 this->
template CreateReducedRHSTempl<Scalar,Scalar>(LHS, RHS, ReducedRHS);
460 template<
class MatrixType>
461 template<
class DomainScalar,
class RangeScalar>
463 const Tpetra::MultiVector<RangeScalar,LocalOrdinal,GlobalOrdinal,Node>& RHS,
464 Tpetra::MultiVector<RangeScalar,LocalOrdinal,GlobalOrdinal,Node>& ReducedRHS)
470 size_t NumVectors = LHS.getNumVectors();
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]];
476 for (
size_t i = 0 ; i < NumRows_ ; ++i) {
477 LocalOrdinal ii = InvReorder_[i];
479 A_->getLocalRowCopy(ii,Indices_(),Values_(),Nnz);
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]];
490 template<
class MatrixType>
492 Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& LHS)
494 this->
template UpdateLHSTempl<Scalar,Scalar>(ReducedLHS, LHS);
497 template<
class MatrixType>
498 template<
class DomainScalar,
class RangeScalar>
500 Tpetra::MultiVector<RangeScalar,LocalOrdinal,GlobalOrdinal,Node>& LHS)
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];
511 template<
class MatrixType>
514 throw std::runtime_error(
"Ifpack2::SingletonFilter does not implement getFrobeniusNorm.");
519 #define IFPACK2_SINGLETONFILTER_INSTANT(S,LO,GO,N) \
520 template class Ifpack2::SingletonFilter< Tpetra::RowMatrix<S, LO, GO, N> >;
virtual bool hasTransposeApply() const
Indicates whether this operator supports applying the adjoint operator.
Definition: Ifpack2_SingletonFilter_def.hpp:412
virtual mag_type getFrobeniusNorm() const
Returns the Frobenius norm of the matrix.
Definition: Ifpack2_SingletonFilter_def.hpp:512
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
virtual ~SingletonFilter()
Destructor.
Definition: Ifpack2_SingletonFilter_def.hpp:143
virtual Teuchos::RCP< const Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node > > getGraph() const
Returns the RowGraph associated with this matrix.
Definition: Ifpack2_SingletonFilter_def.hpp:202
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
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
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
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
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
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
virtual bool supportsRowViews() const
Returns true if RowViews are supported.
Definition: Ifpack2_SingletonFilter_def.hpp:418
virtual global_size_t getGlobalNumRows() const
Returns the number of global rows in this matrix.
Definition: Ifpack2_SingletonFilter_def.hpp:208
virtual GlobalOrdinal getIndexBase() const
Returns the index base for global indices for this matrix.
Definition: Ifpack2_SingletonFilter_def.hpp:232
virtual size_t getNodeNumEntries() const
Returns the local number of entries in this matrix.
Definition: Ifpack2_SingletonFilter_def.hpp:244
virtual bool isFillComplete() const
Returns true if fillComplete() has been called.
Definition: Ifpack2_SingletonFilter_def.hpp:292
virtual global_size_t getGlobalNumCols() const
Returns the number of global columns in this matrix.
Definition: Ifpack2_SingletonFilter_def.hpp:214
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
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
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
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
virtual global_size_t getGlobalNumEntries() const
Returns the global number of entries in this matrix.
Definition: Ifpack2_SingletonFilter_def.hpp:238
virtual bool hasColMap() const
Indicates whether this matrix has a well-defined column map.
Definition: Ifpack2_SingletonFilter_def.hpp:274
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
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:226
void resize(size_type new_size, const value_type &x=value_type())
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
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
virtual size_t getGlobalMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on all nodes.
Definition: Ifpack2_SingletonFilter_def.hpp:262
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
SingletonFilter(const Teuchos::RCP< const Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &Matrix)
Constructor.
Definition: Ifpack2_SingletonFilter_def.hpp:56
virtual size_t getNodeNumRows() const
Returns the number of rows owned on the calling node.
Definition: Ifpack2_SingletonFilter_def.hpp:220
virtual Teuchos::RCP< const Teuchos::Comm< int > > getComm() const
Returns the communicator.
Definition: Ifpack2_SingletonFilter_def.hpp:147
virtual size_t getNodeMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on this node.
Definition: Ifpack2_SingletonFilter_def.hpp:268
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
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
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
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:355
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
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