Ifpack2_Chebyshev_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_CHEBYSHEV_DECL_HPP
#define IFPACK2_CHEBYSHEV_DECL_HPP

#include "Ifpack2_Preconditioner.hpp"
#include "Ifpack2_Details_CanChangeMatrix.hpp"

// FIXME (mfh 20 Nov 2013) We really shouldn't have to include this.
// We should handle the implementation by pointer instead of by value.
#include "Ifpack2_Details_Chebyshev.hpp"

// We only need the declaration here, and only for the method
// getCrsMatrix.  I would very much prefer that this method not exist.
// Furthermore, it is both unsafe (MatrixType need not be CrsMatrix)
// and completely redundant (just call getMatrix() and do the
// dynamic_cast yourself).
#include "Tpetra_CrsMatrix_decl.hpp"

#include <type_traits>

namespace Ifpack2 {

template <class MatrixType>
class Chebyshev : 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 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::device_type device_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::Chebyshev: MatrixType must be a Tpetra::RowMatrix "
                "specialization.  Don't use Tpetra::CrsMatrix here.");

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

  typedef Tpetra::Vector<scalar_type, local_ordinal_type,
                         global_ordinal_type, node_type>
      vector_type;

  // \name Constructors and destructors

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

  virtual ~Chebyshev();



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

  bool supportsZeroStartingSolution() { return true; }

  void setZeroStartingSolution(bool zeroStartingSolution);

  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;

  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;



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

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

  Teuchos::RCP<const Tpetra::CrsMatrix<scalar_type, local_ordinal_type, global_ordinal_type, node_type> >
  getCrsMatrix() const;

  double getComputeFlops() const;

  double getApplyFlops() const;

  int getNumInitialize() const;

  int getNumCompute() const;

  int getNumApply() const;

  double getInitializeTime() const;

  double getComputeTime() const;

  double getApplyTime() const;

  size_t getNodeSmootherComplexity() const;

  typename MatrixType::scalar_type getLambdaMaxForApply() const;



  std::string description() const;

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


 private:
  typedef Teuchos::ScalarTraits<typename MatrixType::scalar_type> STS;

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

  Chebyshev(const Chebyshev<MatrixType>&);

  Chebyshev<MatrixType>& operator=(const Chebyshev<MatrixType>&);

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



  mutable Details::Chebyshev<scalar_type, MV> impl_;

  bool IsInitialized_;
  bool IsComputed_;
  int NumInitialize_;
  int NumCompute_;
  bool TimerForApply_;
  mutable int NumApply_;
  double InitializeTime_;
  double ComputeTime_;
  mutable double ApplyTime_;
  double ComputeFlops_;
  mutable double ApplyFlops_;

};  // class Chebyshev

}  // namespace Ifpack2

#endif  // IFPACK2_CHEBYSHEV_DECL_HPP