Ifpack2_Hiptmair_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_HIPTMAIR_DECL_HPP
#define IFPACK2_HIPTMAIR_DECL_HPP
 
#include "Ifpack2_Preconditioner.hpp"
#include "Tpetra_Map_fwd.hpp"
#include <type_traits>
 
namespace Teuchos {
class ParameterList;  // forward declaration
}
 
namespace Ifpack2 {
 
template <class MatrixType>
class Hiptmair : virtual public Ifpack2::Preconditioner<typename MatrixType::scalar_type,
                                                        typename MatrixType::local_ordinal_type,
                                                        typename MatrixType::global_ordinal_type,
                                                        typename MatrixType::node_type> {
 public:
  // \name Public typedefs
 
  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::Hiptmair: 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 Ifpack2::Preconditioner<scalar_type,
                                  local_ordinal_type,
                                  global_ordinal_type,
                                  node_type>
      prec_type;
 
  // \name Constructors and Destructors
 
  explicit Hiptmair(const Teuchos::RCP<const row_matrix_type>& A);
 
  explicit Hiptmair(const Teuchos::RCP<const row_matrix_type>& A,
                    const Teuchos::RCP<const row_matrix_type>& PtAP,
                    const Teuchos::RCP<const row_matrix_type>& P,
                    const Teuchos::RCP<const row_matrix_type>& Pt = Teuchos::null);
 
  virtual ~Hiptmair();
 
 
 
  void setParameters(const Teuchos::ParameterList& params);
 
  bool supportsZeroStartingSolution() { return true; }
 
  void setZeroStartingSolution(bool zeroStartingSolution) { ZeroStartingSolution_ = zeroStartingSolution; };
 
  void initialize();
 
  inline bool isInitialized() const {
    return IsInitialized_;
  }
 
  void compute();
 
  inline bool isComputed() const {
    return IsComputed_;
  }
 
 
 
  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
  applyHiptmairSmoother(const Tpetra::MultiVector<typename MatrixType::scalar_type,
                                                  typename MatrixType::local_ordinal_type,
                                                  typename MatrixType::global_ordinal_type,
                                                  typename MatrixType::node_type>& X,
                        Tpetra::MultiVector<typename MatrixType::scalar_type,
                                            typename MatrixType::local_ordinal_type,
                                            typename MatrixType::global_ordinal_type,
                                            typename MatrixType::node_type>& Y) const;
 
  void updateCachedMultiVectors(const Teuchos::RCP<const Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type>>& map1,
                                const Teuchos::RCP<const Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type>>& map2,
                                size_t numVecs) const;
 
  Teuchos::RCP<const Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type>> getDomainMap() const;
 
  Teuchos::RCP<const Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type>> getRangeMap() const;
 
  bool hasTransposeApply() const;
 
 
 
  Teuchos::RCP<const Teuchos::Comm<int>> getComm() const;
 
  Teuchos::RCP<const Tpetra::RowMatrix<scalar_type, local_ordinal_type, global_ordinal_type, node_type>> getMatrix() const;
 
  int getNumInitialize() const;
 
  int getNumCompute() const;
 
  int getNumApply() const;
 
  double getInitializeTime() const;
 
  double getComputeTime() const;
 
  double getApplyTime() const;
 
  Teuchos::RCP<Ifpack2::Preconditioner<typename MatrixType::scalar_type, typename MatrixType::local_ordinal_type, typename MatrixType::global_ordinal_type, typename MatrixType::node_type>> getPrec1();
 
  Teuchos::RCP<Ifpack2::Preconditioner<typename MatrixType::scalar_type, typename MatrixType::local_ordinal_type, typename MatrixType::global_ordinal_type, typename MatrixType::node_type>> getPrec2();
 
 
 
  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;
 
  Hiptmair(const Hiptmair<MatrixType>& RHS);
 
  Hiptmair<MatrixType>& operator=(const Hiptmair<MatrixType>& RHS);
 
  //  A - matrix in primary space
  //  PtAP - matrix in auxiliary space
  //  P  - prolongator matrix
  Teuchos::RCP<const row_matrix_type> A_, PtAP_, P_, Pt_;
 
  std::string precType1_, precType2_, preOrPost_;
 
  bool ZeroStartingSolution_;
 
  bool ImplicitTranspose_;
 
  Teuchos::ParameterList precList1_, precList2_;
 
  bool IsInitialized_;
  bool IsComputed_;
  int NumInitialize_;
  int NumCompute_;
  mutable int NumApply_;
  double InitializeTime_;
  double ComputeTime_;
  mutable double ApplyTime_;
  Teuchos::RCP<prec_type> ifpack2_prec1_, ifpack2_prec2_;
  mutable Teuchos::RCP<Tpetra::MultiVector<scalar_type, local_ordinal_type, global_ordinal_type, node_type>> cachedResidual1_;
  mutable Teuchos::RCP<Tpetra::MultiVector<scalar_type, local_ordinal_type, global_ordinal_type, node_type>> cachedSolution1_;
  mutable Teuchos::RCP<Tpetra::MultiVector<scalar_type, local_ordinal_type, global_ordinal_type, node_type>> cachedResidual2_;
  mutable Teuchos::RCP<Tpetra::MultiVector<scalar_type, local_ordinal_type, global_ordinal_type, node_type>> cachedSolution2_;
};
 
}  // namespace Ifpack2
 
#endif  // IFPACK2_HIPTMAIR_DECL_HPP