Ifpack2_AdditiveSchwarz_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_ADDITIVESCHWARZ_DECL_HPP
#define IFPACK2_ADDITIVESCHWARZ_DECL_HPP

#include "Ifpack2_ConfigDefs.hpp"
#include "Ifpack2_Preconditioner.hpp"
#include "Ifpack2_Details_CanChangeMatrix.hpp"
#include "Ifpack2_Details_NestedPreconditioner.hpp"
#include "Ifpack2_OverlappingRowMatrix.hpp"
#include "Tpetra_Map.hpp"
#include "Tpetra_MultiVector.hpp"
#include "Tpetra_RowMatrix.hpp"
#include <memory>
#include <type_traits>

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

namespace Ifpack2 {

template <class MatrixType,
          class LocalInverseType =
              Preconditioner<typename MatrixType::scalar_type,
                             typename MatrixType::local_ordinal_type,
                             typename MatrixType::global_ordinal_type,
                             typename MatrixType::node_type>>
class AdditiveSchwarz : virtual public Preconditioner<typename MatrixType::scalar_type,
                                                      typename MatrixType::local_ordinal_type,
                                                      typename MatrixType::global_ordinal_type,
                                                      typename MatrixType::node_type>,
                        virtual public Details::CanChangeMatrix<Tpetra::RowMatrix<typename MatrixType::scalar_type,
                                                                                  typename MatrixType::local_ordinal_type,
                                                                                  typename MatrixType::global_ordinal_type,
                                                                                  typename MatrixType::node_type>>,
                        virtual public Details::NestedPreconditioner<Preconditioner<typename MatrixType::scalar_type,
                                                                                    typename MatrixType::local_ordinal_type,
                                                                                    typename MatrixType::global_ordinal_type,
                                                                                    typename MatrixType::node_type>> {
 public:
  static_assert(std::is_same<LocalInverseType,
                             Preconditioner<typename MatrixType::scalar_type,
                                            typename MatrixType::local_ordinal_type,
                                            typename MatrixType::global_ordinal_type,
                                            typename MatrixType::node_type>>::value,
                "Ifpack2::AdditiveSchwarz: You are not allowed to use nondefault values for the LocalInverseType template parameter.  Please stop specifying this explicitly.  The default template parameter is perfectly fine.");

  static_assert(std::is_same<MatrixType,
                             Tpetra::RowMatrix<typename MatrixType::scalar_type,
                                               typename MatrixType::local_ordinal_type,
                                               typename MatrixType::global_ordinal_type,
                                               typename MatrixType::node_type>>::value,
                "Ifpack2::AdditiveSchwarz: Please use MatrixType = Tpetra::RowMatrix instead of MatrixType = Tpetra::CrsMatrix.  Don't worry, AdditiveSchwarz's constructor can take either type of matrix; it does a dynamic cast if necessary inside.  Restricting the set of allowed types here will improve build times and reduce library and executable sizes.");



  using scalar_type = typename MatrixType::scalar_type;

  using local_ordinal_type = typename MatrixType::local_ordinal_type;

  using global_ordinal_type = typename MatrixType::global_ordinal_type;

  using node_type = typename MatrixType::node_type;

  using magnitude_type =
      typename Teuchos::ScalarTraits<scalar_type>::magnitudeType;

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

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

  // \name Constructors and destructor

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

  AdditiveSchwarz(const Teuchos::RCP<const row_matrix_type>& A,
                  const int overlapLevel);

  virtual ~AdditiveSchwarz() = default;



  virtual Teuchos::RCP<const Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type>> getDomainMap() const;

  virtual Teuchos::RCP<const Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type>> getRangeMap() const;

  virtual 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;



  virtual void
  setInnerPreconditioner(const Teuchos::RCP<Preconditioner<scalar_type,
                                                           local_ordinal_type,
                                                           global_ordinal_type,
                                                           node_type>>& innerPrec);



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

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

  virtual void setParameters(const Teuchos::ParameterList& plist);

  void
  setParameterList(const Teuchos::RCP<Teuchos::ParameterList>& plist);

  bool supportsZeroStartingSolution() { return true; }

  void setZeroStartingSolution(bool zeroStartingSolution) { ZeroStartingSolution_ = zeroStartingSolution; };

  Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;

  virtual void initialize();

  virtual bool isInitialized() const;

  virtual void compute();

  virtual bool isComputed() const;

  virtual int getNumInitialize() const;

  virtual int getNumCompute() const;

  virtual int getNumApply() const;

  virtual double getInitializeTime() const;

  virtual double getComputeTime() const;

  virtual double getApplyTime() const;



  std::string description() const;

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


  virtual std::ostream& print(std::ostream& os) const;

  virtual int getOverlapLevel() const;

 private:
  typedef Tpetra::Map<local_ordinal_type,
                      global_ordinal_type,
                      node_type>
      map_type;
  typedef Tpetra::Import<local_ordinal_type,
                         global_ordinal_type,
                         node_type>
      import_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;
  typedef Preconditioner<scalar_type,
                         local_ordinal_type,
                         global_ordinal_type,
                         node_type>
      prec_type;

  typedef Trilinos::Details::LinearSolver<MV, OP, typename MV::mag_type> inner_solver_type;

  AdditiveSchwarz(const AdditiveSchwarz& RHS);

  void setup();

  void localApply(MV& OverlappingX, MV& OverlappingY) const;

  bool hasInnerPrecName() const;

  std::string innerPrecName() const;

  void removeInnerPrecName();

  std::pair<Teuchos::ParameterList, bool> innerPrecParams() const;

  void removeInnerPrecParams();

  static std::string defaultInnerPrecName();

  Teuchos::RCP<const row_matrix_type> Matrix_;

  Teuchos::RCP<OverlappingRowMatrix<row_matrix_type>> OverlappingMatrix_;

  Teuchos::RCP<row_matrix_type> ReorderedLocalizedMatrix_;

  Teuchos::RCP<row_matrix_type> innerMatrix_;

  bool IsInitialized_ = false;
  bool IsComputed_ = false;
  bool IsOverlapping_ = false;
  int OverlapLevel_ = 0;

  Teuchos::ParameterList List_;

  mutable Teuchos::RCP<const Teuchos::ParameterList> validParams_;

  Tpetra::CombineMode CombineMode_ = Tpetra::ZERO;
  bool AvgOverlap_                 = false;
  bool UseReordering_ = false;
  std::string ReorderingAlgorithm_ = "none";
  bool FilterSingletons_ = false;
  Teuchos::RCP<row_matrix_type> SingletonMatrix_;
  int NumIterations_ = 1;
  bool ZeroStartingSolution_ = true;
  scalar_type UpdateDamping_ = Teuchos::ScalarTraits<scalar_type>::one();

  int NumInitialize_ = 0;
  int NumCompute_ = 0;
  mutable int NumApply_ = 0;
  double InitializeTime_ = 0.0;
  double ComputeTime_ = 0.0;
  mutable double ApplyTime_ = 0.0;
  double InitializeFlops_ = 0.0;
  double ComputeFlops_ = 0.0;
  mutable double ApplyFlops_ = 0.0;
  Teuchos::RCP<inner_solver_type> Inverse_;
  Teuchos::RCP<const map_type> localMap_;
  mutable std::unique_ptr<MV> overlapping_B_;
  mutable std::unique_ptr<MV> overlapping_Y_;
  mutable std::unique_ptr<MV> reduced_reordered_B_;
  mutable std::unique_ptr<MV> reduced_reordered_Y_;
  mutable std::unique_ptr<MV> reduced_B_;
  mutable std::unique_ptr<MV> reduced_Y_;
  mutable std::unique_ptr<MV> reordered_B_;
  mutable std::unique_ptr<MV> reordered_Y_;
  mutable std::unique_ptr<MV> num_overlap_copies_;
  mutable std::unique_ptr<MV> R_;
  mutable std::unique_ptr<MV> C_;

  mutable Teuchos::RCP<const import_type> DistributedImporter_;
};  // class AdditiveSchwarz

}  // namespace Ifpack2

#endif  // IFPACK2_ADDITIVESCHWARZ_DECL_HPP