Ifpack2 Templated Preconditioning Package  Version 1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Ifpack2_RILUK_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_CRSRILUK_DECL_HPP
47 #define IFPACK2_CRSRILUK_DECL_HPP
48 
51 #include "Tpetra_CrsMatrix_decl.hpp"
52 #include "Ifpack2_ScalingType.hpp"
53 #include "Ifpack2_IlukGraph.hpp"
54 #include "Ifpack2_LocalSparseTriangularSolver_decl.hpp"
55 
56 #include <type_traits>
57 
58 namespace Teuchos {
59  class ParameterList; // forward declaration
60 }
61 
62 namespace Ifpack2 {
63 
242 template<class MatrixType>
243 class RILUK:
244  virtual public Ifpack2::Preconditioner<typename MatrixType::scalar_type,
245  typename MatrixType::local_ordinal_type,
246  typename MatrixType::global_ordinal_type,
247  typename MatrixType::node_type>,
248  virtual public Ifpack2::Details::CanChangeMatrix<Tpetra::RowMatrix<typename MatrixType::scalar_type,
249  typename MatrixType::local_ordinal_type,
250  typename MatrixType::global_ordinal_type,
251  typename MatrixType::node_type> >
252 {
253  public:
255  typedef typename MatrixType::scalar_type scalar_type;
256 
258  typedef typename MatrixType::local_ordinal_type local_ordinal_type;
259 
261  typedef typename MatrixType::global_ordinal_type global_ordinal_type;
262 
264  typedef typename MatrixType::node_type node_type;
265 
268 
270  typedef Tpetra::RowMatrix<scalar_type,
274 
275 
276  static_assert(std::is_same<MatrixType, row_matrix_type>::value, "Ifpack2::RILUK: The template parameter MatrixType must be a Tpetra::RowMatrix specialization. Please don't use Tpetra::CrsMatrix (a subclass of Tpetra::RowMatrix) here anymore.");
277 
279  typedef Tpetra::CrsMatrix<scalar_type,
283 
284  template <class NewMatrixType> friend class RILUK;
285 
290 
299 
300  private:
303  RILUK (const RILUK<MatrixType> & src);
304 
305  public:
307  virtual ~RILUK ();
308 
317  void setParameters (const Teuchos::ParameterList& params);
318 
320  void initialize ();
321 
330  void compute ();
331 
333  bool isInitialized () const {
334  return isInitialized_;
335  }
337  bool isComputed () const {
338  return isComputed_;
339  }
340 
342  int getNumInitialize () const {
343  return numInitialize_;
344  }
346  int getNumCompute () const {
347  return numCompute_;
348  }
350  int getNumApply () const {
351  return numApply_;
352  }
353 
355  double getInitializeTime () const {
356  return initializeTime_;
357  }
359  double getComputeTime () const {
360  return computeTime_;
361  }
363  double getApplyTime () const {
364  return applyTime_;
365  }
366 
368  size_t getNodeSmootherComplexity() const;
369 
370 
371 
373 
374 
397  virtual void
399 
401 
403 
405  std::string description () const;
406 
408 
410 
413  getDomainMap () const;
414 
417  getRangeMap () const;
418 
448  void
449  apply (const Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& X,
450  Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& Y,
455 
456 private:
478  void
479  multiply (const Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& X,
480  Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& Y,
481  const Teuchos::ETransp mode = Teuchos::NO_TRANS) const;
482 public:
483 
486 
487  // Attribute access functions
488 
490  magnitude_type getRelaxValue () const { return RelaxValue_; }
491 
493  magnitude_type getAbsoluteThreshold () const { return Athresh_; }
494 
496  magnitude_type getRelativeThreshold () const {return Rthresh_;}
497 
499  int getLevelOfFill () const { return LevelOfFill_; }
500 
502  Tpetra::CombineMode getOverlapMode () {
504  true, std::logic_error, "Ifpack2::RILUK::SetOverlapMode: "
505  "RILUK no longer implements overlap on its own. "
506  "Use RILUK with AdditiveSchwarz if you want overlap.");
507  }
508 
510  Tpetra::global_size_t getGlobalNumEntries () const {
511  return getL ().getGlobalNumEntries () + getU ().getGlobalNumEntries ();
512  }
513 
516  return Graph_;
517  }
518 
520  const crs_matrix_type& getL () const;
521 
523  const Tpetra::Vector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>&
524  getD () const;
525 
527  const crs_matrix_type& getU () const;
528 
531 
532 private:
533  typedef Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type> MV;
536 
537  void allocateSolvers ();
538  void allocate_L_and_U ();
539  static void checkOrderingConsistency (const row_matrix_type& A);
540  void initAllValues (const row_matrix_type& A);
541 
548  makeLocalFilter (const Teuchos::RCP<const row_matrix_type>& A);
549 
550 protected:
551  typedef Tpetra::Vector<scalar_type,local_ordinal_type,global_ordinal_type,node_type> vec_type;
552 
555 
564 
575 
576  int LevelOfFill_;
577  double Overalloc_;
578 
579  bool isAllocated_;
580  bool isInitialized_;
581  bool isComputed_;
582 
583  int numInitialize_;
584  int numCompute_;
585  mutable int numApply_;
586 
587  double initializeTime_;
588  double computeTime_;
589  mutable double applyTime_;
590 
591  magnitude_type RelaxValue_;
592  magnitude_type Athresh_;
593  magnitude_type Rthresh_;
594 
595 };
596 
597 // NOTE (mfh 11 Feb 2015) This used to exist in order to deal with
598 // different behavior of Tpetra::Crs{Graph,Matrix} for
599 // KokkosClassic::ThrustGPUNode. In particular, fillComplete on a
600 // CrsMatrix used to make the graph go away by default, so we had to
601 // pass in a parameter to keep a host copy of the graph. With the new
602 // (Kokkos refactor) version of Tpetra, this problem has gone away.
603 namespace detail {
604  template<class MatrixType, class NodeType>
605  struct setLocalSolveParams{
607  setParams (const Teuchos::RCP<Teuchos::ParameterList>& param) {
608  return param;
609  }
610  };
611 } // namespace detail
612 
613 } // namespace Ifpack2
614 
615 #endif /* IFPACK2_CRSRILUK_DECL_HPP */
Mix-in interface for preconditioners that can change their matrix after construction.
Definition: Ifpack2_Details_CanChangeMatrix.hpp:93
Declaration and definition of IlukGraph.
magnitude_type getRelaxValue() const
Get RILU(k) relaxation parameter.
Definition: Ifpack2_RILUK_decl.hpp:490
magnitude_type getAbsoluteThreshold() const
Get absolute threshold value.
Definition: Ifpack2_RILUK_decl.hpp:493
Ifpack2::ScalingType enumerable type.
Teuchos::RCP< const Tpetra::Map< local_ordinal_type, global_ordinal_type, node_type > > getRangeMap() const
Returns the Tpetra::Map object associated with the range of this operator.
Definition: Ifpack2_RILUK_def.hpp:224
MatrixType::global_ordinal_type global_ordinal_type
The type of global indices in the input MatrixType.
Definition: Ifpack2_RILUK_decl.hpp:261
Teuchos::RCP< crs_matrix_type > L_
The L (lower triangular) factor of ILU(k).
Definition: Ifpack2_RILUK_decl.hpp:566
const Tpetra::Vector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > & getD() const
Return the diagonal entries of the ILU factorization.
Definition: Ifpack2_RILUK_def.hpp:160
void initialize()
Initialize by computing the symbolic incomplete factorization.
Definition: Ifpack2_RILUK_def.hpp:396
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Tpetra::RowMatrix< scalar_type, local_ordinal_type, global_ordinal_type, node_type > row_matrix_type
Tpetra::RowMatrix specialization used by this class.
Definition: Ifpack2_RILUK_decl.hpp:273
double getApplyTime() const
Total time in seconds taken by all successful apply() calls for this object.
Definition: Ifpack2_RILUK_decl.hpp:363
virtual void setMatrix(const Teuchos::RCP< const row_matrix_type > &A)
Change the matrix to be preconditioned.
Definition: Ifpack2_RILUK_def.hpp:107
std::string description() const
A one-line description of this object.
Definition: Ifpack2_RILUK_def.hpp:983
void setParameters(const Teuchos::ParameterList &params)
Definition: Ifpack2_RILUK_def.hpp:271
ILU(k) factorization of a given Tpetra::RowMatrix.
Definition: Ifpack2_RILUK_decl.hpp:243
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
Definition: Ifpack2_RILUK_def.hpp:187
Tpetra::CombineMode getOverlapMode()
Get overlap mode type.
Definition: Ifpack2_RILUK_decl.hpp:502
Teuchos::RCP< Ifpack2::IlukGraph< Tpetra::CrsGraph< local_ordinal_type, global_ordinal_type, node_type > > > getGraph() const
Return the Ifpack2::IlukGraph associated with this factored matrix.
Definition: Ifpack2_RILUK_decl.hpp:515
Teuchos::RCP< const crs_matrix_type > getCrsMatrix() const
Return the input matrix A as a Tpetra::CrsMatrix, if possible; else throws.
Definition: Ifpack2_RILUK_def.hpp:356
bool isComputed() const
Whether compute() has been called on this object.
Definition: Ifpack2_RILUK_decl.hpp:337
Tpetra::CrsMatrix< scalar_type, local_ordinal_type, global_ordinal_type, node_type > crs_matrix_type
Tpetra::CrsMatrix specialization used by this class for representing L and U.
Definition: Ifpack2_RILUK_decl.hpp:276
const crs_matrix_type & getU() const
Return the U factor of the ILU factorization.
Definition: Ifpack2_RILUK_def.hpp:174
MatrixType::node_type node_type
The Node type used by the input MatrixType.
Definition: Ifpack2_RILUK_decl.hpp:264
Teuchos::RCP< const Tpetra::Map< local_ordinal_type, global_ordinal_type, node_type > > getDomainMap() const
Returns the Tpetra::Map object associated with the domain of this operator.
Definition: Ifpack2_RILUK_def.hpp:205
MatrixType::local_ordinal_type local_ordinal_type
The type of local indices in the input MatrixType.
Definition: Ifpack2_RILUK_decl.hpp:258
virtual ~RILUK()
Destructor (declared virtual for memory safety).
Definition: Ifpack2_RILUK_def.hpp:96
Teuchos::RCP< LocalSparseTriangularSolver< row_matrix_type > > U_solver_
Sparse triangular solver for U.
Definition: Ifpack2_RILUK_decl.hpp:572
int getLevelOfFill() const
Get level of fill (the &quot;k&quot; in ILU(k)).
Definition: Ifpack2_RILUK_decl.hpp:499
Teuchos::RCP< Ifpack2::IlukGraph< Tpetra::CrsGraph< local_ordinal_type, global_ordinal_type, node_type > > > Graph_
The ILU(k) graph.
Definition: Ifpack2_RILUK_decl.hpp:559
Interface for all Ifpack2 preconditioners.
Definition: Ifpack2_Preconditioner.hpp:107
void compute()
Compute the (numeric) incomplete factorization.
Definition: Ifpack2_RILUK_def.hpp:653
magnitude_type getRelativeThreshold() const
Get relative threshold value.
Definition: Ifpack2_RILUK_decl.hpp:496
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 (inverse of the) incomplete factorization to X, resulting in Y.
Definition: Ifpack2_RILUK_def.hpp:835
Teuchos::ScalarTraits< scalar_type >::magnitudeType magnitude_type
The type of the magnitude (absolute value) of a matrix entry.
Definition: Ifpack2_RILUK_decl.hpp:267
Construct a level filled graph for use in computing an ILU(k) incomplete factorization.
Definition: Ifpack2_IlukGraph.hpp:97
Declaration of interface for preconditioners that can change their matrix after construction.
bool isInitialized() const
Whether initialize() has been called on this object.
Definition: Ifpack2_RILUK_decl.hpp:333
Teuchos::RCP< LocalSparseTriangularSolver< row_matrix_type > > L_solver_
Sparse triangular solver for L.
Definition: Ifpack2_RILUK_decl.hpp:568
Teuchos::RCP< const row_matrix_type > A_
The (original) input matrix for which to compute ILU(k).
Definition: Ifpack2_RILUK_decl.hpp:554
Teuchos::RCP< const row_matrix_type > getMatrix() const
Get the input matrix.
Definition: Ifpack2_RILUK_def.hpp:349
double getComputeTime() const
Total time in seconds taken by all successful compute() calls for this object.
Definition: Ifpack2_RILUK_decl.hpp:359
Teuchos::RCP< vec_type > D_
The diagonal entries of the ILU(k) factorization.
Definition: Ifpack2_RILUK_decl.hpp:574
int getNumCompute() const
Number of successful compute() calls for this object.
Definition: Ifpack2_RILUK_decl.hpp:346
int getNumApply() const
Number of successful apply() calls for this object.
Definition: Ifpack2_RILUK_decl.hpp:350
Tpetra::global_size_t getGlobalNumEntries() const
Returns the number of nonzero entries in the global graph.
Definition: Ifpack2_RILUK_decl.hpp:510
double getInitializeTime() const
Total time in seconds taken by all successful initialize() calls for this object. ...
Definition: Ifpack2_RILUK_decl.hpp:355
const crs_matrix_type & getL() const
Return the L factor of the ILU factorization.
Definition: Ifpack2_RILUK_def.hpp:143
Teuchos::RCP< const row_matrix_type > A_local_
The matrix whos numbers are used to to compute ILU(k). The graph may be computed using a crs_matrix_t...
Definition: Ifpack2_RILUK_decl.hpp:563
Teuchos::RCP< crs_matrix_type > U_
The U (upper triangular) factor of ILU(k).
Definition: Ifpack2_RILUK_decl.hpp:570
int getNumInitialize() const
Number of successful initialize() calls for this object.
Definition: Ifpack2_RILUK_decl.hpp:342
MatrixType::scalar_type scalar_type
The type of the entries of the input MatrixType.
Definition: Ifpack2_RILUK_decl.hpp:255