Ifpack2 Templated Preconditioning Package  Version 1.0
Ifpack2_ILUT_decl.hpp
Go to the documentation of this file.
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 
45 
46 #ifndef IFPACK2_ILUT_DECL_HPP
47 #define IFPACK2_ILUT_DECL_HPP
48 
51 #include "Tpetra_CrsMatrix_decl.hpp"
52 #include "Ifpack2_LocalSparseTriangularSolver_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,
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,
133 
135  typedef Tpetra::Map<local_ordinal_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 
307  size_t getNodeSmootherComplexity() const;
308 
309 
317  inline int getLevelOfFill() const {
318  return LevelOfFill_;
319  }
320 
323  return(Athresh_);
324  }
325 
328  return(Rthresh_);
329  }
330 
332  inline magnitude_type getRelaxValue() const {
333  return(RelaxValue_);
334  }
335 
338  return(DropTolerance_);
339  }
340 
342  global_size_t getGlobalNumEntries() const;
343 
345  size_t getNodeNumEntries() const;
346 
348 
350 
352  std::string description() const;
353 
355  void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const;
356 
358 
359 private:
360  typedef Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type> MV;
361  typedef Teuchos::ScalarTraits<scalar_type> STS;
362  typedef Teuchos::ScalarTraits<magnitude_type> STM;
363  typedef typename Teuchos::Array<local_ordinal_type>::size_type size_type;
364 
366  ILUT (const ILUT<MatrixType>& RHS);
367 
368  void allocateSolvers ();
369 
371  ILUT<MatrixType>& operator= (const ILUT<MatrixType>& RHS);
372 
383  static Teuchos::RCP<const row_matrix_type>
384  makeLocalFilter (const Teuchos::RCP<const row_matrix_type>& A);
385 
386  // \name The matrix and its incomplete LU factors
388 
390  Teuchos::RCP<const row_matrix_type> A_;
392  Teuchos::RCP<const row_matrix_type> A_local_;
394  Teuchos::RCP<crs_matrix_type> L_;
396  Teuchos::RCP<LocalSparseTriangularSolver<row_matrix_type> > L_solver_;
398  Teuchos::RCP<crs_matrix_type> U_;
400  Teuchos::RCP<LocalSparseTriangularSolver<row_matrix_type> > U_solver_;
401 
403  // \name Parameters (set by setParameters())
405 
406  magnitude_type Athresh_;
407  magnitude_type Rthresh_;
408  magnitude_type RelaxValue_;
409  int LevelOfFill_;
410  magnitude_type DropTolerance_;
412 
414  // \name Other internal data
416 
418  double InitializeTime_;
420  double ComputeTime_;
422  mutable double ApplyTime_;
424  int NumInitialize_;
426  int NumCompute_;
428  mutable int NumApply_;
430  bool IsInitialized_;
432  bool IsComputed_;
434 }; // class ILUT
435 
436 } // namespace Ifpack2
437 
438 #endif /* IFPACK2_ILUT_HPP */
magnitude_type getRelaxValue() const
Get the relax value.
Definition: Ifpack2_ILUT_decl.hpp:332
int getNumCompute() const
Returns the number of calls to Compute().
Definition: Ifpack2_ILUT_def.hpp:334
Mix-in interface for preconditioners that can change their matrix after construction.
Definition: Ifpack2_Details_CanChangeMatrix.hpp:93
Teuchos::RCP< const crs_matrix_type > getL() const
Returns a reference to the L factor.
Definition: Ifpack2_ILUT_decl.hpp:283
ILUT(const Teuchos::RCP< const row_matrix_type > &A)
Constructor.
Definition: Ifpack2_ILUT_def.hpp:116
virtual ~ILUT()
Destructor.
Definition: Ifpack2_ILUT_def.hpp:136
global_size_t getGlobalNumEntries() const
Returns the number of nonzero entries in the global graph.
Definition: Ifpack2_ILUT_def.hpp:375
bool hasTransposeApply() const
Whether this object&#39;s apply() method can apply the transpose (or conjugate transpose, if applicable).
Definition: Ifpack2_ILUT_def.hpp:322
size_t getNodeNumEntries() const
Returns the number of nonzero entries in the local graph.
Definition: Ifpack2_ILUT_def.hpp:381
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
void initialize()
Clear any previously computed factors.
Definition: Ifpack2_ILUT_def.hpp:427
magnitude_type getDropTolerance() const
Gets the dropping tolerance.
Definition: Ifpack2_ILUT_decl.hpp:337
magnitude_type getAbsoluteThreshold() const
Get absolute threshold value.
Definition: Ifpack2_ILUT_decl.hpp:322
bool isComputed() const
If compute() is completed, this query returns true, otherwise it returns false.
Definition: Ifpack2_ILUT_decl.hpp:215
int getNumApply() const
Returns the number of calls to apply().
Definition: Ifpack2_ILUT_def.hpp:340
int getNumInitialize() const
Returns the number of calls to Initialize().
Definition: Ifpack2_ILUT_def.hpp:328
ILUT (incomplete LU factorization with threshold) of a Tpetra sparse matrix.
Definition: Ifpack2_ILUT_decl.hpp:91
Teuchos::RCP< const map_type > getRangeMap() const
Tpetra::Map representing the range of this operator.
Definition: Ifpack2_ILUT_def.hpp:311
double getInitializeTime() const
Returns the time spent in Initialize().
Definition: Ifpack2_ILUT_def.hpp:346
bool isInitialized() const
Returns true if the preconditioner has been successfully initialized.
Definition: Ifpack2_ILUT_decl.hpp:200
Teuchos::RCP< const map_type > getDomainMap() const
Tpetra::Map representing the domain of this operator.
Definition: Ifpack2_ILUT_def.hpp:299
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
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.
void compute()
Compute factors L and U using the specified diagonal perturbation thresholds and relaxation parameter...
Definition: Ifpack2_ILUT_def.hpp:464
virtual void setMatrix(const Teuchos::RCP< const row_matrix_type > &A)
Change the matrix to be preconditioned.
Definition: Ifpack2_ILUT_def.hpp:387
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
magnitude_type getRelativeThreshold() const
Get relative threshold value.
Definition: Ifpack2_ILUT_decl.hpp:327
Teuchos::RCP< const row_matrix_type > getMatrix() const
Returns a reference to the matrix to be preconditioned.
Definition: Ifpack2_ILUT_def.hpp:292
std::string description() const
Return a simple one-line description of this object.
Definition: Ifpack2_ILUT_def.hpp:880
Definition: Ifpack2_Container.hpp:774
void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
Print the object with some verbosity level to an FancyOStream object.
Definition: Ifpack2_ILUT_def.hpp:913
double getComputeTime() const
Returns the time spent in Compute().
Definition: Ifpack2_ILUT_def.hpp:352
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
Teuchos::RCP< const Teuchos::Comm< int > > getComm() const
Returns the input matrix&#39;s communicator.
Definition: Ifpack2_ILUT_def.hpp:281
Teuchos::RCP< const crs_matrix_type > getU() const
Returns a reference to the U factor.
Definition: Ifpack2_ILUT_decl.hpp:286
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
Definition: Ifpack2_ILUT_def.hpp:364
void apply(const Tpetra::MultiVector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > &X, Tpetra::MultiVector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, scalar_type alpha=Teuchos::ScalarTraits< scalar_type >::one(), scalar_type beta=Teuchos::ScalarTraits< scalar_type >::zero()) const
Apply the ILUT preconditioner to X, resulting in Y.
Definition: Ifpack2_ILUT_def.hpp:810
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:72
double getApplyTime() const
Returns the time spent in apply().
Definition: Ifpack2_ILUT_def.hpp:358
int getLevelOfFill() const
The level of fill.
Definition: Ifpack2_ILUT_decl.hpp:317
void setParameters(const Teuchos::ParameterList &params)
Set preconditioner parameters.
Definition: Ifpack2_ILUT_def.hpp:148
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