Ifpack2 Templated Preconditioning Package  Version 1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
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 
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 
191  void setParameters (const Teuchos::ParameterList& params);
192 
200  void initialize ();
201 
203  inline bool isInitialized() const {
204  return IsInitialized_;
205  }
206 
208 
215  void compute();
216 
218  inline bool isComputed() const {
219  return IsComputed_;
220  }
221 
223 
225 
248  virtual void
250 
252 
254 
259  void
260  apply (const Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& X,
261  Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& Y,
265 
268 
271 
273  bool hasTransposeApply() const;
274 
276 
278 
281 
284 
287 
290 
292  int getNumInitialize() const;
293 
295  int getNumCompute() const;
296 
298  int getNumApply() const;
299 
301  double getInitializeTime() const;
302 
304  double getComputeTime() const;
305 
307  double getApplyTime() const;
308 
310  size_t getNodeSmootherComplexity() const;
311 
312 
320  inline double getLevelOfFill() const {
321  return LevelOfFill_;
322  }
323 
326  return(Athresh_);
327  }
328 
331  return(Rthresh_);
332  }
333 
335  inline magnitude_type getRelaxValue() const {
336  return(RelaxValue_);
337  }
338 
341  return(DropTolerance_);
342  }
343 
345  global_size_t getGlobalNumEntries() const;
346 
348  size_t getNodeNumEntries() const;
349 
351 
353 
355  std::string description() const;
356 
359 
361 
362 private:
363  typedef Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type> MV;
366  typedef typename Teuchos::Array<local_ordinal_type>::size_type size_type;
367 
369  ILUT (const ILUT<MatrixType>& RHS);
370 
371  void allocateSolvers ();
372 
374  ILUT<MatrixType>& operator= (const ILUT<MatrixType>& RHS);
375 
387  makeLocalFilter (const Teuchos::RCP<const row_matrix_type>& A);
388 
389  // \name The matrix and its incomplete LU factors
391 
404 
406  // \name Parameters (set by setParameters())
408 
409  magnitude_type Athresh_;
410  magnitude_type Rthresh_;
411  magnitude_type RelaxValue_;
412  double LevelOfFill_;
413  magnitude_type DropTolerance_;
415 
417  // \name Other internal data
419 
421  double InitializeTime_;
423  double ComputeTime_;
425  mutable double ApplyTime_;
427  int NumInitialize_;
429  int NumCompute_;
431  mutable int NumApply_;
433  bool IsInitialized_;
435  bool IsComputed_;
437 }; // class ILUT
438 
439 } // namespace Ifpack2
440 
441 #endif /* IFPACK2_ILUT_HPP */
magnitude_type getDropTolerance() const
Gets the dropping tolerance.
Definition: Ifpack2_ILUT_decl.hpp:340
Mix-in interface for preconditioners that can change their matrix after construction.
Definition: Ifpack2_Details_CanChangeMatrix.hpp:93
ILUT(const Teuchos::RCP< const row_matrix_type > &A)
Constructor.
Definition: Ifpack2_ILUT_def.hpp:117
bool hasTransposeApply() const
Whether this object&#39;s apply() method can apply the transpose (or conjugate transpose, if applicable).
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:289
virtual ~ILUT()
Destructor.
Definition: Ifpack2_ILUT_def.hpp:137
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
global_size_t getGlobalNumEntries() const
Returns the number of nonzero entries in the global graph.
Definition: Ifpack2_ILUT_def.hpp:334
void initialize()
Clear any previously computed factors.
Definition: Ifpack2_ILUT_def.hpp:386
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:862
std::string description() const
Return a simple one-line description of this object.
Definition: Ifpack2_ILUT_def.hpp:829
double getLevelOfFill() const
The level of fill.
Definition: Ifpack2_ILUT_decl.hpp:320
ILUT (incomplete LU factorization with threshold) of a Tpetra sparse matrix.
Definition: Ifpack2_ILUT_decl.hpp:91
size_t getNodeNumEntries() const
Returns the number of nonzero entries in the local graph.
Definition: Ifpack2_ILUT_def.hpp:340
magnitude_type getRelaxValue() const
Get the relax value.
Definition: Ifpack2_ILUT_decl.hpp:335
Ordinal size_type
Teuchos::RCP< const map_type > getRangeMap() const
Tpetra::Map representing the range of this operator.
Definition: Ifpack2_ILUT_def.hpp:270
magnitude_type getRelativeThreshold() const
Get relative threshold value.
Definition: Ifpack2_ILUT_decl.hpp:330
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:325
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:423
virtual void setMatrix(const Teuchos::RCP< const row_matrix_type > &A)
Change the matrix to be preconditioned.
Definition: Ifpack2_ILUT_def.hpp:346
static const EVerbosityLevel verbLevel_default
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
int getNumInitialize() const
Returns the number of calls to Initialize().
Definition: Ifpack2_ILUT_def.hpp:287
double getApplyTime() const
Returns the time spent in apply().
Definition: Ifpack2_ILUT_def.hpp:317
Teuchos::RCP< const Teuchos::Comm< int > > getComm() const
Returns the input matrix&#39;s communicator.
Definition: Ifpack2_ILUT_def.hpp:240
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 map_type > getDomainMap() const
Tpetra::Map representing the domain of this operator.
Definition: Ifpack2_ILUT_def.hpp:258
bool isComputed() const
If compute() is completed, this query returns true, otherwise it returns false.
Definition: Ifpack2_ILUT_decl.hpp:218
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
Definition: Ifpack2_ILUT_def.hpp:323
double getInitializeTime() const
Returns the time spent in Initialize().
Definition: Ifpack2_ILUT_def.hpp:305
bool isInitialized() const
Returns true if the preconditioner has been successfully initialized.
Definition: Ifpack2_ILUT_decl.hpp:203
int getNumApply() const
Returns the number of calls to apply().
Definition: Ifpack2_ILUT_def.hpp:299
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:759
double getComputeTime() const
Returns the time spent in Compute().
Definition: Ifpack2_ILUT_def.hpp:311
void setParameters(const Teuchos::ParameterList &params)
Set preconditioner parameters.
Definition: Ifpack2_ILUT_def.hpp:175
int getNumCompute() const
Returns the number of calls to Compute().
Definition: Ifpack2_ILUT_def.hpp:293
Teuchos::RCP< const crs_matrix_type > getL() const
Returns a reference to the L factor.
Definition: Ifpack2_ILUT_decl.hpp:286
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
Teuchos::RCP< const row_matrix_type > getMatrix() const
Returns a reference to the matrix to be preconditioned.
Definition: Ifpack2_ILUT_def.hpp:251