Ifpack2_Details_Amesos2Wrapper_decl.hpp

Go to the documentation of this file.

// @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_AMESOS2WRAPPER_DECL_HPP
#define IFPACK2_DETAILS_AMESOS2WRAPPER_DECL_HPP

#include "Ifpack2_ConfigDefs.hpp"

#ifdef HAVE_IFPACK2_AMESOS2

#include "Ifpack2_Preconditioner.hpp"
#include "Ifpack2_Details_CanChangeMatrix.hpp"
#include "Tpetra_CrsMatrix.hpp"
#include <type_traits>

namespace Teuchos {
// forward declaration
class ParameterList;
}  // namespace Teuchos

namespace Trilinos {
namespace Details {
template <class MV, class OP, class NormType>
class LinearSolver;  // forward declaration
}  // namespace Details
}  // namespace Trilinos

namespace Ifpack2 {
namespace Details {
template <class MatrixType>
class Amesos2Wrapper : virtual 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 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::Amesos2Wrapper: Please use MatrixType = Tpetra::RowMatrix.");

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

  typedef Tpetra::CrsMatrix<scalar_type,
                            local_ordinal_type,
                            global_ordinal_type,
                            node_type>
      crs_matrix_type;


  explicit Amesos2Wrapper(const Teuchos::RCP<const row_matrix_type>& A);

  virtual ~Amesos2Wrapper();



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

  void initialize();

  inline bool isInitialized() const {
    return IsInitialized_;
  }

  void compute();

  inline bool isComputed() const {
    return IsComputed_;
  }



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



  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;

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

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

  bool hasTransposeApply() const;



  Teuchos::RCP<const Teuchos::Comm<int> > getComm() const;

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

  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:
  typedef Teuchos::ScalarTraits<scalar_type> STS;
  typedef Teuchos::ScalarTraits<magnitude_type> STM;
  typedef typename Teuchos::Array<local_ordinal_type>::size_type size_type;

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

  Amesos2Wrapper(const Amesos2Wrapper<MatrixType>& RHS);

  Amesos2Wrapper<MatrixType>& operator=(const Amesos2Wrapper<MatrixType>& RHS);

  Teuchos::RCP<Trilinos::Details::LinearSolver<MV, OP, typename MV::mag_type> > solver_;

  static Teuchos::RCP<const row_matrix_type>
  makeLocalFilter(const Teuchos::RCP<const row_matrix_type>& A);

  // Teuchos::RCP<const MatrixType> A_;
  Teuchos::RCP<const row_matrix_type> A_;

  Teuchos::RCP<const crs_matrix_type> A_local_crs_;

  // \name Parameters (set by setParameters())

  Teuchos::RCP<const Teuchos::ParameterList> parameterList_;

  // \name Other internal data

  double InitializeTime_;
  double ComputeTime_;
  mutable double ApplyTime_;
  int NumInitialize_;
  int NumCompute_;
  mutable int NumApply_;
  bool IsInitialized_;
  bool IsComputed_;
  std::string SolverName_;
};  // class Amesos2Wrapper

}  // namespace Details
}  // namespace Ifpack2

#endif  // HAVE_IFPACK2_AMESOS2

#endif  // IFPACK2_DETAILS_AMESOS2WRAPPER_DECL_HPP