Ifpack2_LocalFilter_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_LOCALFILTER_DECL_HPP
#define IFPACK2_LOCALFILTER_DECL_HPP
 
#include "Ifpack2_ConfigDefs.hpp"
#include "Ifpack2_Details_RowMatrix.hpp"
#include "Tpetra_CrsGraph.hpp"
#include <type_traits>
#include <vector>
 
namespace Ifpack2 {
 
template <class MatrixType>
class LocalFilter : virtual public Ifpack2::Details::RowMatrix<MatrixType>,
                    virtual public Teuchos::Describable {
 private:
  // Tpetra needs C++11 now because Kokkos needs C++11 now.
  // Thus, Ifpack2 needs C++11.
  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::LocalFilter: MatrixType must be a Tpetra::RowMatrix specialization.");
 
 public:
 
 
  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 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_type>::magnitudeType magnitude_type;
 
  typedef Tpetra::RowMatrix<scalar_type,
                            local_ordinal_type,
                            global_ordinal_type,
                            node_type>
      row_matrix_type;
 
  typedef Tpetra::RowGraph<local_ordinal_type,
                           global_ordinal_type,
                           node_type>
      row_graph_type;
 
  typedef Tpetra::Map<local_ordinal_type,
                      global_ordinal_type,
                      node_type>
      map_type;
 
  typedef typename row_matrix_type::mag_type mag_type;
 
 
 
  virtual std::string description() const;
 
  virtual void
  describe(Teuchos::FancyOStream &out,
           const Teuchos::EVerbosityLevel verbLevel =
               Teuchos::Describable::verbLevel_default) const;
 
 
 
  explicit LocalFilter(const Teuchos::RCP<const row_matrix_type> &A);
 
  virtual ~LocalFilter();
 
 
 
  virtual Teuchos::RCP<const Teuchos::Comm<int> > getComm() const;
 
  virtual Teuchos::RCP<const map_type> getRowMap() const;
 
  virtual Teuchos::RCP<const map_type> getColMap() const;
 
  virtual Teuchos::RCP<const map_type> getDomainMap() const;
 
  virtual Teuchos::RCP<const map_type> getRangeMap() const;
 
  virtual Teuchos::RCP<const Tpetra::RowGraph<local_ordinal_type, global_ordinal_type, node_type> >
  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 global_ordinal_type getIndexBase() const;
 
  virtual global_size_t getGlobalNumEntries() const;
 
  virtual size_t getLocalNumEntries() const;
 
  virtual local_ordinal_type getBlockSize() const;
 
  virtual size_t getNumEntriesInGlobalRow(global_ordinal_type globalRow) const;
 
  virtual size_t getNumEntriesInLocalRow(local_ordinal_type localRow) const;
 
  virtual size_t getGlobalMaxNumRowEntries() const;
 
  virtual size_t getLocalMaxNumRowEntries() const;
 
  virtual bool hasColMap() const;
 
  virtual bool isLocallyIndexed() const;
 
  virtual bool isGloballyIndexed() const;
 
  virtual bool isFillComplete() const;
 
  virtual bool supportsRowViews() const;
 
 
 
  virtual void
  getGlobalRowCopy(global_ordinal_type GlobalRow,
                   nonconst_global_inds_host_view_type &Indices,
                   nonconst_values_host_view_type &Values,
                   size_t &NumEntries) const;
 
  virtual void
  getLocalRowCopy(local_ordinal_type LocalRow,
                  nonconst_local_inds_host_view_type &Indices,
                  nonconst_values_host_view_type &Values,
                  size_t &NumEntries) const;
 
 
  virtual void
  getGlobalRowView(global_ordinal_type GlobalRow,
                   global_inds_host_view_type &indices,
                   values_host_view_type &values) const;
 
 
  virtual void
  getLocalRowView(local_ordinal_type LocalRow,
                  local_inds_host_view_type &indices,
                  values_host_view_type &values) const;
 
  virtual void
  getLocalDiagCopy(Tpetra::Vector<scalar_type, local_ordinal_type, global_ordinal_type, node_type> &diag) const;
 
 
 
  virtual void leftScale(const Tpetra::Vector<scalar_type, local_ordinal_type, global_ordinal_type, node_type> &x);
 
  virtual void rightScale(const Tpetra::Vector<scalar_type, local_ordinal_type, global_ordinal_type, node_type> &x);
 
  virtual mag_type getFrobeniusNorm() 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 bool hasTransposeApply() const;
 
  virtual Teuchos::RCP<const row_matrix_type> getUnderlyingMatrix() const;
 
 private:
  typedef Tpetra::CrsGraph<local_ordinal_type,
                           global_ordinal_type,
                           node_type>
      crs_graph_type;
 
  void
  applyNonAliased(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,
                  scalar_type alpha,
                  scalar_type beta) const;
 
  static bool
  mapPairIsFitted(const map_type &map1, const map_type &map2);
 
  // If both pairs of Maps of the original matrix A are fitted on this
  // process, then this process can use a fast "view" implementation.
  static bool
  mapPairsAreFitted(const row_matrix_type &A);
 
  Teuchos::RCP<const row_matrix_type> A_;
 
  Teuchos::RCP<const map_type> localRowMap_;
 
  Teuchos::RCP<const map_type> localDomainMap_;
 
  Teuchos::RCP<const map_type> localRangeMap_;
 
  mutable Teuchos::RCP<const row_graph_type> local_graph_;
 
  size_t NumNonzeros_;
  size_t MaxNumEntries_;
  size_t MaxNumEntriesA_;
  std::vector<size_t> NumEntries_;
 
  mutable nonconst_local_inds_host_view_type localIndices_;
  mutable nonconst_local_inds_host_view_type localIndicesForGlobalCopy_;
  mutable nonconst_values_host_view_type Values_;
 
};  // class LocalFilter
 
}  // namespace Ifpack2
 
#endif /* IFPACK2_LOCALFILTER_DECL_HPP */