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"
57template<
class MatrixType>
59 magnitudeType DropTol):
69 if (A_->getComm()->getSize() != 1 || A_->getLocalNumRows() != 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_->getLocalNumRows();
80 NumEntries_.resize(NumRows_);
84 MaxNumEntries_ = A_->getLocalMaxNumRowEntries();
85 MaxNumEntriesA_ = A_->getLocalMaxNumRowEntries();
88 Kokkos::resize(Indices_,MaxNumEntries_);
89 Kokkos::resize(Values_,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;
111template<
class MatrixType>
115template<
class MatrixType>
116Teuchos::RCP<const Teuchos::Comm<int> >
119 return A_->getComm ();
124template<
class MatrixType>
125Teuchos::RCP<
const Tpetra::Map<
typename MatrixType::local_ordinal_type,
126 typename MatrixType::global_ordinal_type,
127 typename MatrixType::node_type> >
130 return A_->getRowMap();
134template<
class MatrixType>
135Teuchos::RCP<
const Tpetra::Map<
typename MatrixType::local_ordinal_type,
136 typename MatrixType::global_ordinal_type,
137 typename MatrixType::node_type> >
140 return A_->getColMap();
144template<
class MatrixType>
145Teuchos::RCP<
const Tpetra::Map<
typename MatrixType::local_ordinal_type,
146 typename MatrixType::global_ordinal_type,
147 typename MatrixType::node_type> >
150 return A_->getDomainMap();
154template<
class MatrixType>
155Teuchos::RCP<
const Tpetra::Map<
typename MatrixType::local_ordinal_type,
156 typename MatrixType::global_ordinal_type,
157 typename MatrixType::node_type> >
160 return A_->getRangeMap();
164template<
class MatrixType>
165Teuchos::RCP<
const Tpetra::RowGraph<
typename MatrixType::local_ordinal_type,
166 typename MatrixType::global_ordinal_type,
167 typename MatrixType::node_type> >
170 throw std::runtime_error(
"Ifpack2::DropFilter: does not support getGraph.");
174template<
class MatrixType>
181template<
class MatrixType>
188template<
class MatrixType>
196template<
class MatrixType>
203template<
class MatrixType>
206 return A_->getIndexBase();
210template<
class MatrixType>
217template<
class MatrixType>
224template<
class MatrixType>
227 throw std::runtime_error(
"Ifpack2::DropFilter does not implement getNumEntriesInGlobalRow.");
231template<
class MatrixType>
234 return NumEntries_[localRow];
238template<
class MatrixType>
241 return MaxNumEntries_;
245template<
class MatrixType>
248 return MaxNumEntries_;
252template<
class MatrixType>
259template<
class MatrixType>
262 return A_->isLocallyIndexed();
266template<
class MatrixType>
269 return A_->isGloballyIndexed();
273template<
class MatrixType>
276 return A_->isFillComplete();
280template<
class MatrixType>
283 nonconst_global_inds_host_view_type &,
284 nonconst_values_host_view_type &,
287 throw std::runtime_error(
"Ifpack2::DropFilter does not implement getGlobalRowCopy.");
291template<
class MatrixType>
294 nonconst_local_inds_host_view_type &Indices,
295 nonconst_values_host_view_type &Values,
296 size_t& NumEntries)
const
298 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.");
306 size_t A_NumEntries=0;
307 A_->getLocalRowCopy(LocalRow,Indices_,Values_,A_NumEntries);
313 for (
size_t i = 0 ; i < A_NumEntries ; ++i) {
317 if ((Indices_[i] == LocalRow) || (Teuchos::ScalarTraits<Scalar>::magnitude(Values_[i]) >= DropTol_)) {
318 Values[NumEntries] = Values_[i];
319 Indices[NumEntries] = Indices_[i];
326template<
class MatrixType>
328 global_inds_host_view_type &,
329 values_host_view_type &)
const
331 throw std::runtime_error(
"Ifpack2::DropFilter: does not support getGlobalRowView.");
335template<
class MatrixType>
337 local_inds_host_view_type & ,
338 values_host_view_type & )
const
340 throw std::runtime_error(
"Ifpack2::DropFilter: does not support getLocalRowView.");
344template<
class MatrixType>
348 return A_->getLocalDiagCopy(diag);
352template<
class MatrixType>
355 throw std::runtime_error(
"Ifpack2::DropFilter does not support leftScale.");
359template<
class MatrixType>
362 throw std::runtime_error(
"Ifpack2::DropFilter does not support rightScale.");
366template<
class MatrixType>
368 Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y,
369 Teuchos::ETransp mode,
375 TEUCHOS_TEST_FOR_EXCEPTION(X.getNumVectors() != Y.getNumVectors(), std::runtime_error,
376 "Ifpack2::DropFilter::apply ERROR: X.getNumVectors() != Y.getNumVectors().");
378 Scalar zero = Teuchos::ScalarTraits<Scalar>::zero();
379 Teuchos::ArrayRCP<Teuchos::ArrayRCP<const Scalar> > x_ptr = X.get2dView();
380 Teuchos::ArrayRCP<Teuchos::ArrayRCP<Scalar> > y_ptr = Y.get2dViewNonConst();
383 size_t NumVectors = Y.getNumVectors();
385 for (
size_t i = 0 ; i < NumRows_ ; ++i) {
388 getLocalRowCopy(i,Indices_,Values_,Nnz);
389 Scalar* Values =
reinterpret_cast<Scalar*
>(Values_.data());
390 if (mode==Teuchos::NO_TRANS){
391 for (
size_t j = 0 ; j < Nnz ; ++j)
392 for (
size_t k = 0 ; k < NumVectors ; ++k)
393 y_ptr[k][i] += Values[j] * x_ptr[k][Indices_[j]];
395 else if (mode==Teuchos::TRANS){
396 for (
size_t j = 0 ; j < Nnz ; ++j)
397 for (
size_t k = 0 ; k < NumVectors ; ++k)
398 y_ptr[k][Indices_[j]] += Values[j] * x_ptr[k][i];
401 for (
size_t j = 0 ; j < Nnz ; ++j)
402 for (
size_t k = 0 ; k < NumVectors ; ++k)
403 y_ptr[k][Indices_[j]] += Teuchos::ScalarTraits<Scalar>::conjugate(Values[j]) * x_ptr[k][i];
410template<
class MatrixType>
417template<
class MatrixType>
424template<
class MatrixType>
427 throw std::runtime_error(
"Ifpack2::DropFilter does not implement getFrobeniusNorm.");
431#define IFPACK2_DROPFILTER_INSTANT(S,LO,GO,N) \
432 template class Ifpack2::DropFilter< Tpetra::RowMatrix<S, LO, GO, N> >;
virtual size_t getLocalNumRows() const
Returns the number of rows owned on the calling node.
Definition: Ifpack2_DropFilter_def.hpp:189
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:138
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:360
virtual bool hasColMap() const
Indicates whether this matrix has a well-defined column map.
Definition: Ifpack2_DropFilter_def.hpp:253
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_DropFilter_def.hpp:336
virtual global_size_t getGlobalNumRows() const
Returns the number of global rows in this matrix.
Definition: Ifpack2_DropFilter_def.hpp:175
virtual bool hasTransposeApply() const
Indicates whether this operator supports applying the adjoint operator.
Definition: Ifpack2_DropFilter_def.hpp:411
virtual bool supportsRowViews() const
Returns true if RowViews are supported.
Definition: Ifpack2_DropFilter_def.hpp:418
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:353
virtual GlobalOrdinal getIndexBase() const
Returns the index base for global indices for this matrix.
Definition: Ifpack2_DropFilter_def.hpp:204
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:232
virtual Teuchos::RCP< const Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node > > getGraph() const
Returns the RowGraph associated with this matrix.
Definition: Ifpack2_DropFilter_def.hpp:168
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:128
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:267
virtual size_t getLocalNumEntries() const
Returns the local number of entries in this matrix.
Definition: Ifpack2_DropFilter_def.hpp:218
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_DropFilter_def.hpp:282
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:158
DropFilter(const Teuchos::RCP< const Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &Matrix, magnitudeType DropTol)
Constructor.
Definition: Ifpack2_DropFilter_def.hpp:58
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:260
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:148
virtual mag_type getFrobeniusNorm() const
Returns the Frobenius norm of the matrix.
Definition: Ifpack2_DropFilter_def.hpp:425
virtual bool isFillComplete() const
Returns true if fillComplete() has been called.
Definition: Ifpack2_DropFilter_def.hpp:274
virtual size_t getLocalNumCols() const
Returns the number of columns needed to apply the forward operator on this node, i....
Definition: Ifpack2_DropFilter_def.hpp:197
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_DropFilter_def.hpp:327
virtual size_t getLocalMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on this node.
Definition: Ifpack2_DropFilter_def.hpp:246
virtual void getLocalRowCopy(LocalOrdinal DropRow, 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_DropFilter_def.hpp:293
virtual ~DropFilter()
Destructor.
Definition: Ifpack2_DropFilter_def.hpp:112
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:225
virtual global_size_t getGlobalNumEntries() const
Returns the global number of entries in this matrix.
Definition: Ifpack2_DropFilter_def.hpp:211
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:367
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:345
virtual Teuchos::RCP< const Teuchos::Comm< int > > getComm() const
Returns the communicator.
Definition: Ifpack2_DropFilter_def.hpp:117
virtual global_size_t getGlobalNumCols() const
Returns the number of global columns in this matrix.
Definition: Ifpack2_DropFilter_def.hpp:182
virtual size_t getGlobalMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on all nodes.
Definition: Ifpack2_DropFilter_def.hpp:239
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:74