43#ifndef IFPACK2_DETAILS_TRIDISOLVER_DECL_HPP
44#define IFPACK2_DETAILS_TRIDISOLVER_DECL_HPP
49#include "Ifpack2_ConfigDefs.hpp"
52#include "Ifpack2_Details_LapackSupportsScalar.hpp"
53#include "Tpetra_RowMatrix.hpp"
54#include "Tpetra_Import_fwd.hpp"
55#include "Tpetra_Export_fwd.hpp"
56#include "Teuchos_SerialTriDiMatrix.hpp"
74template<
class MatrixType,
75 const bool stub = ! LapackSupportsScalar<typename MatrixType::scalar_type>::value>
78 typename MatrixType::local_ordinal_type,
79 typename MatrixType::global_ordinal_type,
80 typename MatrixType::node_type>,
82 typename MatrixType::local_ordinal_type,
83 typename MatrixType::global_ordinal_type,
84 typename MatrixType::node_type> >
88template<
class MatrixType>
91 typename MatrixType::local_ordinal_type,
92 typename MatrixType::global_ordinal_type,
93 typename MatrixType::node_type>,
95 typename MatrixType::local_ordinal_type,
96 typename MatrixType::global_ordinal_type,
97 typename MatrixType::node_type> >
121 typedef typename Teuchos::ScalarTraits<scalar_type>::magnitudeType
magnitude_type;
124 typedef Tpetra::RowMatrix<scalar_type, local_ordinal_type, global_ordinal_type, node_type>
row_matrix_type;
126 static_assert(std::is_same<MatrixType, row_matrix_type>::value,
"Ifpack2::Details::TriDiSolver: 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.");
128 typedef typename row_matrix_type::nonconst_global_inds_host_view_type nonconst_global_inds_host_view_type;
129 typedef typename row_matrix_type::nonconst_local_inds_host_view_type nonconst_local_inds_host_view_type;
130 typedef typename row_matrix_type::nonconst_values_host_view_type nonconst_values_host_view_type;
133 typedef Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type>
map_type;
142 TriDiSolver (
const Teuchos::RCP<const row_matrix_type>& matrix);
170 apply (
const Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& X,
171 Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& Y,
172 Teuchos::ETransp mode = Teuchos::NO_TRANS,
173 scalar_type alpha = Teuchos::ScalarTraits<scalar_type>::one(),
174 scalar_type beta = Teuchos::ScalarTraits<scalar_type>::zero())
const;
210 Teuchos::RCP<const row_matrix_type>
getMatrix ()
const;
213 void setMatrix (
const Teuchos::RCP<const row_matrix_type>& A);
238 std::string description ()
const;
242 describe (Teuchos::FancyOStream &out,
243 const Teuchos::EVerbosityLevel verbLevel =
244 Teuchos::Describable::verbLevel_default)
const;
250 describeLocal (Teuchos::FancyOStream& out,
251 const Teuchos::EVerbosityLevel verbLevel)
const;
264 extract (Teuchos::SerialTriDiMatrix<int, scalar_type>& A_local_tridi,
277 factor (Teuchos::SerialTriDiMatrix<int, scalar_type>& A,
278 const Teuchos::ArrayView<int>& ipiv);
293 typedef Teuchos::ScalarTraits<scalar_type> STS;
304 applyImpl (
const MV& X,
306 const Teuchos::ETransp mode,
311 Teuchos::RCP<const row_matrix_type> A_;
314 Teuchos::RCP<const row_matrix_type> A_local_;
317 Teuchos::SerialTriDiMatrix<int, scalar_type> A_local_tridi_;
320 Teuchos::Array<int> ipiv_;
323 double initializeTime_;
329 mutable double applyTime_;
338 mutable int numApply_;
349template<
class MatrixType>
352 typename MatrixType::local_ordinal_type,
353 typename MatrixType::global_ordinal_type,
354 typename MatrixType::node_type>,
356 typename MatrixType::local_ordinal_type,
357 typename MatrixType::global_ordinal_type,
358 typename MatrixType::node_type> >
367 typedef MatrixType matrix_type;
370 typedef typename MatrixType::scalar_type scalar_type;
373 typedef typename MatrixType::local_ordinal_type local_ordinal_type;
376 typedef typename MatrixType::global_ordinal_type global_ordinal_type;
379 typedef typename MatrixType::node_type node_type;
382 typedef typename Teuchos::ScalarTraits<scalar_type>::magnitudeType
magnitude_type;
385 typedef Tpetra::RowMatrix<scalar_type, local_ordinal_type, global_ordinal_type, node_type> row_matrix_type;
387 static_assert(std::is_same<MatrixType, row_matrix_type>::value,
"Ifpack2::Details::TriDiSolver: 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.");
390 typedef Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> map_type;
399 TriDiSolver (
const Teuchos::RCP<const row_matrix_type>& matrix);
426 apply (
const Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& X,
427 Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& Y,
428 Teuchos::ETransp mode = Teuchos::NO_TRANS,
429 scalar_type alpha = Teuchos::ScalarTraits<scalar_type>::one(),
430 scalar_type beta = Teuchos::ScalarTraits<scalar_type>::zero())
const;
466 Teuchos::RCP<const row_matrix_type>
getMatrix ()
const;
469 void setMatrix (
const Teuchos::RCP<const row_matrix_type>& A);
494 std::string description ()
const;
498 describe (Teuchos::FancyOStream &out,
499 const Teuchos::EVerbosityLevel verbLevel =
500 Teuchos::Describable::verbLevel_default)
const;
503 describeLocal (Teuchos::FancyOStream& out,
504 const Teuchos::EVerbosityLevel verbLevel)
const;
509 typedef Tpetra::MultiVector<scalar_type, local_ordinal_type,
510 global_ordinal_type, node_type> MV;
Declaration of interface for preconditioners that can change their matrix after construction.
Mix-in interface for preconditioners that can change their matrix after construction.
Definition: Ifpack2_Details_CanChangeMatrix.hpp:93
virtual void setMatrix(const Teuchos::RCP< const Tpetra::RowMatrix< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type > > &A)=0
Set the new matrix.
Tpetra::RowMatrix< scalar_type, local_ordinal_type, global_ordinal_type, node_type > row_matrix_type
Specialization of Tpetra::RowMatrix used by this class.
Definition: Ifpack2_Details_TriDiSolver_decl.hpp:124
MatrixType::global_ordinal_type global_ordinal_type
The type of global indices in the input (global) matrix.
Definition: Ifpack2_Details_TriDiSolver_decl.hpp:115
Teuchos::ScalarTraits< scalar_type >::magnitudeType magnitude_type
The type of the absolute value (magnitude) of a scalar_type.
Definition: Ifpack2_Details_TriDiSolver_decl.hpp:121
MatrixType::node_type node_type
The Node type of the input (global) matrix.
Definition: Ifpack2_Details_TriDiSolver_decl.hpp:118
MatrixType::local_ordinal_type local_ordinal_type
The type of local indices in the input (global) matrix.
Definition: Ifpack2_Details_TriDiSolver_decl.hpp:112
MatrixType matrix_type
The first template parameter of this class.
Definition: Ifpack2_Details_TriDiSolver_decl.hpp:106
MatrixType::scalar_type scalar_type
The type of entries in the input (global) matrix.
Definition: Ifpack2_Details_TriDiSolver_decl.hpp:109
Tpetra::Map< local_ordinal_type, global_ordinal_type, node_type > map_type
Specialization of Tpetra::Map used by this class.
Definition: Ifpack2_Details_TriDiSolver_decl.hpp:133
"Preconditioner" that uses LAPACK's tridi LU.
Definition: Ifpack2_Details_TriDiSolver_decl.hpp:85
Interface for all Ifpack2 preconditioners.
Definition: Ifpack2_Preconditioner.hpp:108
virtual double getComputeTime() const=0
The time (in seconds) spent in compute().
virtual bool isInitialized() const=0
True if the preconditioner has been successfully initialized, else false.
Teuchos::ScalarTraits< MatrixType::scalar_type >::magnitudeType magnitude_type
The type of the magnitude (absolute value) of a matrix entry.
Definition: Ifpack2_Preconditioner.hpp:111
virtual void compute()=0
Set up the numerical values in this preconditioner.
virtual int getNumCompute() const=0
The number of calls to compute().
virtual Teuchos::RCP< const Tpetra::RowMatrix< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type > > getMatrix() const=0
The input matrix given to the constructor.
virtual int getNumApply() const=0
The number of calls to apply().
virtual double getApplyTime() const=0
The time (in seconds) spent in apply().
virtual void setParameters(const Teuchos::ParameterList &List)=0
Set this preconditioner's parameters.
virtual void apply(const Tpetra::MultiVector< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type > &X, Tpetra::MultiVector< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, MatrixType::scalar_type alpha=Teuchos::ScalarTraits< MatrixType::scalar_type >::one(), MatrixType::scalar_type beta=Teuchos::ScalarTraits< MatrixType::scalar_type >::zero()) const=0
Apply the preconditioner to X, putting the result in Y.
virtual Teuchos::RCP< const Tpetra::Map< MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type > > getRangeMap() const=0
The range Map of this operator.
virtual Teuchos::RCP< const Tpetra::Map< MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type > > getDomainMap() const=0
The domain Map of this operator.
virtual bool isComputed() const=0
True if the preconditioner has been successfully computed, else false.
virtual void initialize()=0
Set up the graph structure of this preconditioner.
virtual double getInitializeTime() const=0
The time (in seconds) spent in initialize().
virtual int getNumInitialize() const=0
The number of calls to initialize().
Ifpack2 implementation details.
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:74