43#ifndef IFPACK2_DROPFILTER_DECL_HPP
44#define IFPACK2_DROPFILTER_DECL_HPP
46#include "Ifpack2_ConfigDefs.hpp"
47#include "Tpetra_ConfigDefs.hpp"
48#include "Ifpack2_Details_RowMatrix.hpp"
49#include "Teuchos_RefCountPtr.hpp"
50#include "Teuchos_ScalarTraits.hpp"
76template<
class MatrixType>
80 typedef typename MatrixType::scalar_type Scalar;
81 typedef typename MatrixType::local_ordinal_type LocalOrdinal;
82 typedef typename MatrixType::global_ordinal_type GlobalOrdinal;
83 typedef typename MatrixType::node_type Node;
84 typedef typename MatrixType::global_inds_host_view_type global_inds_host_view_type;
85 typedef typename MatrixType::local_inds_host_view_type local_inds_host_view_type;
86 typedef typename MatrixType::values_host_view_type values_host_view_type;
88 typedef typename MatrixType::nonconst_global_inds_host_view_type nonconst_global_inds_host_view_type;
89 typedef typename MatrixType::nonconst_local_inds_host_view_type nonconst_local_inds_host_view_type;
90 typedef typename MatrixType::nonconst_values_host_view_type nonconst_values_host_view_type;
92 typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType magnitudeType;
94 typedef Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> row_matrix_type;
95 typedef typename row_matrix_type::mag_type mag_type;
98 static_assert(std::is_same<MatrixType, Tpetra::RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> >::value,
"Ifpack2::DropFilter: The template parameter MatrixType must be a Tpetra::RowMatrix specialization. Please don't use Tpetra::CrsMatrix (a subclass of Tpetra::RowMatrix) here anymore. The constructor can take either a RowMatrix or a CrsMatrix just fine.");
104 explicit DropFilter(
const Teuchos::RCP<
const Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> >& Matrix,
105 magnitudeType DropTol);
115 virtual Teuchos::RCP<const Teuchos::Comm<int> >
getComm()
const;
119 virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >
getRowMap()
const;
122 virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >
getColMap()
const;
125 virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >
getDomainMap()
const;
128 virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >
getRangeMap()
const;
131 virtual Teuchos::RCP<const Tpetra::RowGraph<LocalOrdinal,GlobalOrdinal,Node> >
getGraph()
const;
201 nonconst_global_inds_host_view_type &Indices,
202 nonconst_values_host_view_type &Values,
203 size_t& NumEntries)
const;
218 nonconst_local_inds_host_view_type &Indices,
219 nonconst_values_host_view_type &Values,
220 size_t& NumEntries)
const;
234 global_inds_host_view_type &indices,
235 values_host_view_type &values)
const;
249 local_inds_host_view_type & indices,
250 values_host_view_type & values)
const;
255 virtual void getLocalDiagCopy(Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &diag)
const;
271 virtual void leftScale(
const Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& x);
282 virtual void rightScale(
const Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& x);
296 virtual void apply(
const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &X,
297 Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y,
298 Teuchos::ETransp mode = Teuchos::NO_TRANS,
299 Scalar alpha = Teuchos::ScalarTraits<Scalar>::one(),
300 Scalar beta = Teuchos::ScalarTraits<Scalar>::zero())
const;
310 Teuchos::RCP<const Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> > A_;
312 magnitudeType DropTol_;
318 size_t MaxNumEntries_;
320 size_t MaxNumEntriesA_;
322 std::vector<size_t> NumEntries_;
324 mutable nonconst_local_inds_host_view_type Indices_;
326 mutable nonconst_values_host_view_type Values_;
All Ifpack2 implementations of Tpetra::RowMatrix must inherit from this class.
Definition: Ifpack2_Details_RowMatrix.hpp:67
Filter based on matrix entries.
Definition: Ifpack2_DropFilter_decl.hpp:78
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
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