43 #ifndef IFPACK2_DIAGONALFILTER_DECL_HPP 44 #define IFPACK2_DIAGONALFILTER_DECL_HPP 46 #include "Ifpack2_Details_RowMatrix.hpp" 47 #include <type_traits> 74 template<
class MatrixType>
78 typedef typename MatrixType::scalar_type Scalar;
79 typedef typename MatrixType::local_ordinal_type LocalOrdinal;
80 typedef typename MatrixType::global_ordinal_type GlobalOrdinal;
81 typedef typename MatrixType::node_type Node;
82 typedef typename MatrixType::global_inds_host_view_type global_inds_host_view_type;
83 typedef typename MatrixType::local_inds_host_view_type local_inds_host_view_type;
84 typedef typename MatrixType::values_host_view_type values_host_view_type;
86 typedef typename MatrixType::nonconst_global_inds_host_view_type nonconst_global_inds_host_view_type;
87 typedef typename MatrixType::nonconst_local_inds_host_view_type nonconst_local_inds_host_view_type;
88 typedef typename MatrixType::nonconst_values_host_view_type nonconst_values_host_view_type;
90 typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType magnitudeType;
91 typedef Tpetra::RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> row_matrix_type;
92 typedef typename row_matrix_type::mag_type mag_type;
94 static_assert(std::is_same<MatrixType, Tpetra::RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> >::value,
"Ifpack2::DiagonalFilter: 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.");
100 explicit DiagonalFilter(
const Teuchos::RCP<
const Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> >& Matrix,
101 magnitudeType AbsoluteThreshold,
102 magnitudeType RelativeThreshold);
113 virtual Teuchos::RCP<const Teuchos::Comm<int> >
getComm()
const;
117 virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >
getRowMap()
const;
120 virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >
getColMap()
const;
123 virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >
getDomainMap()
const;
126 virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >
getRangeMap()
const;
129 virtual Teuchos::RCP<const Tpetra::RowGraph<LocalOrdinal,GlobalOrdinal,Node> >
getGraph()
const;
199 nonconst_global_inds_host_view_type &Indices,
200 nonconst_values_host_view_type &Values,
201 size_t& NumEntries)
const;
202 #ifdef TPETRA_ENABLE_DEPRECATED_CODE 204 const Teuchos::ArrayView<GlobalOrdinal> &Indices,
205 const Teuchos::ArrayView<Scalar> &Values,
206 size_t &NumEntries)
const;
222 nonconst_local_inds_host_view_type &Indices,
223 nonconst_values_host_view_type &Values,
224 size_t& NumEntries)
const;
225 #ifdef TPETRA_ENABLE_DEPRECATED_CODE 227 const Teuchos::ArrayView<LocalOrdinal> &Indices,
228 const Teuchos::ArrayView<Scalar> &Values,
229 size_t &NumEntries)
const ;
243 global_inds_host_view_type &indices,
244 values_host_view_type &values)
const;
245 #ifdef TPETRA_ENABLE_DEPRECATED_CODE 247 Teuchos::ArrayView<const GlobalOrdinal> &indices,
248 Teuchos::ArrayView<const Scalar> &values)
const;
262 local_inds_host_view_type & indices,
263 values_host_view_type & values)
const;
264 #ifdef TPETRA_ENABLE_DEPRECATED_CODE 266 Teuchos::ArrayView<const LocalOrdinal> &indices,
267 Teuchos::ArrayView<const Scalar> &values)
const;
272 virtual void getLocalDiagCopy(Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &diag)
const;
288 virtual void leftScale(
const Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& x);
299 virtual void rightScale(
const Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& x);
315 virtual void apply(
const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &X,
316 Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y,
317 Teuchos::ETransp mode = Teuchos::NO_TRANS,
318 Scalar alpha = Teuchos::ScalarTraits<Scalar>::one(),
319 Scalar beta = Teuchos::ScalarTraits<Scalar>::zero())
const;
328 Teuchos::RCP<const Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> > A_;
330 magnitudeType AbsoluteThreshold_;
332 magnitudeType RelativeThreshold_;
334 std::vector<LocalOrdinal> pos_;
336 Teuchos::RCP<Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > val_;
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_DiagonalFilter_def.hpp:242
Ifpack2_DiagonalFilter: Filter to modify the diagonal entries of a given Tpetra_RowMatrix.
Definition: Ifpack2_DiagonalFilter_decl.hpp:75
virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getRangeMap() const
Returns the Map that describes the range distribution in this matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:136
virtual global_size_t getGlobalNumRows() const
Returns the number of global rows in this matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:151
virtual global_size_t getGlobalNumEntries() const
Returns the global number of entries in this matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:181
virtual bool isLocallyIndexed() const
If matrix indices are in the local range, this function returns true. Otherwise, this function return...
Definition: Ifpack2_DiagonalFilter_def.hpp:223
All Ifpack2 implementations of Tpetra::RowMatrix must inherit from this class.
Definition: Ifpack2_Details_RowMatrix.hpp:63
virtual bool isGloballyIndexed() const
If matrix indices are in the global range, this function returns true. Otherwise, this function retur...
Definition: Ifpack2_DiagonalFilter_def.hpp:229
virtual GlobalOrdinal getIndexBase() const
Returns the index base for global indices for this matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:175
virtual size_t getNodeNumEntries() const
Returns the local number of entries in this matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:187
virtual ~DiagonalFilter()
Destructor.
Definition: Ifpack2_DiagonalFilter_def.hpp:96
virtual bool hasColMap() const
Indicates whether this matrix has a well-defined column map.
Definition: Ifpack2_DiagonalFilter_def.hpp:217
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_DiagonalFilter_def.hpp:324
virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getRowMap() const
Returns the Map that describes the row distribution in this matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:109
virtual size_t getGlobalMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on all nodes.
Definition: Ifpack2_DiagonalFilter_def.hpp:205
virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getDomainMap() const
Returns the Map that describes the domain distribution in this matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:127
virtual bool supportsRowViews() const
Returns true if RowViews are supported.
Definition: Ifpack2_DiagonalFilter_def.hpp:385
virtual mag_type getFrobeniusNorm() const
Returns the Frobenius norm of the matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:391
virtual Teuchos::RCP< const Teuchos::Comm< int > > getComm() const
Returns the communicator.
Definition: Ifpack2_DiagonalFilter_def.hpp:99
virtual void leftScale(const Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)
Scales the RowMatrix on the left with the Vector x.
Definition: Ifpack2_DiagonalFilter_def.hpp:351
virtual size_t getNodeMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on this node.
Definition: Ifpack2_DiagonalFilter_def.hpp:211
virtual bool hasTransposeApply() const
Indicates whether this operator supports applying the adjoint operator.
Definition: Ifpack2_DiagonalFilter_def.hpp:379
virtual void rightScale(const Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)
Scales the RowMatrix on the right with the Vector x.
Definition: Ifpack2_DiagonalFilter_def.hpp:357
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_DiagonalFilter_def.hpp:364
virtual Teuchos::RCP< const Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node > > getGraph() const
Returns the RowGraph associated with this matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:145
virtual global_size_t getGlobalNumCols() const
Returns the number of global columns in this matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:157
virtual void getLocalRowCopy(LocalOrdinal LocalRow, 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_DiagonalFilter_def.hpp:274
DiagonalFilter(const Teuchos::RCP< const Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &Matrix, magnitudeType AbsoluteThreshold, magnitudeType RelativeThreshold)
Constructor.
Definition: Ifpack2_DiagonalFilter_def.hpp:58
virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const
Returns the current number of entries on this node in the specified local row.
Definition: Ifpack2_DiagonalFilter_def.hpp:199
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_DiagonalFilter_def.hpp:343
virtual size_t getNodeNumRows() const
Returns the number of rows owned on the calling node.
Definition: Ifpack2_DiagonalFilter_def.hpp:163
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:73
virtual bool isFillComplete() const
Returns true if fillComplete() has been called.
Definition: Ifpack2_DiagonalFilter_def.hpp:235
virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getColMap() const
Returns the Map that describes the column distribution in this matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:118
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_DiagonalFilter_def.hpp:169
virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const
Returns the current number of entries on this node in the specified global row.
Definition: Ifpack2_DiagonalFilter_def.hpp:193
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_DiagonalFilter_def.hpp:305