43#ifndef IFPACK2_DIAGONALFILTER_DEF_HPP
44#define IFPACK2_DIAGONALFILTER_DEF_HPP
45#include "Ifpack2_DiagonalFilter_decl.hpp"
48#include "Teuchos_Comm.hpp"
49#include "Tpetra_Map.hpp"
50#include "Tpetra_MultiVector.hpp"
51#include "Tpetra_Vector.hpp"
56template<
class MatrixType>
58DiagonalFilter (
const Teuchos::RCP<
const Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> >& Matrix,
59 typename Teuchos::ScalarTraits<Scalar>::magnitudeType AbsoluteThreshold,
60 typename Teuchos::ScalarTraits<Scalar>::magnitudeType RelativeThreshold):
62 AbsoluteThreshold_(AbsoluteThreshold),
63 RelativeThreshold_(RelativeThreshold)
66 val_=Teuchos::rcp(
new Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node>(A_->getRowMap()));
76 A_->getLocalRowCopy(MyRow,Indices,Values,NumEntries);
78 for (
size_t i = 0 ; i < NumEntries ; ++i) {
79 if ((
size_t)Indices[i] == MyRow) {
81 if (Teuchos::ScalarTraits<Scalar>::real(Values[i]) < 0) {
82 mysign=-Teuchos::ScalarTraits<magnitudeType>::one();
85 mysign=Teuchos::ScalarTraits<magnitudeType>::one();
87 val_->replaceLocalValue (MyRow, Values[i] * (RelativeThreshold_ - 1) +
88 AbsoluteThreshold_ * mysign);
95template<
class MatrixType>
98template<
class MatrixType>
101 return A_->getComm();
105template<
class MatrixType>
106Teuchos::RCP<
const Tpetra::Map<
typename MatrixType::local_ordinal_type,
107 typename MatrixType::global_ordinal_type,
108 typename MatrixType::node_type> >
111 return A_->getRowMap();
114template<
class MatrixType>
115Teuchos::RCP<
const Tpetra::Map<
typename MatrixType::local_ordinal_type,
116 typename MatrixType::global_ordinal_type,
117 typename MatrixType::node_type> >
120 return A_->getColMap();
123template<
class MatrixType>
124Teuchos::RCP<
const Tpetra::Map<
typename MatrixType::local_ordinal_type,
125 typename MatrixType::global_ordinal_type,
126 typename MatrixType::node_type> >
129 return A_->getDomainMap();
132template<
class MatrixType>
133Teuchos::RCP<
const Tpetra::Map<
typename MatrixType::local_ordinal_type,
134 typename MatrixType::global_ordinal_type,
135 typename MatrixType::node_type> >
138 return A_->getRangeMap();
141template<
class MatrixType>
142Teuchos::RCP<
const Tpetra::RowGraph<
typename MatrixType::local_ordinal_type,
143 typename MatrixType::global_ordinal_type,
144 typename MatrixType::node_type> >
147 return A_->getGraph();
150template<
class MatrixType>
153 return A_->getGlobalNumRows();
156template<
class MatrixType>
159 return A_->getGlobalNumCols();
162template<
class MatrixType>
165 return A_->getLocalNumRows();
168template<
class MatrixType>
171 return A_->getLocalNumCols();
174template<
class MatrixType>
177 return A_->getIndexBase();
180template<
class MatrixType>
183 return A_->getGlobalNumEntries();
186template<
class MatrixType>
189 return A_->getLocalNumEntries();
192template<
class MatrixType>
195 return A_->getNumEntriesInGlobalRow(globalRow);
198template<
class MatrixType>
201 return A_->getNumEntriesInLocalRow(localRow);
204template<
class MatrixType>
207 return A_->getGlobalMaxNumRowEntries();
210template<
class MatrixType>
213 return A_->getLocalMaxNumRowEntries();
216template<
class MatrixType>
219 return A_->hasColMap();
222template<
class MatrixType>
225 return A_->isLocallyIndexed();
228template<
class MatrixType>
231 return A_->isGloballyIndexed();
234template<
class MatrixType>
237 return A_->isFillComplete();
240template<
class MatrixType>
243 nonconst_global_inds_host_view_type &Indices,
244 nonconst_values_host_view_type &Values,
245 size_t& NumEntries)
const
248 Teuchos::ArrayRCP< const Scalar > myvals=val_->get1dView();
249 LocalOrdinal LocalRow=getRowMap()->getLocalElement(GlobalRow);
251 A_->getGlobalRowCopy(GlobalRow, Indices,Values,NumEntries);
253 if (pos_[LocalRow] != -1)
254 Values[pos_[LocalRow]] += myvals[LocalRow];
258template<
class MatrixType>
261 nonconst_local_inds_host_view_type &Indices,
262 nonconst_values_host_view_type &Values,
263 size_t& NumEntries)
const
265 Teuchos::ArrayRCP< const Scalar > myvals=val_->get1dView();
267 A_->getLocalRowCopy(LocalRow, Indices,Values,NumEntries);
269 if (pos_[LocalRow] != -1)
270 Values[pos_[LocalRow]] += myvals[LocalRow];
274template<
class MatrixType>
276 global_inds_host_view_type &,
277 values_host_view_type &)
const
279 throw std::runtime_error(
"Ifpack2::DiagonalFilter: does not support getGlobalRowView.");
283template<
class MatrixType>
285 local_inds_host_view_type & ,
286 values_host_view_type & )
const
288 throw std::runtime_error(
"Ifpack2::DiagonalFilter: does not support getLocalRowView.");
292template<
class MatrixType>
297 return A_->getLocalDiagCopy(diag);
300template<
class MatrixType>
303 throw std::runtime_error(
"Ifpack2::DiagonalFilter does not support leftScale.");
306template<
class MatrixType>
309 throw std::runtime_error(
"Ifpack2::DiagonalFilter does not support rightScale.");
312template<
class MatrixType>
314apply (
const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &X,
315 Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y,
316 Teuchos::ETransp mode,
323 Scalar one = Teuchos::ScalarTraits<Scalar>::one();
324 A_->apply(X,Y,mode,alpha,beta);
325 Y.elementWiseMultiply(one,*val_,X,one);
328template<
class MatrixType>
331 return A_->hasTransposeApply();
334template<
class MatrixType>
340template<
class MatrixType>
343 throw std::runtime_error(
"Ifpack2::DiagonalFilter does not implement getFrobeniusNorm.");
348#define IFPACK2_DIAGONALFILTER_INSTANT(S,LO,GO,N) \
349 template class Ifpack2::DiagonalFilter< Tpetra::RowMatrix<S, LO, GO, N> >;
virtual global_size_t getGlobalNumRows() const
Returns the number of global rows in this matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:151
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 size_t getLocalNumEntries() 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 size_t getGlobalMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on all nodes.
Definition: Ifpack2_DiagonalFilter_def.hpp:205
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:314
virtual Teuchos::RCP< const Teuchos::Comm< int > > getComm() const
Returns the communicator.
Definition: Ifpack2_DiagonalFilter_def.hpp:99
virtual size_t getLocalNumRows() const
Returns the number of rows owned on the calling node.
Definition: Ifpack2_DiagonalFilter_def.hpp:163
virtual global_size_t getGlobalNumCols() const
Returns the number of global columns in this matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:157
DiagonalFilter(const Teuchos::RCP< const Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &Matrix, magnitudeType AbsoluteThreshold, magnitudeType RelativeThreshold)
Constructor.
Definition: Ifpack2_DiagonalFilter_def.hpp:58
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:293
virtual bool hasColMap() const
Indicates whether this matrix has a well-defined column map.
Definition: Ifpack2_DiagonalFilter_def.hpp:217
virtual mag_type getFrobeniusNorm() const
Returns the Frobenius norm of the matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:341
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:284
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 GlobalOrdinal getIndexBase() const
Returns the index base for global indices for this matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:175
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 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:301
virtual global_size_t getGlobalNumEntries() const
Returns the global number of entries in this matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:181
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 size_t getLocalMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on this node.
Definition: Ifpack2_DiagonalFilter_def.hpp:211
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
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
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 bool isFillComplete() const
Returns true if fillComplete() has been called.
Definition: Ifpack2_DiagonalFilter_def.hpp:235
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 size_t getLocalNumCols() const
Returns the number of columns needed to apply the forward operator on this node, i....
Definition: Ifpack2_DiagonalFilter_def.hpp:169
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 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:275
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:307
virtual bool hasTransposeApply() const
Indicates whether this operator supports applying the adjoint operator.
Definition: Ifpack2_DiagonalFilter_def.hpp:329
virtual bool supportsRowViews() const
Returns true if RowViews are supported.
Definition: Ifpack2_DiagonalFilter_def.hpp:335
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 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:260
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:74