46#ifndef IFPACK2_CRSRILUK_DECL_HPP
47#define IFPACK2_CRSRILUK_DECL_HPP
49#include "KokkosSparse_spiluk.hpp"
53#include "Tpetra_CrsMatrix_decl.hpp"
56#include "Ifpack2_LocalSparseTriangularSolver_decl.hpp"
244template<
class MatrixType>
247 typename MatrixType::local_ordinal_type,
248 typename MatrixType::global_ordinal_type,
249 typename MatrixType::node_type>,
251 typename MatrixType::local_ordinal_type,
252 typename MatrixType::global_ordinal_type,
253 typename MatrixType::node_type> >
269 typedef typename Teuchos::ScalarTraits<scalar_type>::magnitudeType
magnitude_type;
284 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.");
295 template <
class NewMatrixType>
friend class RILUK;
297 typedef typename crs_matrix_type::global_inds_host_view_type global_inds_host_view_type;
298 typedef typename crs_matrix_type::local_inds_host_view_type local_inds_host_view_type;
299 typedef typename crs_matrix_type::values_host_view_type values_host_view_type;
302 typedef typename crs_matrix_type::nonconst_global_inds_host_view_type nonconst_global_inds_host_view_type;
303 typedef typename crs_matrix_type::nonconst_local_inds_host_view_type nonconst_local_inds_host_view_type;
304 typedef typename crs_matrix_type::nonconst_values_host_view_type nonconst_values_host_view_type;
311 typedef typename crs_matrix_type::local_matrix_device_type local_matrix_device_type;
312 typedef typename local_matrix_device_type::StaticCrsGraphType::row_map_type lno_row_view_t;
313 typedef typename local_matrix_device_type::StaticCrsGraphType::entries_type lno_nonzero_view_t;
314 typedef typename local_matrix_device_type::values_type scalar_nonzero_view_t;
315 typedef typename local_matrix_device_type::StaticCrsGraphType::device_type::memory_space TemporaryMemorySpace;
316 typedef typename local_matrix_device_type::StaticCrsGraphType::device_type::memory_space PersistentMemorySpace;
317 typedef typename local_matrix_device_type::StaticCrsGraphType::device_type::execution_space HandleExecSpace;
318 typedef typename KokkosKernels::Experimental::KokkosKernelsHandle
319 <
typename lno_row_view_t::const_value_type,
typename lno_nonzero_view_t::const_value_type,
typename scalar_nonzero_view_t::value_type,
320 HandleExecSpace, TemporaryMemorySpace,PersistentMemorySpace > kk_handle_type;
325 RILUK (
const Teuchos::RCP<const row_matrix_type>& A_in);
334 RILUK (
const Teuchos::RCP<const crs_matrix_type>& A_in);
370 return isInitialized_;
379 return numInitialize_;
392 return initializeTime_;
434 setMatrix (
const Teuchos::RCP<const row_matrix_type>& A);
448 Teuchos::RCP<const Tpetra::Map<local_ordinal_type,global_ordinal_type,node_type> >
452 Teuchos::RCP<const Tpetra::Map<local_ordinal_type,global_ordinal_type,node_type> >
485 apply (
const Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& X,
486 Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& Y,
487 Teuchos::ETransp mode = Teuchos::NO_TRANS,
488 scalar_type alpha = Teuchos::ScalarTraits<scalar_type>::one (),
489 scalar_type beta = Teuchos::ScalarTraits<scalar_type>::zero ())
const;
515 multiply (
const Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& X,
516 Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& Y,
517 const Teuchos::ETransp mode = Teuchos::NO_TRANS)
const;
521 Teuchos::RCP<const row_matrix_type>
getMatrix ()
const;
539 TEUCHOS_TEST_FOR_EXCEPTION(
540 true, std::logic_error,
"Ifpack2::RILUK::SetOverlapMode: "
541 "RILUK no longer implements overlap on its own. "
542 "Use RILUK with AdditiveSchwarz if you want overlap.");
547 return getL ().getGlobalNumEntries () +
getU ().getGlobalNumEntries ();
561 const Tpetra::Vector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>&
568 Teuchos::RCP<const crs_matrix_type>
getCrsMatrix ()
const;
571 typedef Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type> MV;
572 typedef Teuchos::ScalarTraits<scalar_type> STS;
573 typedef Teuchos::ScalarTraits<magnitude_type> STM;
575 void allocateSolvers ();
576 void allocate_L_and_U ();
585 static Teuchos::RCP<const row_matrix_type>
586 makeLocalFilter (
const Teuchos::RCP<const row_matrix_type>& A);
589 typedef Tpetra::Vector<scalar_type,local_ordinal_type,global_ordinal_type,node_type> vec_type;
592 Teuchos::RCP<const row_matrix_type>
A_;
602 lno_row_view_t A_local_rowmap_;
603 lno_nonzero_view_t A_local_entries_;
604 scalar_nonzero_view_t A_local_values_;
607 Teuchos::RCP<crs_matrix_type>
L_;
609 Teuchos::RCP<LocalSparseTriangularSolver<row_matrix_type> >
L_solver_;
611 Teuchos::RCP<crs_matrix_type>
U_;
613 Teuchos::RCP<LocalSparseTriangularSolver<row_matrix_type> >
U_solver_;
616 Teuchos::RCP<vec_type>
D_;
627 mutable int numApply_;
629 double initializeTime_;
631 mutable double applyTime_;
639 Teuchos::RCP<kk_handle_type> KernelHandle_;
649 template<
class MatrixType,
class NodeType>
650 struct setLocalSolveParams{
651 static Teuchos::RCP<Teuchos::ParameterList>
652 setParams (
const Teuchos::RCP<Teuchos::ParameterList>& param) {
Declaration of interface for preconditioners that can change their matrix after construction.
Declaration and definition of IlukGraph.
Ifpack2::ScalingType enumerable type.
Mix-in interface for preconditioners that can change their matrix after construction.
Definition: Ifpack2_Details_CanChangeMatrix.hpp:93
Construct a level filled graph for use in computing an ILU(k) incomplete factorization.
Definition: Ifpack2_IlukGraph.hpp:100
Interface for all Ifpack2 preconditioners.
Definition: Ifpack2_Preconditioner.hpp:108
ILU(k) factorization of a given Tpetra::RowMatrix.
Definition: Ifpack2_RILUK_decl.hpp:254
crs_matrix_type::impl_scalar_type impl_scalar_type
Scalar type stored in Kokkos::Views (CrsMatrix and MultiVector)
Definition: Ifpack2_RILUK_decl.hpp:293
void initialize()
Initialize by computing the symbolic incomplete factorization.
Definition: Ifpack2_RILUK_def.hpp:455
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:290
virtual ~RILUK()
Destructor (declared virtual for memory safety).
Definition: Ifpack2_RILUK_def.hpp:121
double getApplyTime() const
Total time in seconds taken by all successful apply() calls for this object.
Definition: Ifpack2_RILUK_decl.hpp:399
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:989
Teuchos::ScalarTraits< scalar_type >::magnitudeType magnitude_type
The type of the magnitude (absolute value) of a matrix entry.
Definition: Ifpack2_RILUK_decl.hpp:269
double getComputeTime() const
Total time in seconds taken by all successful compute() calls for this object.
Definition: Ifpack2_RILUK_decl.hpp:395
int getNumApply() const
Number of successful apply() calls for this object.
Definition: Ifpack2_RILUK_decl.hpp:386
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:256
magnitude_type getRelaxValue() const
Get RILU(k) relaxation parameter.
Definition: Ifpack2_RILUK_decl.hpp:526
int getNumCompute() const
Number of successful compute() calls for this object.
Definition: Ifpack2_RILUK_decl.hpp:382
Teuchos::RCP< const row_matrix_type > A_
The (original) input matrix for which to compute ILU(k).
Definition: Ifpack2_RILUK_decl.hpp:592
Tpetra::CombineMode getOverlapMode()
Get overlap mode type.
Definition: Ifpack2_RILUK_decl.hpp:538
Teuchos::RCP< crs_matrix_type > U_
The U (upper triangular) factor of ILU(k).
Definition: Ifpack2_RILUK_decl.hpp:611
const crs_matrix_type & getU() const
Return the U factor of the ILU factorization.
Definition: Ifpack2_RILUK_def.hpp:207
std::string description() const
A one-line description of this object.
Definition: Ifpack2_RILUK_def.hpp:1180
Tpetra::global_size_t getGlobalNumEntries() const
Returns the number of nonzero entries in the global graph.
Definition: Ifpack2_RILUK_decl.hpp:546
virtual void setMatrix(const Teuchos::RCP< const row_matrix_type > &A)
Change the matrix to be preconditioned.
Definition: Ifpack2_RILUK_def.hpp:140
MatrixType::scalar_type scalar_type
The type of the entries of the input MatrixType.
Definition: Ifpack2_RILUK_decl.hpp:257
bool isComputed() const
Whether compute() has been called on this object.
Definition: Ifpack2_RILUK_decl.hpp:373
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:193
MatrixType::node_type node_type
The Node type used by the input MatrixType.
Definition: Ifpack2_RILUK_decl.hpp:266
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:601
Teuchos::RCP< const row_matrix_type > getMatrix() const
Get the input matrix.
Definition: Ifpack2_RILUK_def.hpp:408
magnitude_type getAbsoluteThreshold() const
Get absolute threshold value.
Definition: Ifpack2_RILUK_decl.hpp:529
Teuchos::RCP< LocalSparseTriangularSolver< row_matrix_type > > L_solver_
Sparse triangular solver for L.
Definition: Ifpack2_RILUK_decl.hpp:609
Teuchos::RCP< Ifpack2::IlukGraph< Tpetra::CrsGraph< local_ordinal_type, global_ordinal_type, node_type >, kk_handle_type > > Graph_
The ILU(k) graph.
Definition: Ifpack2_RILUK_decl.hpp:597
int getLevelOfFill() const
Get level of fill (the "k" in ILU(k)).
Definition: Ifpack2_RILUK_decl.hpp:535
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:415
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:237
void setParameters(const Teuchos::ParameterList ¶ms)
Definition: Ifpack2_RILUK_def.hpp:303
magnitude_type getRelativeThreshold() const
Get relative threshold value.
Definition: Ifpack2_RILUK_decl.hpp:532
int getNumInitialize() const
Number of successful initialize() calls for this object.
Definition: Ifpack2_RILUK_decl.hpp:378
MatrixType::local_ordinal_type local_ordinal_type
The type of local indices in the input MatrixType.
Definition: Ifpack2_RILUK_decl.hpp:260
Teuchos::RCP< crs_matrix_type > L_
The L (lower triangular) factor of ILU(k).
Definition: Ifpack2_RILUK_decl.hpp:607
MatrixType::global_ordinal_type global_ordinal_type
The type of global indices in the input MatrixType.
Definition: Ifpack2_RILUK_decl.hpp:263
const crs_matrix_type & getL() const
Return the L factor of the ILU factorization.
Definition: Ifpack2_RILUK_def.hpp:176
node_type::device_type device_type
The Kokkos device type of the input MatrixType.
Definition: Ifpack2_RILUK_decl.hpp:272
node_type::execution_space execution_space
The Kokkos execution space of the input MatrixType.
Definition: Ifpack2_RILUK_decl.hpp:275
Teuchos::RCP< LocalSparseTriangularSolver< row_matrix_type > > U_solver_
Sparse triangular solver for U.
Definition: Ifpack2_RILUK_decl.hpp:613
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
Definition: Ifpack2_RILUK_def.hpp:220
void compute()
Compute the (numeric) incomplete factorization.
Definition: Ifpack2_RILUK_def.hpp:728
Teuchos::RCP< vec_type > D_
The diagonal entries of the ILU(k) factorization.
Definition: Ifpack2_RILUK_decl.hpp:616
bool isKokkosKernelsSpiluk_
Optional KokkosKernels implementation.
Definition: Ifpack2_RILUK_decl.hpp:638
bool isInitialized() const
Whether initialize() has been called on this object.
Definition: Ifpack2_RILUK_decl.hpp:369
double getInitializeTime() const
Total time in seconds taken by all successful initialize() calls for this object.
Definition: Ifpack2_RILUK_decl.hpp:391
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:281
Teuchos::RCP< Ifpack2::IlukGraph< Tpetra::CrsGraph< local_ordinal_type, global_ordinal_type, node_type >, kk_handle_type > > getGraph() const
Return the Ifpack2::IlukGraph associated with this factored matrix.
Definition: Ifpack2_RILUK_decl.hpp:553
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:74