Ifpack2_SparseContainer_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_SPARSECONTAINER_DECL_HPP
#define IFPACK2_SPARSECONTAINER_DECL_HPP


#include "Ifpack2_Container.hpp"
#include "Ifpack2_Details_MultiVectorLocalGatherScatter.hpp"
#include "Tpetra_MultiVector.hpp"
#include "Tpetra_Map.hpp"
#include "Tpetra_RowMatrix.hpp"
#include "Tpetra_CrsMatrix.hpp"
#include "Teuchos_ParameterList.hpp"
#include "Ifpack2_ILUT_decl.hpp"
#include <vector>
#ifdef HAVE_IFPACK2_AMESOS2
#include "Ifpack2_Details_Amesos2Wrapper.hpp"
#endif

namespace Ifpack2 {

template <typename MatrixType, typename InverseType>
class SparseContainer
  : public ContainerImpl<MatrixType, typename InverseType::scalar_type> {

 private:
  using matrix_type = MatrixType;
  using inverse_type = InverseType;

  using typename Container<MatrixType>::SC;
  using typename Container<MatrixType>::LO;
  using typename Container<MatrixType>::GO;
  using typename Container<MatrixType>::NO;

  using typename Container<MatrixType>::mv_type;
  using typename Container<MatrixType>::map_type;
  using typename Container<MatrixType>::vector_type;
  using typename Container<MatrixType>::import_type;

  using InverseScalar        = typename InverseType::scalar_type;
  using InverseLocalOrdinal  = typename InverseType::local_ordinal_type;
  using InverseGlobalOrdinal = typename InverseType::global_ordinal_type;
  using InverseNode          = typename InverseType::node_type;

  using typename ContainerImpl<MatrixType, InverseScalar>::block_crs_matrix_type;

  using inverse_mv_type = Tpetra::MultiVector<InverseScalar, InverseLocalOrdinal, InverseGlobalOrdinal, InverseNode>;
  using InverseCrs      = Tpetra::CrsMatrix<InverseScalar, InverseLocalOrdinal, InverseGlobalOrdinal, InverseNode>;
  using InverseMap      = typename Tpetra::Map<InverseLocalOrdinal, InverseGlobalOrdinal, InverseNode>;
  using InverseGraph    = typename InverseCrs::crs_graph_type;
  using typename Container<MatrixType>::HostView;
  using typename Container<MatrixType>::ConstHostView;
  using HostViewInverse = typename inverse_mv_type::dual_view_type::t_host;

  static_assert(std::is_same<MatrixType,
                             Tpetra::RowMatrix<SC, LO, GO, NO>>::value,
                "Ifpack2::SparseContainer: Please use MatrixType = Tpetra::RowMatrix.");

  using typename Container<MatrixType>::row_matrix_type;

 public:


  SparseContainer(const Teuchos::RCP<const row_matrix_type>& matrix,
                  const Teuchos::Array<Teuchos::Array<LO>>& partitions,
                  const Teuchos::RCP<const import_type>& importer,
                  bool pointIndexed);

  virtual ~SparseContainer();



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



  virtual void initialize();

  virtual void compute();

  void clearBlocks();

  virtual void
  apply(ConstHostView X,
        HostView Y,
        int blockIndex,
        Teuchos::ETransp mode = Teuchos::NO_TRANS,
        SC alpha              = Teuchos::ScalarTraits<SC>::one(),
        SC beta               = Teuchos::ScalarTraits<SC>::zero()) const;

  virtual void
  weightedApply(ConstHostView X,
                HostView Y,
                ConstHostView W,
                int blockIndex,
                Teuchos::ETransp mode = Teuchos::NO_TRANS,
                SC alpha              = Teuchos::ScalarTraits<SC>::one(),
                SC beta               = Teuchos::ScalarTraits<SC>::zero()) const;



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



  virtual std::string description() const;

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

  static std::string getName();

 private:
  SparseContainer(const SparseContainer<MatrixType, InverseType>& rhs);

  void extract();
  void extractGraph();
  void extractValues();

  void
  solveBlockMV(const inverse_mv_type& X,
               inverse_mv_type& Y,
               int blockIndex,
               Teuchos::ETransp mode,
               InverseScalar alpha,
               InverseScalar beta) const;

  std::vector<Teuchos::RCP<InverseCrs>> diagBlocks_;

  mutable std::vector<inverse_mv_type> invX;
  mutable std::vector<inverse_mv_type> invY;

  mutable Teuchos::Array<Teuchos::RCP<InverseType>> Inverses_;
  Teuchos::RCP<Teuchos::Comm<int>> localComm_;

  Teuchos::ParameterList List_;
};

}  // namespace Ifpack2

#endif  // IFPACK2_SPARSECONTAINER_HPP