Ifpack2 Templated Preconditioning Package  Version 1.0
Ifpack2_LocalSparseTriangularSolver_decl.hpp
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 
43 #ifndef IFPACK2_LOCALSPARSETRIANGULARSOLVER_DECL_HPP
44 #define IFPACK2_LOCALSPARSETRIANGULARSOLVER_DECL_HPP
45 
48 #include "Tpetra_CrsMatrix_fwd.hpp"
49 #include "Teuchos_FancyOStream.hpp"
50 #include <type_traits>
51 
52 namespace Ifpack2 {
53 
76 template<class MatrixType>
78  virtual public Ifpack2::Preconditioner<typename MatrixType::scalar_type,
79  typename MatrixType::local_ordinal_type,
80  typename MatrixType::global_ordinal_type,
81  typename MatrixType::node_type>,
82  virtual public Ifpack2::Details::CanChangeMatrix<Tpetra::RowMatrix<typename MatrixType::scalar_type,
83  typename MatrixType::local_ordinal_type,
84  typename MatrixType::global_ordinal_type,
85  typename MatrixType::node_type> >
86 {
87 public:
89  typedef typename MatrixType::scalar_type scalar_type;
91  typedef typename MatrixType::local_ordinal_type local_ordinal_type;
93  typedef typename MatrixType::global_ordinal_type global_ordinal_type;
95  typedef typename MatrixType::node_type node_type;
96 
98  typedef typename MatrixType::mag_type magnitude_type;
100  typedef Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> map_type;
102  typedef Tpetra::RowMatrix<scalar_type, local_ordinal_type,
105  typedef Tpetra::CrsMatrix<scalar_type, local_ordinal_type,
107 
108  static_assert (std::is_same<MatrixType, row_matrix_type>::value,
109  "Ifpack2::LocalSparseTriangularSolver: The template parameter "
110  "MatrixType must be a Tpetra::RowMatrix specialization. "
111  "Please don't use Tpetra::CrsMatrix (a subclass of "
112  "Tpetra::RowMatrix) here anymore. The constructor can take "
113  "either a RowMatrix or a CrsMatrix just fine.");
114 
142  LocalSparseTriangularSolver (const Teuchos::RCP<const row_matrix_type>& A);
143 
152  LocalSparseTriangularSolver (const Teuchos::RCP<const row_matrix_type>& A,
153  const Teuchos::RCP<Teuchos::FancyOStream>& out);
154 
159 
171  LocalSparseTriangularSolver (const bool /* unused */, const Teuchos::RCP<Teuchos::FancyOStream>& out);
172 
174  virtual ~LocalSparseTriangularSolver ();
175 
188  void setParameters (const Teuchos::ParameterList& params);
189 
195  void initialize ();
196 
198  inline bool isInitialized () const {
199  return isInitialized_;
200  }
201 
206  void compute ();
207 
209  inline bool isComputed () const {
210  return isComputed_;
211  }
212 
214 
215 
231  void
232  apply (const Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& X,
233  Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& Y,
234  Teuchos::ETransp mode = Teuchos::NO_TRANS,
235  scalar_type alpha = Teuchos::ScalarTraits<scalar_type>::one (),
236  scalar_type beta = Teuchos::ScalarTraits<scalar_type>::zero ()) const;
237 
239  Teuchos::RCP<const map_type> getDomainMap () const;
240 
242  Teuchos::RCP<const map_type> getRangeMap () const;
243 
252  void
253  applyMat (const Tpetra::MultiVector<scalar_type, local_ordinal_type,
255  Tpetra::MultiVector<scalar_type, local_ordinal_type,
257  Teuchos::ETransp mode = Teuchos::NO_TRANS) const;
258 
260  Teuchos::RCP<const Teuchos::Comm<int> > getComm () const;
261 
263  Teuchos::RCP<const row_matrix_type> getMatrix () const {
264  return A_;
265  }
266 
268  double getComputeFlops () const;
269 
271  double getApplyFlops () const;
272 
274  int getNumInitialize () const;
275 
277  int getNumCompute () const;
278 
280  int getNumApply () const;
281 
283  double getInitializeTime () const;
284 
286  double getComputeTime () const;
287 
289  double getApplyTime () const;
290 
292 
294 
296  std::string description() const;
297 
319  void
320  describe (Teuchos::FancyOStream& out,
321  const Teuchos::EVerbosityLevel verbLevel =
322  Teuchos::Describable::verbLevel_default) const;
323 
328  virtual void setMatrix (const Teuchos::RCP<const row_matrix_type>& A);
329 
331 
332 private:
334  Teuchos::RCP<const row_matrix_type> A_;
336  Teuchos::RCP<Teuchos::FancyOStream> out_;
338  Teuchos::RCP<const crs_matrix_type> A_crs_;
339 
340  typedef Tpetra::MultiVector<scalar_type, local_ordinal_type, global_ordinal_type, node_type> MV;
341  mutable Teuchos::RCP<MV> X_colMap_;
342  mutable Teuchos::RCP<MV> Y_rowMap_;
343 
344  bool isInitialized_;
345  bool isComputed_;
355  bool isInternallyChanged_;
356  bool reverseStorage_;
357 
358  mutable int numInitialize_;
359  mutable int numCompute_;
360  mutable int numApply_;
361 
362  double initializeTime_;
363  double computeTime_;
364  double applyTime_;
365 
367  class HtsImpl;
368  Teuchos::RCP<HtsImpl> htsImpl_;
369 
373  std::string uplo_;
376  std::string diag_;
377 
396  void
397  localApply (const MV& X,
398  MV& Y,
399  const Teuchos::ETransp mode,
400  const scalar_type& alpha,
401  const scalar_type& beta) const;
402 
404  void
405  localTriangularSolve (const MV& Y,
406  MV& X,
407  const Teuchos::ETransp mode) const;
408 
409  void initializeState();
410 };
411 
412 } // namespace Ifpack2
413 
414 #endif // IFPACK2_LOCALSPARSETRIANGULARSOLVER_DECL_HPP
Mix-in interface for preconditioners that can change their matrix after construction.
Definition: Ifpack2_Details_CanChangeMatrix.hpp:93
Teuchos::RCP< const row_matrix_type > getMatrix() const
The original input matrix.
Definition: Ifpack2_LocalSparseTriangularSolver_decl.hpp:263
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 preconditioner to X, and put the result in Y.
Definition: Ifpack2_LocalSparseTriangularSolver_def.hpp:545
bool isInitialized() const
Return true if the preconditioner has been successfully initialized.
Definition: Ifpack2_LocalSparseTriangularSolver_decl.hpp:198
int getNumInitialize() const
Return the number of calls to initialize().
Definition: Ifpack2_LocalSparseTriangularSolver_def.hpp:767
Teuchos::RCP< const map_type > getDomainMap() const
The domain of this operator.
Definition: Ifpack2_LocalSparseTriangularSolver_def.hpp:880
Teuchos::RCP< const map_type > getRangeMap() const
The range of this operator.
Definition: Ifpack2_LocalSparseTriangularSolver_def.hpp:893
int getNumCompute() const
Return the number of calls to compute().
Definition: Ifpack2_LocalSparseTriangularSolver_def.hpp:774
double getApplyTime() const
Return the time spent in apply().
Definition: Ifpack2_LocalSparseTriangularSolver_def.hpp:802
void compute()
"Numeric" phase of setup
Definition: Ifpack2_LocalSparseTriangularSolver_def.hpp:509
void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
Print this object with given verbosity to the given output stream.
Definition: Ifpack2_LocalSparseTriangularSolver_def.hpp:842
MatrixType::global_ordinal_type global_ordinal_type
Type of the global indices of the input matrix.
Definition: Ifpack2_LocalSparseTriangularSolver_decl.hpp:93
MatrixType::node_type node_type
Node type of the input matrix.
Definition: Ifpack2_LocalSparseTriangularSolver_decl.hpp:95
bool isComputed() const
Return true if compute() has been called.
Definition: Ifpack2_LocalSparseTriangularSolver_decl.hpp:209
double getComputeTime() const
Return the time spent in compute().
Definition: Ifpack2_LocalSparseTriangularSolver_def.hpp:795
int getNumApply() const
Return the number of calls to apply().
Definition: Ifpack2_LocalSparseTriangularSolver_def.hpp:781
double getComputeFlops() const
Return the number of flops in the computation phase.
"Preconditioner" that solves local sparse triangular systems.
Definition: Ifpack2_LocalSparseTriangularSolver_decl.hpp:77
void initialize()
"Symbolic" phase of setup
Definition: Ifpack2_LocalSparseTriangularSolver_def.hpp:361
Interface for all Ifpack2 preconditioners.
Definition: Ifpack2_Preconditioner.hpp:107
Tpetra::Map< local_ordinal_type, global_ordinal_type, node_type > map_type
Specialization of Tpetra::Map used by this class.
Definition: Ifpack2_LocalSparseTriangularSolver_decl.hpp:100
virtual void setMatrix(const Teuchos::RCP< const row_matrix_type > &A)
Set this preconditioner&#39;s matrix.
Definition: Ifpack2_LocalSparseTriangularSolver_def.hpp:905
Declaration of interface for preconditioners that can change their matrix after construction.
void applyMat(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) const
Apply the original input matrix.
double getInitializeTime() const
Return the time spent in initialize().
Definition: Ifpack2_LocalSparseTriangularSolver_def.hpp:788
double getApplyFlops() const
Return the number of flops for the application of the preconditioner.
MatrixType::local_ordinal_type local_ordinal_type
Type of the local indices of the input matrix.
Definition: Ifpack2_LocalSparseTriangularSolver_decl.hpp:91
Teuchos::RCP< const Teuchos::Comm< int > > getComm() const
This operator&#39;s communicator.
Tpetra::CrsMatrix< scalar_type, local_ordinal_type, global_ordinal_type, node_type > crs_matrix_type
Specialization of Tpetra::CrsMatrix used by this class.
Definition: Ifpack2_LocalSparseTriangularSolver_decl.hpp:106
void setParameters(const Teuchos::ParameterList &params)
Set this object&#39;s parameters.
Definition: Ifpack2_LocalSparseTriangularSolver_def.hpp:321
MatrixType::scalar_type scalar_type
Type of the entries of the input matrix.
Definition: Ifpack2_LocalSparseTriangularSolver_decl.hpp:89
std::string description() const
A one-line description of this object.
Definition: Ifpack2_LocalSparseTriangularSolver_def.hpp:809
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:73
MatrixType::mag_type magnitude_type
Type of the absolute value (magnitude) of a scalar_type value.
Definition: Ifpack2_LocalSparseTriangularSolver_decl.hpp:98
virtual ~LocalSparseTriangularSolver()
Destructor (virtual for memory safety).
Definition: Ifpack2_LocalSparseTriangularSolver_def.hpp:315
LocalSparseTriangularSolver()
Constructor that takes no input matrix.
Definition: Ifpack2_LocalSparseTriangularSolver_def.hpp:279
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_LocalSparseTriangularSolver_decl.hpp:103