43 #ifndef IFPACK2_DROPFILTER_DEF_HPP 44 #define IFPACK2_DROPFILTER_DEF_HPP 45 #include "Ifpack2_DropFilter_decl.hpp" 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" 57 template<
class MatrixType>
59 magnitudeType DropTol):
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.");
75 NumRows_ = A_->getNodeNumRows();
80 NumEntries_.resize(NumRows_);
84 MaxNumEntries_ = A_->getNodeMaxNumRowEntries();
85 MaxNumEntriesA_ = A_->getNodeMaxNumRowEntries();
88 Indices_.resize(MaxNumEntries_);
89 Values_.resize(MaxNumEntries_);
91 size_t ActualMaxNumEntries = 0;
92 for (
size_t i = 0 ; i < NumRows_ ; ++i) {
93 NumEntries_[i] = MaxNumEntriesA_;
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_))
101 NumNonzeros_ += NewNnz;
102 NumEntries_[i] = NewNnz;
103 if (NewNnz > ActualMaxNumEntries)
104 ActualMaxNumEntries = NewNnz;
107 MaxNumEntries_ = ActualMaxNumEntries;
111 template<
class MatrixType>
115 template<
class MatrixType>
116 Teuchos::RCP<const Teuchos::Comm<int> >
119 return A_->getComm ();
123 template<
class MatrixType>
124 Teuchos::RCP<typename MatrixType::node_type>
127 return A_->getNode ();
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> >
137 return A_->getRowMap();
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> >
147 return A_->getColMap();
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> >
157 return A_->getDomainMap();
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> >
167 return A_->getRangeMap();
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> >
177 throw std::runtime_error(
"Ifpack2::DropFilter: does not support getGraph.");
181 template<
class MatrixType>
188 template<
class MatrixType>
195 template<
class MatrixType>
203 template<
class MatrixType>
210 template<
class MatrixType>
213 return A_->getIndexBase();
217 template<
class MatrixType>
224 template<
class MatrixType>
231 template<
class MatrixType>
234 throw std::runtime_error(
"Ifpack2::DropFilter does not implement getNumEntriesInGlobalRow.");
238 template<
class MatrixType>
241 return NumEntries_[localRow];
245 template<
class MatrixType>
248 return A_->getGlobalNumDiags();
252 template<
class MatrixType>
255 return A_->getNodeNumDiags();
259 template<
class MatrixType>
262 return MaxNumEntries_;
266 template<
class MatrixType>
269 return MaxNumEntries_;
273 template<
class MatrixType>
280 template<
class MatrixType>
283 return A_->isLowerTriangular();
287 template<
class MatrixType>
290 return A_->isUpperTriangular();
294 template<
class MatrixType>
297 return A_->isLocallyIndexed();
301 template<
class MatrixType>
304 return A_->isGloballyIndexed();
308 template<
class MatrixType>
311 return A_->isFillComplete();
315 template<
class MatrixType>
317 const Teuchos::ArrayView<GlobalOrdinal> &Indices,
318 const Teuchos::ArrayView<Scalar> &Values,
319 size_t &NumEntries)
const 321 throw std::runtime_error(
"Ifpack2::DropFilter does not implement getGlobalRowCopy.");
325 template<
class MatrixType>
327 const Teuchos::ArrayView<LocalOrdinal> &Indices,
328 const Teuchos::ArrayView<Scalar> &Values,
329 size_t &NumEntries)
const 331 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.");
339 size_t A_NumEntries=0;
340 A_->getLocalRowCopy(LocalRow,Indices_(),Values_(),A_NumEntries);
346 for (
size_t i = 0 ; i < A_NumEntries ; ++i) {
350 if ((Indices_[i] == LocalRow) || (Teuchos::ScalarTraits<Scalar>::magnitude(Values_[i]) >= DropTol_)) {
351 Values[NumEntries] = Values_[i];
352 Indices[NumEntries] = Indices_[i];
359 template<
class MatrixType>
361 Teuchos::ArrayView<const GlobalOrdinal> &indices,
362 Teuchos::ArrayView<const Scalar> &values)
const 364 throw std::runtime_error(
"Ifpack2::DropFilter: does not support getGlobalRowView.");
368 template<
class MatrixType>
370 Teuchos::ArrayView<const LocalOrdinal> &indices,
371 Teuchos::ArrayView<const Scalar> &values)
const 373 throw std::runtime_error(
"Ifpack2::DropFilter: does not support getLocalRowView.");
377 template<
class MatrixType>
381 return A_->getLocalDiagCopy(diag);
385 template<
class MatrixType>
388 throw std::runtime_error(
"Ifpack2::DropFilter does not support leftScale.");
392 template<
class MatrixType>
395 throw std::runtime_error(
"Ifpack2::DropFilter does not support rightScale.");
399 template<
class MatrixType>
401 Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y,
402 Teuchos::ETransp mode,
408 TEUCHOS_TEST_FOR_EXCEPTION(X.getNumVectors() != Y.getNumVectors(), std::runtime_error,
409 "Ifpack2::DropFilter::apply ERROR: X.getNumVectors() != Y.getNumVectors().");
411 Scalar
zero = Teuchos::ScalarTraits<Scalar>::zero();
412 Teuchos::ArrayRCP<Teuchos::ArrayRCP<const Scalar> > x_ptr = X.get2dView();
413 Teuchos::ArrayRCP<Teuchos::ArrayRCP<Scalar> > y_ptr = Y.get2dViewNonConst();
416 size_t NumVectors = Y.getNumVectors();
418 for (
size_t i = 0 ; i < NumRows_ ; ++i) {
421 getLocalRowCopy(i,Indices_(),Values_(),Nnz);
422 if (mode==Teuchos::NO_TRANS){
423 for (
size_t j = 0 ; j < Nnz ; ++j)
424 for (
size_t k = 0 ; k < NumVectors ; ++k)
425 y_ptr[k][i] += Values_[j] * x_ptr[k][Indices_[j]];
427 else if (mode==Teuchos::TRANS){
428 for (
size_t j = 0 ; j < Nnz ; ++j)
429 for (
size_t k = 0 ; k < NumVectors ; ++k)
430 y_ptr[k][Indices_[j]] += Values_[j] * x_ptr[k][i];
433 for (
size_t j = 0 ; j < Nnz ; ++j)
434 for (
size_t k = 0 ; k < NumVectors ; ++k)
435 y_ptr[k][Indices_[j]] += Teuchos::ScalarTraits<Scalar>::conjugate(Values_[j]) * x_ptr[k][i];
442 template<
class MatrixType>
449 template<
class MatrixType>
456 template<
class MatrixType>
459 throw std::runtime_error(
"Ifpack2::DropFilter does not implement getFrobeniusNorm.");
463 #define IFPACK2_DROPFILTER_INSTANT(S,LO,GO,N) \ 464 template class Ifpack2::DropFilter< Tpetra::RowMatrix<S, LO, GO, N> >; 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:326
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
virtual global_size_t getGlobalNumDiags() const
Returns the number of global diagonal entries, based on global row/column index comparisons.
Definition: Ifpack2_DropFilter_def.hpp:246
virtual bool hasTransposeApply() const
Indicates whether this operator supports applying the adjoint operator.
Definition: Ifpack2_DropFilter_def.hpp:443
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:360
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:316
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:386
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:295
virtual bool isFillComplete() const
Returns true if fillComplete() has been called.
Definition: Ifpack2_DropFilter_def.hpp:309
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:393
virtual size_t getNodeNumEntries() const
Returns the local number of entries in this matrix.
Definition: Ifpack2_DropFilter_def.hpp:225
virtual size_t getNodeNumDiags() const
Returns the number of local diagonal entries, based on global row/column index comparisons.
Definition: Ifpack2_DropFilter_def.hpp:253
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
virtual bool isUpperTriangular() const
Indicates whether this matrix is upper triangular.
Definition: Ifpack2_DropFilter_def.hpp:288
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:400
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:274
virtual bool supportsRowViews() const
Returns true if RowViews are supported.
Definition: Ifpack2_DropFilter_def.hpp:450
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:260
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:267
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:302
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:378
virtual mag_type getFrobeniusNorm() const
Returns the Frobenius norm of the matrix.
Definition: Ifpack2_DropFilter_def.hpp:457
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:369
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
virtual bool isLowerTriangular() const
Indicates whether this matrix is lower triangular.
Definition: Ifpack2_DropFilter_def.hpp:281