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" 57 #include <type_traits> 74 template<
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> >
88 template<
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.");
129 typedef Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type>
map_type;
138 TriDiSolver (
const Teuchos::RCP<const row_matrix_type>& matrix);
166 apply (
const Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& X,
167 Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& Y,
168 Teuchos::ETransp mode = Teuchos::NO_TRANS,
169 scalar_type alpha = Teuchos::ScalarTraits<scalar_type>::one(),
170 scalar_type beta = Teuchos::ScalarTraits<scalar_type>::zero())
const;
206 Teuchos::RCP<const row_matrix_type>
getMatrix ()
const;
209 void setMatrix (
const Teuchos::RCP<const row_matrix_type>& A);
234 std::string description ()
const;
238 describe (Teuchos::FancyOStream &out,
239 const Teuchos::EVerbosityLevel verbLevel =
240 Teuchos::Describable::verbLevel_default)
const;
246 describeLocal (Teuchos::FancyOStream& out,
247 const Teuchos::EVerbosityLevel verbLevel)
const;
260 extract (Teuchos::SerialTriDiMatrix<int, scalar_type>& A_local_tridi,
273 factor (Teuchos::SerialTriDiMatrix<int, scalar_type>& A,
274 const Teuchos::ArrayView<int>& ipiv);
289 typedef Teuchos::ScalarTraits<scalar_type> STS;
300 applyImpl (
const MV& X,
302 const Teuchos::ETransp mode,
307 Teuchos::RCP<const row_matrix_type> A_;
310 Teuchos::RCP<const row_matrix_type> A_local_;
313 Teuchos::SerialTriDiMatrix<int, scalar_type> A_local_tridi_;
316 Teuchos::Array<int> ipiv_;
319 double initializeTime_;
325 mutable double applyTime_;
334 mutable int numApply_;
345 template<
class MatrixType>
348 typename MatrixType::local_ordinal_type,
349 typename MatrixType::global_ordinal_type,
350 typename MatrixType::node_type>,
352 typename MatrixType::local_ordinal_type,
353 typename MatrixType::global_ordinal_type,
354 typename MatrixType::node_type> >
363 typedef MatrixType matrix_type;
366 typedef typename MatrixType::scalar_type scalar_type;
369 typedef typename MatrixType::local_ordinal_type local_ordinal_type;
372 typedef typename MatrixType::global_ordinal_type global_ordinal_type;
375 typedef typename MatrixType::node_type node_type;
378 typedef typename Teuchos::ScalarTraits<scalar_type>::magnitudeType
magnitude_type;
381 typedef Tpetra::RowMatrix<scalar_type, local_ordinal_type, global_ordinal_type, node_type> row_matrix_type;
383 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.");
386 typedef Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> map_type;
395 TriDiSolver (
const Teuchos::RCP<const row_matrix_type>& matrix);
422 apply (
const Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& X,
423 Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& Y,
424 Teuchos::ETransp mode = Teuchos::NO_TRANS,
425 scalar_type alpha = Teuchos::ScalarTraits<scalar_type>::one(),
426 scalar_type beta = Teuchos::ScalarTraits<scalar_type>::zero())
const;
462 Teuchos::RCP<const row_matrix_type>
getMatrix ()
const;
465 void setMatrix (
const Teuchos::RCP<const row_matrix_type>& A);
490 std::string description ()
const;
494 describe (Teuchos::FancyOStream &out,
495 const Teuchos::EVerbosityLevel verbLevel =
496 Teuchos::Describable::verbLevel_default)
const;
499 describeLocal (Teuchos::FancyOStream& out,
500 const Teuchos::EVerbosityLevel verbLevel)
const;
505 typedef Tpetra::MultiVector<scalar_type, local_ordinal_type,
506 global_ordinal_type, node_type> MV;
512 #endif // IFPACK2_DETAILS_TRIDISOLVER_DECL_HPP 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.
Mix-in interface for preconditioners that can change their matrix after construction.
Definition: Ifpack2_Details_CanChangeMatrix.hpp:93
virtual int getNumApply() const=0
The number of calls to apply().
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.
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
"Preconditioner" that uses LAPACK's tridi LU.
Definition: Ifpack2_Details_TriDiSolver_decl.hpp:76
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< MatrixType::scalar_type >::magnitudeType magnitude_type
The type of the magnitude (absolute value) of a matrix entry.
Definition: Ifpack2_Preconditioner.hpp:111
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::scalar_type scalar_type
The type of entries in the input (global) matrix.
Definition: Ifpack2_Details_TriDiSolver_decl.hpp:109
virtual void compute()=0
Set up the numerical values in this preconditioner.
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.
Ifpack2 implementation details.
MatrixType matrix_type
The first template parameter of this class.
Definition: Ifpack2_Details_TriDiSolver_decl.hpp:106
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:126
virtual int getNumCompute() const=0
The number of calls to compute().
Interface for all Ifpack2 preconditioners.
Definition: Ifpack2_Preconditioner.hpp:107
virtual double getInitializeTime() const=0
The time (in seconds) spent in initialize().
virtual void initialize()=0
Set up the graph structure of this preconditioner.
Declaration of interface for preconditioners that can change their matrix after construction.
virtual bool isComputed() const=0
True if the preconditioner has been successfully computed, else false.
virtual int getNumInitialize() const=0
The number of calls to initialize().
virtual void setParameters(const Teuchos::ParameterList &List)=0
Set this preconditioner's parameters.
virtual double getComputeTime() const=0
The time (in seconds) spent in compute().
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:73
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 bool isInitialized() const=0
True if the preconditioner has been successfully initialized, else false.
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
virtual double getApplyTime() const=0
The time (in seconds) spent in apply().
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.