Ifpack2_Details_TriDiSolver_decl.hpp

// @HEADER
// *****************************************************************************
//       Ifpack2: Templated Object-Oriented Algebraic Preconditioner Package
//
// Copyright 2009 NTESS and the Ifpack2 contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef IFPACK2_DETAILS_TRIDISOLVER_DECL_HPP
#define IFPACK2_DETAILS_TRIDISOLVER_DECL_HPP


#include "Ifpack2_ConfigDefs.hpp"
#include "Ifpack2_Preconditioner.hpp"
#include "Ifpack2_Details_CanChangeMatrix.hpp"
#include "Ifpack2_Details_LapackSupportsScalar.hpp"
#include "Tpetra_RowMatrix.hpp"
#include "Tpetra_Import_fwd.hpp"
#include "Tpetra_Export_fwd.hpp"
#include "Teuchos_SerialTriDiMatrix.hpp"
#include <type_traits>

namespace Ifpack2 {
namespace Details {

template <class MatrixType,
          const bool stub = !LapackSupportsScalar<typename MatrixType::scalar_type>::value>
class TriDiSolver : public Ifpack2::Preconditioner<typename MatrixType::scalar_type,
                                                   typename MatrixType::local_ordinal_type,
                                                   typename MatrixType::global_ordinal_type,
                                                   typename MatrixType::node_type>,
                    virtual public Ifpack2::Details::CanChangeMatrix<Tpetra::RowMatrix<typename MatrixType::scalar_type,
                                                                                       typename MatrixType::local_ordinal_type,
                                                                                       typename MatrixType::global_ordinal_type,
                                                                                       typename MatrixType::node_type> > {};

template <class MatrixType>
class TriDiSolver<MatrixType, false> : public Ifpack2::Preconditioner<typename MatrixType::scalar_type,
                                                                      typename MatrixType::local_ordinal_type,
                                                                      typename MatrixType::global_ordinal_type,
                                                                      typename MatrixType::node_type>,
                                       virtual public Ifpack2::Details::CanChangeMatrix<Tpetra::RowMatrix<typename MatrixType::scalar_type,
                                                                                                          typename MatrixType::local_ordinal_type,
                                                                                                          typename MatrixType::global_ordinal_type,
                                                                                                          typename MatrixType::node_type> > {
 public:


  typedef MatrixType matrix_type;

  typedef typename MatrixType::scalar_type scalar_type;

  typedef typename MatrixType::local_ordinal_type local_ordinal_type;

  typedef typename MatrixType::global_ordinal_type global_ordinal_type;

  typedef typename MatrixType::node_type node_type;

  typedef typename Teuchos::ScalarTraits<scalar_type>::magnitudeType magnitude_type;

  typedef Tpetra::RowMatrix<scalar_type, local_ordinal_type, global_ordinal_type, node_type> row_matrix_type;

  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.");

  typedef typename row_matrix_type::nonconst_global_inds_host_view_type nonconst_global_inds_host_view_type;
  typedef typename row_matrix_type::nonconst_local_inds_host_view_type nonconst_local_inds_host_view_type;
  typedef typename row_matrix_type::nonconst_values_host_view_type nonconst_values_host_view_type;

  typedef Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> map_type;



  TriDiSolver(const Teuchos::RCP<const row_matrix_type>& matrix);

  virtual ~TriDiSolver();



  Teuchos::RCP<const map_type> getDomainMap() const;

  Teuchos::RCP<const map_type> getRangeMap() const;

  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;


  void setParameters(const Teuchos::ParameterList& params);

  void initialize();

  bool isInitialized() const;

  void compute();

  bool isComputed() const;

  Teuchos::RCP<const row_matrix_type> getMatrix() const;

  void setMatrix(const Teuchos::RCP<const row_matrix_type>& A);

  int getNumInitialize() const;

  int getNumCompute() const;

  int getNumApply() const;

  double getInitializeTime() const;

  double getComputeTime() const;

  double getApplyTime() const;



  std::string description() const;

  void
  describe(Teuchos::FancyOStream& out,
           const Teuchos::EVerbosityLevel verbLevel =
               Teuchos::Describable::verbLevel_default) const;
 private:
  void
  describeLocal(Teuchos::FancyOStream& out,
                const Teuchos::EVerbosityLevel verbLevel) const;

  void reset();

  static void
  extract(Teuchos::SerialTriDiMatrix<int, scalar_type>& A_local_tridi,
          const row_matrix_type& A_local);

  static void
  factor(Teuchos::SerialTriDiMatrix<int, scalar_type>& A,
         const Teuchos::ArrayView<int>& ipiv);

  typedef Tpetra::MultiVector<scalar_type, local_ordinal_type,
                              global_ordinal_type, node_type>
      MV;

  typedef Tpetra::Import<local_ordinal_type,
                         global_ordinal_type, node_type>
      import_type;

  typedef Tpetra::Export<local_ordinal_type,
                         global_ordinal_type, node_type>
      export_type;

  typedef Teuchos::ScalarTraits<scalar_type> STS;

  void
  applyImpl(const MV& X,
            MV& Y,
            const Teuchos::ETransp mode,
            const scalar_type alpha,
            const scalar_type beta) const;

  Teuchos::RCP<const row_matrix_type> A_;

  Teuchos::RCP<const row_matrix_type> A_local_;

  Teuchos::SerialTriDiMatrix<int, scalar_type> A_local_tridi_;

  Teuchos::Array<int> ipiv_;

  double initializeTime_;

  double computeTime_;

  mutable double applyTime_;

  int numInitialize_;

  int numCompute_;

  mutable int numApply_;

  bool isInitialized_;

  bool isComputed_;
};

template <class MatrixType>
class TriDiSolver<MatrixType, true> : public Ifpack2::Preconditioner<typename MatrixType::scalar_type,
                                                                     typename MatrixType::local_ordinal_type,
                                                                     typename MatrixType::global_ordinal_type,
                                                                     typename MatrixType::node_type>,
                                      virtual public Ifpack2::Details::CanChangeMatrix<Tpetra::RowMatrix<typename MatrixType::scalar_type,
                                                                                                         typename MatrixType::local_ordinal_type,
                                                                                                         typename MatrixType::global_ordinal_type,
                                                                                                         typename MatrixType::node_type> > {
 public:


  typedef MatrixType matrix_type;

  typedef typename MatrixType::scalar_type scalar_type;

  typedef typename MatrixType::local_ordinal_type local_ordinal_type;

  typedef typename MatrixType::global_ordinal_type global_ordinal_type;

  typedef typename MatrixType::node_type node_type;

  typedef typename Teuchos::ScalarTraits<scalar_type>::magnitudeType magnitude_type;

  typedef Tpetra::RowMatrix<scalar_type, local_ordinal_type, global_ordinal_type, node_type> row_matrix_type;

  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.");

  typedef Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> map_type;



  TriDiSolver(const Teuchos::RCP<const row_matrix_type>& matrix);

  virtual ~TriDiSolver();



  Teuchos::RCP<const map_type> getDomainMap() const;

  Teuchos::RCP<const map_type> getRangeMap() const;

  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;


  void setParameters(const Teuchos::ParameterList& params);

  void initialize();

  bool isInitialized() const;

  void compute();

  bool isComputed() const;

  Teuchos::RCP<const row_matrix_type> getMatrix() const;

  void setMatrix(const Teuchos::RCP<const row_matrix_type>& A);

  int getNumInitialize() const;

  int getNumCompute() const;

  int getNumApply() const;

  double getInitializeTime() const;

  double getComputeTime() const;

  double getApplyTime() const;



  std::string description() const;

  void
  describe(Teuchos::FancyOStream& out,
           const Teuchos::EVerbosityLevel verbLevel =
               Teuchos::Describable::verbLevel_default) const;

  void
  describeLocal(Teuchos::FancyOStream& out,
                const Teuchos::EVerbosityLevel verbLevel) const;

 private:
  typedef Tpetra::MultiVector<scalar_type, local_ordinal_type,
                              global_ordinal_type, node_type>
      MV;
};

}  // namespace Details
}  // namespace Ifpack2

#endif  // IFPACK2_DETAILS_TRIDISOLVER_DECL_HPP