Ifpack2 Templated Preconditioning Package  Version 1.0
Ifpack2_DropFilter_decl.hpp
1 /*@HEADER
2 // ***********************************************************************
3 //
4 // Ifpack2: Templated Object-Oriented Algebraic Preconditioner Package
5 // Copyright (2009) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 //@HEADER
41 */
42 
43 #ifndef IFPACK2_DROPFILTER_DECL_HPP
44 #define IFPACK2_DROPFILTER_DECL_HPP
45 
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"
51 #include <type_traits>
52 
53 namespace Ifpack2 {
54 
76 template<class MatrixType>
77 class DropFilter :
78  virtual public Ifpack2::Details::RowMatrix<MatrixType> {
79 public:
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;
87 
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;
91 
92  typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType magnitudeType;
93 
94  typedef Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> row_matrix_type;
95  typedef typename row_matrix_type::mag_type mag_type;
96 
97 
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.");
99 
101 
102 
104  explicit DropFilter(const Teuchos::RCP<const Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> >& Matrix,
105  magnitudeType DropTol);
107  virtual ~DropFilter();
108 
110 
112 
113 
115  virtual Teuchos::RCP<const Teuchos::Comm<int> > getComm() const;
116 
117 
119  virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > getRowMap() const;
120 
122  virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > getColMap() const;
123 
125  virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > getDomainMap() const;
126 
128  virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > getRangeMap() const;
129 
131  virtual Teuchos::RCP<const Tpetra::RowGraph<LocalOrdinal,GlobalOrdinal,Node> > getGraph() const;
132 
134  virtual global_size_t getGlobalNumRows() const;
135 
137  virtual global_size_t getGlobalNumCols() const;
138 
140  virtual size_t getNodeNumRows() const;
141 
143  virtual size_t getNodeNumCols() const;
144 
146  virtual GlobalOrdinal getIndexBase() const;
147 
149  virtual global_size_t getGlobalNumEntries() const;
150 
152  virtual size_t getNodeNumEntries() const;
153 
155 
156  virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const;
157 
159 
160  virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const;
161 
163  virtual size_t getGlobalMaxNumRowEntries() const;
164 
166  virtual size_t getNodeMaxNumRowEntries() const;
167 
169  virtual bool hasColMap() const;
170 
172  virtual bool isLocallyIndexed() const;
173 
175  virtual bool isGloballyIndexed() const;
176 
178  virtual bool isFillComplete() const;
179 
181  virtual bool supportsRowViews() const;
182 
184 
186 
187 
189 
199  virtual void
200  getGlobalRowCopy (GlobalOrdinal GlobalRow,
201  nonconst_global_inds_host_view_type &Indices,
202  nonconst_values_host_view_type &Values,
203  size_t& NumEntries) const;
204 #ifdef TPETRA_ENABLE_DEPRECATED_CODE
205  virtual void getGlobalRowCopy(GlobalOrdinal GlobalRow,
206  const Teuchos::ArrayView<GlobalOrdinal> &Indices,
207  const Teuchos::ArrayView<Scalar> &Values,
208  size_t &NumEntries) const;
209 #endif
210 
212 
222  virtual void
223  getLocalRowCopy (LocalOrdinal DropRow,
224  nonconst_local_inds_host_view_type &Indices,
225  nonconst_values_host_view_type &Values,
226  size_t& NumEntries) const;
227 #ifdef TPETRA_ENABLE_DEPRECATED_CODE
228  virtual void getLocalRowCopy(LocalOrdinal DropRow,
229  const Teuchos::ArrayView<LocalOrdinal> &Indices,
230  const Teuchos::ArrayView<Scalar> &Values,
231  size_t &NumEntries) const ;
232 #endif
233 
243  virtual void
244  getGlobalRowView (GlobalOrdinal GlobalRow,
245  global_inds_host_view_type &indices,
246  values_host_view_type &values) const;
247 #ifdef TPETRA_ENABLE_DEPRECATED_CODE
248  virtual void getGlobalRowView(GlobalOrdinal GlobalRow,
249  Teuchos::ArrayView<const GlobalOrdinal> &indices,
250  Teuchos::ArrayView<const Scalar> &values) const;
251 #endif
252 
262  virtual void
263  getLocalRowView (LocalOrdinal LocalRow,
264  local_inds_host_view_type & indices,
265  values_host_view_type & values) const;
266 #ifdef TPETRA_ENABLE_DEPRECATED_CODE
267  virtual void getLocalRowView(LocalOrdinal DropRow,
268  Teuchos::ArrayView<const LocalOrdinal> &indices,
269  Teuchos::ArrayView<const Scalar> &values) const;
270 #endif
271 
274  virtual void getLocalDiagCopy(Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &diag) const;
275 
277 
279 
280 
290  virtual void leftScale(const Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& x);
291 
301  virtual void rightScale(const Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& x);
302 
304 
307  virtual mag_type getFrobeniusNorm() const;
308 
310 
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;
320 
322  virtual bool hasTransposeApply() const;
323 
325 
326 private:
327 
329  Teuchos::RCP<const Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> > A_;
331  magnitudeType DropTol_;
333  size_t NumRows_;
335  size_t NumNonzeros_;
337  size_t MaxNumEntries_;
339  size_t MaxNumEntriesA_;
341  std::vector<size_t> NumEntries_;
343  mutable nonconst_local_inds_host_view_type Indices_;
345  mutable nonconst_values_host_view_type Values_;
346 
347 };
348 
349 } // namespace Ifpack2
350 
351 #endif /* IFPACK2_DROPFILTER_DECL_HPP */
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 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
All Ifpack2 implementations of Tpetra::RowMatrix must inherit from this class.
Definition: Ifpack2_Details_RowMatrix.hpp:63
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 bool hasTransposeApply() const
Indicates whether this operator supports applying the adjoint operator.
Definition: Ifpack2_DropFilter_def.hpp:457
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: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:354
DropFilter(const Teuchos::RCP< const Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &Matrix, magnitudeType DropTol)
Constructor.
Definition: Ifpack2_DropFilter_def.hpp:58
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:305
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 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 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:399
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 bool isFillComplete() const
Returns true if fillComplete() has been called.
Definition: Ifpack2_DropFilter_def.hpp:274
virtual global_size_t getGlobalNumRows() const
Returns the number of global rows in this matrix.
Definition: Ifpack2_DropFilter_def.hpp:175
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:406
virtual size_t getNodeNumEntries() const
Returns the local number of entries in this matrix.
Definition: Ifpack2_DropFilter_def.hpp:218
Filter based on matrix entries.
Definition: Ifpack2_DropFilter_decl.hpp:77
virtual size_t getNodeNumRows() const
Returns the number of rows owned on the calling node.
Definition: Ifpack2_DropFilter_def.hpp:189
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:413
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:253
virtual bool supportsRowViews() const
Returns true if RowViews are supported.
Definition: Ifpack2_DropFilter_def.hpp:464
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
virtual size_t getNodeMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on this node.
Definition: Ifpack2_DropFilter_def.hpp:246
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 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 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:391
virtual mag_type getFrobeniusNorm() const
Returns the Frobenius norm of the matrix.
Definition: Ifpack2_DropFilter_def.hpp:471
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 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:372
virtual GlobalOrdinal getIndexBase() const
Returns the index base for global indices for this matrix.
Definition: Ifpack2_DropFilter_def.hpp:204
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:73
virtual ~DropFilter()
Destructor.
Definition: Ifpack2_DropFilter_def.hpp:112