Ifpack2 Templated Preconditioning Package  Version 1.0
Ifpack2_ILUT_decl.hpp
Go to the documentation of this file.
1 /*@HEADER
2 // ***********************************************************************
3 //
4 // Ifpack2: Tempated 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 
45 
46 #ifndef IFPACK2_ILUT_DECL_HPP
47 #define IFPACK2_ILUT_DECL_HPP
48 
49 #include <Ifpack2_ConfigDefs.hpp>
52 #include <Tpetra_CrsMatrix_decl.hpp>
53 
54 #include <string>
55 #include <sstream>
56 #include <iostream>
57 #include <cmath>
58 #include <type_traits>
59 
60 namespace Teuchos {
61  class ParameterList; // forward declaration
62 }
63 
64 namespace Ifpack2 {
65 
90 template<class MatrixType>
91 class ILUT :
92  virtual public Ifpack2::Preconditioner<typename MatrixType::scalar_type,
93  typename MatrixType::local_ordinal_type,
94  typename MatrixType::global_ordinal_type,
95  typename MatrixType::node_type>,
96  virtual public Ifpack2::Details::CanChangeMatrix<Tpetra::RowMatrix<typename MatrixType::scalar_type,
97  typename MatrixType::local_ordinal_type,
98  typename MatrixType::global_ordinal_type,
99  typename MatrixType::node_type> >
100 {
101 public:
103 
104 
106  typedef typename MatrixType::scalar_type scalar_type;
107 
109  typedef typename MatrixType::local_ordinal_type local_ordinal_type;
110 
112  typedef typename MatrixType::global_ordinal_type global_ordinal_type;
113 
115  typedef typename MatrixType::node_type node_type;
116 
118  typedef typename Teuchos::ScalarTraits<scalar_type>::magnitudeType magnitude_type;
119 
121  typedef Tpetra::RowMatrix<scalar_type,
122  local_ordinal_type,
123  global_ordinal_type,
124  node_type> row_matrix_type;
125 
126  static_assert(std::is_same<MatrixType, row_matrix_type>::value, "Ifpack2::ILUT: 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.");
127 
129  typedef Tpetra::CrsMatrix<scalar_type,
130  local_ordinal_type,
131  global_ordinal_type,
132  node_type> crs_matrix_type;
133 
135  typedef Tpetra::Map<local_ordinal_type,
136  global_ordinal_type,
137  node_type> map_type;
139 
141 
151  explicit ILUT (const Teuchos::RCP<const row_matrix_type>& A);
152 
154  virtual ~ILUT();
155 
157 
159 
188  void setParameters (const Teuchos::ParameterList& params);
189 
197  void initialize ();
198 
200  inline bool isInitialized() const {
201  return IsInitialized_;
202  }
203 
205 
212  void compute();
213 
215  inline bool isComputed() const {
216  return IsComputed_;
217  }
218 
220 
222 
245  virtual void
246  setMatrix (const Teuchos::RCP<const row_matrix_type>& A);
247 
249 
251 
256  void
257  apply (const Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& X,
258  Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& Y,
259  Teuchos::ETransp mode = Teuchos::NO_TRANS,
260  scalar_type alpha = Teuchos::ScalarTraits<scalar_type>::one(),
261  scalar_type beta = Teuchos::ScalarTraits<scalar_type>::zero()) const;
262 
264  Teuchos::RCP<const map_type> getDomainMap() const;
265 
267  Teuchos::RCP<const map_type> getRangeMap() const;
268 
270  bool hasTransposeApply() const;
271 
273 
275 
277  Teuchos::RCP<const Teuchos::Comm<int> > getComm() const;
278 
280  Teuchos::RCP<const row_matrix_type> getMatrix () const;
281 
283  Teuchos::RCP<const crs_matrix_type> getL () const { return L_; }
284 
286  Teuchos::RCP<const crs_matrix_type> getU () const { return U_; }
287 
289  int getNumInitialize() const;
290 
292  int getNumCompute() const;
293 
295  int getNumApply() const;
296 
298  double getInitializeTime() const;
299 
301  double getComputeTime() const;
302 
304  double getApplyTime() const;
305 
313  inline int getLevelOfFill() const {
314  return LevelOfFill_;
315  }
316 
318  inline magnitude_type getAbsoluteThreshold() const {
319  return(Athresh_);
320  }
321 
323  inline magnitude_type getRelativeThreshold() const {
324  return(Rthresh_);
325  }
326 
328  inline magnitude_type getRelaxValue() const {
329  return(RelaxValue_);
330  }
331 
333  inline magnitude_type getDropTolerance() const {
334  return(DropTolerance_);
335  }
336 
338  global_size_t getGlobalNumEntries() const;
339 
341  size_t getNodeNumEntries() const;
342 
344 
346 
348  std::string description() const;
349 
351  void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const;
352 
354 
355 private:
356  typedef Teuchos::ScalarTraits<scalar_type> STS;
357  typedef Teuchos::ScalarTraits<magnitude_type> STM;
358  typedef typename Teuchos::Array<local_ordinal_type>::size_type size_type;
359 
361  ILUT (const ILUT<MatrixType>& RHS);
362 
364  ILUT<MatrixType>& operator= (const ILUT<MatrixType>& RHS);
365 
376  static Teuchos::RCP<const row_matrix_type>
377  makeLocalFilter (const Teuchos::RCP<const row_matrix_type>& A);
378 
379  // \name The matrix and its incomplete LU factors
381 
383  Teuchos::RCP<const row_matrix_type> A_;
385  Teuchos::RCP<const row_matrix_type> A_local_;
387  Teuchos::RCP<crs_matrix_type> L_;
389  Teuchos::RCP<crs_matrix_type> U_;
390 
392  // \name Parameters (set by setParameters())
394 
395  magnitude_type Athresh_;
396  magnitude_type Rthresh_;
397  magnitude_type RelaxValue_;
398  int LevelOfFill_;
399  magnitude_type DropTolerance_;
401 
403  // \name Other internal data
405 
407  double InitializeTime_;
409  double ComputeTime_;
411  mutable double ApplyTime_;
413  int NumInitialize_;
415  int NumCompute_;
417  mutable int NumApply_;
419  bool IsInitialized_;
421  bool IsComputed_;
423 }; // class ILUT
424 
425 } // namespace Ifpack2
426 
427 #endif /* IFPACK2_ILUT_HPP */
magnitude_type getDropTolerance() const
Gets the dropping tolerance.
Definition: Ifpack2_ILUT_decl.hpp:333
Mix-in interface for preconditioners that can change their matrix after construction.
Definition: Ifpack2_Details_CanChangeMatrix.hpp:93
Teuchos::RCP< const crs_matrix_type > getU() const
Returns a reference to the U factor.
Definition: Ifpack2_ILUT_decl.hpp:286
MatrixType::global_ordinal_type global_ordinal_type
The type of global indices in the input MatrixType.
Definition: Ifpack2_ILUT_decl.hpp:112
Teuchos::ScalarTraits< scalar_type >::magnitudeType magnitude_type
The type of the magnitude (absolute value) of a matrix entry.
Definition: Ifpack2_ILUT_decl.hpp:118
ILUT (incomplete LU factorization with threshold) of a Tpetra sparse matrix.
Definition: Ifpack2_ILUT_decl.hpp:91
magnitude_type getRelaxValue() const
Get the relax value.
Definition: Ifpack2_ILUT_decl.hpp:328
magnitude_type getRelativeThreshold() const
Get relative threshold value.
Definition: Ifpack2_ILUT_decl.hpp:323
MatrixType::scalar_type scalar_type
The type of the entries of the input MatrixType.
Definition: Ifpack2_ILUT_decl.hpp:106
Interface for all Ifpack2 preconditioners.
Definition: Ifpack2_Preconditioner.hpp:107
magnitude_type getAbsoluteThreshold() const
Get absolute threshold value.
Definition: Ifpack2_ILUT_decl.hpp:318
Tpetra::Map< local_ordinal_type, global_ordinal_type, node_type > map_type
Type of the Tpetra::Map specialization that this class uses.
Definition: Ifpack2_ILUT_decl.hpp:137
Declaration of interface for preconditioners that can change their matrix after construction.
Tpetra::RowMatrix< scalar_type, local_ordinal_type, global_ordinal_type, node_type > row_matrix_type
Type of the Tpetra::RowMatrix specialization that this class uses.
Definition: Ifpack2_ILUT_decl.hpp:124
Definition: Ifpack2_Details_Amesos2Wrapper_decl.hpp:63
Tpetra::CrsMatrix< scalar_type, local_ordinal_type, global_ordinal_type, node_type > crs_matrix_type
Type of the Tpetra::CrsMatrix specialization that this class uses for the L and U factors...
Definition: Ifpack2_ILUT_decl.hpp:126
int getLevelOfFill() const
The level of fill.
Definition: Ifpack2_ILUT_decl.hpp:313
bool isComputed() const
If compute() is completed, this query returns true, otherwise it returns false.
Definition: Ifpack2_ILUT_decl.hpp:215
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:72
bool isInitialized() const
Returns true if the preconditioner has been successfully initialized.
Definition: Ifpack2_ILUT_decl.hpp:200
Teuchos::RCP< const crs_matrix_type > getL() const
Returns a reference to the L factor.
Definition: Ifpack2_ILUT_decl.hpp:283
MatrixType::node_type node_type
The Node type used by the input MatrixType.
Definition: Ifpack2_ILUT_decl.hpp:115
MatrixType::local_ordinal_type local_ordinal_type
The type of local indices in the input MatrixType.
Definition: Ifpack2_ILUT_decl.hpp:109