Ifpack2_SparsityFilter_decl.hpp

// @HEADER
// *****************************************************************************
//       Ifpack2: Templated Object-Oriented Algebraic Preconditioner Package
//
// Copyright 2009 NTESS and the Ifpack2 contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER
 
#ifndef IFPACK2_SPARSITYFILTER_DECL_HPP
#define IFPACK2_SPARSITYFILTER_DECL_HPP
 
#include "Ifpack2_ConfigDefs.hpp"
#include "Ifpack2_Details_RowMatrix.hpp"
#include "Teuchos_ScalarTraits.hpp"
 
namespace Ifpack2 {
 
template <class MatrixType>
class SparsityFilter : virtual public Ifpack2::Details::RowMatrix<MatrixType> {
 public:
  typedef typename MatrixType::scalar_type Scalar;
  typedef typename MatrixType::local_ordinal_type LocalOrdinal;
  typedef typename MatrixType::global_ordinal_type GlobalOrdinal;
  typedef typename MatrixType::node_type Node;
  typedef typename MatrixType::global_inds_host_view_type global_inds_host_view_type;
  typedef typename MatrixType::local_inds_host_view_type local_inds_host_view_type;
  typedef typename MatrixType::values_host_view_type values_host_view_type;
 
  typedef typename MatrixType::nonconst_global_inds_host_view_type nonconst_global_inds_host_view_type;
  typedef typename MatrixType::nonconst_local_inds_host_view_type nonconst_local_inds_host_view_type;
  typedef typename MatrixType::nonconst_values_host_view_type nonconst_values_host_view_type;
 
  typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType magnitudeType;
  typedef Tpetra::RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> row_matrix_type;
  typedef typename row_matrix_type::mag_type mag_type;
 
  static_assert(std::is_same<MatrixType, row_matrix_type>::value, "Ifpack2::SparsityFilter: The template parameter MatrixType must be a Tpetra::RowMatrix specialization.  Please don't use Tpetra::CrsMatrix (a subclass of Tpetra::RowMatrix) here anymore.");
 
 
 
  explicit SparsityFilter(const Teuchos::RCP<const row_matrix_type> &Matrix,
                          size_t AllowedNumEntries,
                          LocalOrdinal AllowedBandwidth = -Teuchos::ScalarTraits<LocalOrdinal>::one());
  virtual ~SparsityFilter();
 
 
 
  virtual Teuchos::RCP<const Teuchos::Comm<int> > getComm() const;
 
  virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal, GlobalOrdinal, Node> > getRowMap() const;
 
  virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal, GlobalOrdinal, Node> > getColMap() const;
 
  virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal, GlobalOrdinal, Node> > getDomainMap() const;
 
  virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal, GlobalOrdinal, Node> > getRangeMap() const;
 
  virtual Teuchos::RCP<const Tpetra::RowGraph<LocalOrdinal, GlobalOrdinal, Node> > getGraph() const;
 
  virtual global_size_t getGlobalNumRows() const;
 
  virtual global_size_t getGlobalNumCols() const;
 
  virtual size_t getLocalNumRows() const;
 
  virtual size_t getLocalNumCols() const;
 
  virtual GlobalOrdinal getIndexBase() const;
 
  virtual global_size_t getGlobalNumEntries() const;
 
  virtual size_t getLocalNumEntries() const;
 
 
  virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const;
 
 
  virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const;
 
  virtual size_t getGlobalMaxNumRowEntries() const;
 
  virtual size_t getLocalMaxNumRowEntries() const;
 
  virtual LocalOrdinal getBlockSize() const;
 
  virtual bool hasColMap() const;
 
  virtual bool isLocallyIndexed() const;
 
  virtual bool isGloballyIndexed() const;
 
  virtual bool isFillComplete() const;
 
  virtual bool supportsRowViews() const;
 
 
 
 
 
  virtual void
  getGlobalRowCopy(GlobalOrdinal GlobalRow,
                   nonconst_global_inds_host_view_type &Indices,
                   nonconst_values_host_view_type &Values,
                   size_t &NumEntries) const;
 
 
  virtual void
  getLocalRowCopy(LocalOrdinal LocalRow,
                  nonconst_local_inds_host_view_type &Indices,
                  nonconst_values_host_view_type &Values,
                  size_t &NumEntries) const;
 
 
  virtual void
  getGlobalRowView(GlobalOrdinal GlobalRow,
                   global_inds_host_view_type &indices,
                   values_host_view_type &values) const;
 
 
  virtual void
  getLocalRowView(LocalOrdinal LocalRow,
                  local_inds_host_view_type &indices,
                  values_host_view_type &values) const;
 
 
  virtual void getLocalDiagCopy(Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &diag) const;
 
 
 
 
  virtual void leftScale(const Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &x);
 
  virtual void rightScale(const Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &x);
 
 
  virtual mag_type getFrobeniusNorm() const;
 
 
  virtual void apply(const Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &X,
                     Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &Y,
                     Teuchos::ETransp mode = Teuchos::NO_TRANS,
                     Scalar alpha          = Teuchos::ScalarTraits<Scalar>::one(),
                     Scalar beta           = Teuchos::ScalarTraits<Scalar>::zero()) const;
 
  virtual bool hasTransposeApply() const;
 
 private:
  Teuchos::RCP<const Tpetra::RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> > A_;
 
  size_t AllowedNumEntries_;
  LocalOrdinal AllowedBandwidth_;
  size_t NumRows_;
  size_t NumNonzeros_;
  size_t MaxNumEntries_;
  size_t MaxNumEntriesA_;
  std::vector<size_t> NumEntries_;
  mutable nonconst_local_inds_host_view_type Indices_;
  mutable nonconst_values_host_view_type Values_;
 
};  // class SparsityFilter
 
}  // namespace Ifpack2
 
#endif /* IFPACK2_SPARSITYFILTER_DECL_HPP */