46 #ifndef IFPACK2_CRSRILUK_DECL_HPP 47 #define IFPACK2_CRSRILUK_DECL_HPP 51 #include "Tpetra_CrsMatrix_decl.hpp" 54 #include "Ifpack2_LocalSparseTriangularSolver_decl.hpp" 56 #include <type_traits> 242 template<
class MatrixType>
245 typename MatrixType::local_ordinal_type,
246 typename MatrixType::global_ordinal_type,
247 typename MatrixType::node_type>,
249 typename MatrixType::local_ordinal_type,
250 typename MatrixType::global_ordinal_type,
251 typename MatrixType::node_type> >
267 typedef typename Teuchos::ScalarTraits<scalar_type>::magnitudeType
magnitude_type;
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.");
284 template <
class NewMatrixType>
friend class RILUK;
289 RILUK (
const Teuchos::RCP<const row_matrix_type>& A_in);
298 RILUK (
const Teuchos::RCP<const crs_matrix_type>& A_in);
311 template <
typename NewMatrixType>
312 Teuchos::RCP< RILUK< NewMatrixType > >
313 clone (
const Teuchos::RCP<const NewMatrixType>& A_newnode)
const;
342 return isInitialized_;
351 return numInitialize_;
364 return initializeTime_;
406 setMatrix (
const Teuchos::RCP<const row_matrix_type>& A);
420 Teuchos::RCP<const Tpetra::Map<local_ordinal_type,global_ordinal_type,node_type> >
424 Teuchos::RCP<const Tpetra::Map<local_ordinal_type,global_ordinal_type,node_type> >
457 apply (
const Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& X,
458 Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& Y,
459 Teuchos::ETransp mode = Teuchos::NO_TRANS,
460 scalar_type alpha = Teuchos::ScalarTraits<scalar_type>::one (),
461 scalar_type beta = Teuchos::ScalarTraits<scalar_type>::zero ())
const;
487 multiply (
const Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& X,
488 Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& Y,
489 const Teuchos::ETransp mode = Teuchos::NO_TRANS)
const;
493 Teuchos::RCP<const row_matrix_type>
getMatrix ()
const;
511 TEUCHOS_TEST_FOR_EXCEPTION(
512 true, std::logic_error,
"Ifpack2::RILUK::SetOverlapMode: " 513 "RILUK no longer implements overlap on its own. " 514 "Use RILUK with AdditiveSchwarz if you want overlap.");
519 return getL ().getGlobalNumEntries () +
getU ().getGlobalNumEntries ();
523 Teuchos::RCP<Ifpack2::IlukGraph<Tpetra::CrsGraph<local_ordinal_type,global_ordinal_type,node_type> > >
getGraph ()
const {
531 const Tpetra::Vector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>&
538 Teuchos::RCP<const crs_matrix_type>
getCrsMatrix ()
const;
541 typedef Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type> MV;
542 typedef Teuchos::ScalarTraits<scalar_type> STS;
543 typedef Teuchos::ScalarTraits<magnitude_type> STM;
545 void allocateSolvers ();
546 void allocate_L_and_U ();
555 static Teuchos::RCP<const row_matrix_type>
556 makeLocalFilter (
const Teuchos::RCP<const row_matrix_type>& A);
559 typedef Tpetra::Vector<scalar_type,local_ordinal_type,global_ordinal_type,node_type> vec_type;
562 Teuchos::RCP<const row_matrix_type>
A_;
574 Teuchos::RCP<crs_matrix_type>
L_;
576 Teuchos::RCP<LocalSparseTriangularSolver<row_matrix_type> >
L_solver_;
578 Teuchos::RCP<crs_matrix_type>
U_;
580 Teuchos::RCP<LocalSparseTriangularSolver<row_matrix_type> >
U_solver_;
582 Teuchos::RCP<vec_type>
D_;
592 mutable int numApply_;
594 double initializeTime_;
596 mutable double applyTime_;
611 template<
class MatrixType,
class NodeType>
612 struct setLocalSolveParams{
613 static Teuchos::RCP<Teuchos::ParameterList>
614 setParams (
const Teuchos::RCP<Teuchos::ParameterList>& param) {
620 template <
class MatrixType>
621 template <
typename NewMatrixType>
622 Teuchos::RCP<RILUK<NewMatrixType> >
624 clone (
const Teuchos::RCP<const NewMatrixType>& A_newnode)
const 626 using Teuchos::ParameterList;
630 typedef typename NewMatrixType::scalar_type new_scalar_type;
631 typedef typename NewMatrixType::local_ordinal_type new_local_ordinal_type;
632 typedef typename NewMatrixType::global_ordinal_type new_global_ordinal_type;
633 typedef typename NewMatrixType::node_type new_node_type;
634 typedef Tpetra::RowMatrix<new_scalar_type, new_local_ordinal_type,
635 new_global_ordinal_type, new_node_type> new_row_matrix_type;
638 RCP<new_riluk_type> new_riluk = rcp (
new new_riluk_type (A_newnode));
640 RCP<ParameterList> plClone = Teuchos::parameterList ();
641 plClone = detail::setLocalSolveParams<NewMatrixType, new_node_type>::setParams (plClone);
643 RCP<new_node_type> new_node = A_newnode->getNode ();
644 new_riluk->L_ = L_->clone (new_node, plClone);
645 new_riluk->U_ = U_->clone (new_node, plClone);
646 new_riluk->D_ = D_->clone (new_node);
648 new_riluk->LevelOfFill_ = LevelOfFill_;
650 new_riluk->isAllocated_ = isAllocated_;
651 new_riluk->isInitialized_ = isInitialized_;
652 new_riluk->isComputed_ = isComputed_;
654 new_riluk->numInitialize_ = numInitialize_;
655 new_riluk->numCompute_ = numCompute_;
656 new_riluk->numApply_ = numApply_;
658 new_riluk->RelaxValue_ = RelaxValue_;
659 new_riluk->Athresh_ = Athresh_;
660 new_riluk->Rthresh_ = Rthresh_;
Mix-in interface for preconditioners that can change their matrix after construction.
Definition: Ifpack2_Details_CanChangeMatrix.hpp:93
Declaration and definition of IlukGraph.
Ifpack2::ScalingType enumerable type.
double getComputeTime() const
Total time in seconds taken by all successful compute() calls for this object.
Definition: Ifpack2_RILUK_decl.hpp:367
int getNumApply() const
Number of successful apply() calls for this object.
Definition: Ifpack2_RILUK_decl.hpp:358
Ifpack2::Preconditioner< Tpetra::RowMatrix< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type > ::scalar_type, Tpetra::RowMatrix< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type > ::local_ordinal_type, Tpetra::RowMatrix< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type > ::global_ordinal_type, Tpetra::RowMatrix< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type > ::node_type >::magnitude_type Teuchos::ScalarTraits< Tpetra::RowMatrix< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type > ::scalar_type >::magnitudeType magnitude_type
The type of the magnitude (absolute value) of a matrix entry.
Definition: Ifpack2_Preconditioner.hpp:111
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:574
void initialize()
Initialize by computing the symbolic incomplete factorization.
Definition: Ifpack2_RILUK_def.hpp:471
Teuchos::RCP< const row_matrix_type > getMatrix() const
Get the input matrix.
Definition: Ifpack2_RILUK_def.hpp:424
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
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:431
virtual void setMatrix(const Teuchos::RCP< const row_matrix_type > &A)
Change the matrix to be preconditioned.
Definition: Ifpack2_RILUK_def.hpp:106
void setParameters(const Teuchos::ParameterList ¶ms)
Definition: Ifpack2_RILUK_def.hpp:270
ILU(k) factorization of a given Tpetra::RowMatrix.
Definition: Ifpack2_RILUK_decl.hpp:243
Tpetra::CombineMode getOverlapMode()
Get overlap mode type.
Definition: Ifpack2_RILUK_decl.hpp:510
bool isComputed() const
Whether compute() has been called on this object.
Definition: Ifpack2_RILUK_decl.hpp:345
double getApplyTime() const
Total time in seconds taken by all successful apply() calls for this object.
Definition: Ifpack2_RILUK_decl.hpp:371
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
magnitude_type getAbsoluteThreshold() const
Get absolute threshold value.
Definition: Ifpack2_RILUK_decl.hpp:501
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:523
MatrixType::node_type node_type
The Node type used by the input MatrixType.
Definition: Ifpack2_RILUK_decl.hpp:264
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:159
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:95
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
Definition: Ifpack2_RILUK_def.hpp:186
Teuchos::RCP< LocalSparseTriangularSolver< row_matrix_type > > U_solver_
Sparse triangular solver for U.
Definition: Ifpack2_RILUK_decl.hpp:580
int getNumCompute() const
Number of successful compute() calls for this object.
Definition: Ifpack2_RILUK_decl.hpp:354
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:204
magnitude_type getRelaxValue() const
Get RILU(k) relaxation parameter.
Definition: Ifpack2_RILUK_decl.hpp:498
Teuchos::RCP< Ifpack2::IlukGraph< Tpetra::CrsGraph< local_ordinal_type, global_ordinal_type, node_type > > > Graph_
The ILU(k) graph.
Definition: Ifpack2_RILUK_decl.hpp:567
Interface for all Ifpack2 preconditioners.
Definition: Ifpack2_Preconditioner.hpp:107
void compute()
Compute the (numeric) incomplete factorization.
Definition: Ifpack2_RILUK_def.hpp:722
const crs_matrix_type & getU() const
Return the U factor of the ILU factorization.
Definition: Ifpack2_RILUK_def.hpp:173
Teuchos::ScalarTraits< scalar_type >::magnitudeType magnitude_type
The type of the magnitude (absolute value) of a matrix entry.
Definition: Ifpack2_RILUK_decl.hpp:267
Teuchos::RCP< RILUK< NewMatrixType > > clone(const Teuchos::RCP< const NewMatrixType > &A_newnode) const
Clone preconditioner to a new node type.
Definition: Ifpack2_RILUK_decl.hpp:624
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.
Teuchos::RCP< LocalSparseTriangularSolver< row_matrix_type > > L_solver_
Sparse triangular solver for L.
Definition: Ifpack2_RILUK_decl.hpp:576
bool isInitialized() const
Whether initialize() has been called on this object.
Definition: Ifpack2_RILUK_decl.hpp:341
Teuchos::RCP< const row_matrix_type > A_
The (original) input matrix for which to compute ILU(k).
Definition: Ifpack2_RILUK_decl.hpp:562
Tpetra::global_size_t getGlobalNumEntries() const
Returns the number of nonzero entries in the global graph.
Definition: Ifpack2_RILUK_decl.hpp:518
Definition: Ifpack2_Container.hpp:774
Teuchos::RCP< vec_type > D_
The diagonal entries of the ILU(k) factorization.
Definition: Ifpack2_RILUK_decl.hpp:582
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:904
std::string description() const
A one-line description of this object.
Definition: Ifpack2_RILUK_def.hpp:1052
magnitude_type getRelativeThreshold() const
Get relative threshold value.
Definition: Ifpack2_RILUK_decl.hpp:504
int getNumInitialize() const
Number of successful initialize() calls for this object.
Definition: Ifpack2_RILUK_decl.hpp:350
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:72
int getLevelOfFill() const
Get level of fill (the "k" in ILU(k)).
Definition: Ifpack2_RILUK_decl.hpp:507
double getInitializeTime() const
Total time in seconds taken by all successful initialize() calls for this object. ...
Definition: Ifpack2_RILUK_decl.hpp:363
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:571
Teuchos::RCP< crs_matrix_type > U_
The U (upper triangular) factor of ILU(k).
Definition: Ifpack2_RILUK_decl.hpp:578
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:223
const crs_matrix_type & getL() const
Return the L factor of the ILU factorization.
Definition: Ifpack2_RILUK_def.hpp:142
MatrixType::scalar_type scalar_type
The type of the entries of the input MatrixType.
Definition: Ifpack2_RILUK_decl.hpp:255