Xpetra_Matrix_decl.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//             Xpetra: A linear algebra interface package
//
// Copyright 2012 NTESS and the Xpetra contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

// WARNING: This code is experimental. Backwards compatibility should not be expected.

#ifndef XPETRA_MATRIX_DECL_HPP
#define XPETRA_MATRIX_DECL_HPP

#include <Tpetra_KokkosCompat_DefaultNode.hpp>

#include "Xpetra_ConfigDefs.hpp"
#include "Xpetra_Exceptions.hpp"

#include "Xpetra_MultiVector.hpp"
#include "Xpetra_CrsGraph.hpp"
#include "Xpetra_CrsMatrix.hpp"
#include "Xpetra_CrsMatrixFactory.hpp"
#include "Xpetra_MatrixView.hpp"
#include "Xpetra_Operator.hpp"
#include "Xpetra_StridedMap.hpp"
#include "Xpetra_StridedMapFactory.hpp"

#include <Teuchos_SerialDenseMatrix.hpp>
#include <Teuchos_Hashtable.hpp>

namespace Xpetra {

typedef std::string viewLabel_t;

template <class Scalar,
          class LocalOrdinal,
          class GlobalOrdinal,
          class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
class Matrix : public Xpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
  typedef Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node> Map;
  typedef Xpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> CrsMatrix;
  typedef Xpetra::CrsGraph<LocalOrdinal, GlobalOrdinal, Node> CrsGraph;
  typedef Xpetra::CrsMatrixFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node> CrsMatrixFactory;
  typedef Xpetra::MatrixView<Scalar, LocalOrdinal, GlobalOrdinal, Node> MatrixView;

 public:
  typedef Scalar scalar_type;
  typedef LocalOrdinal local_ordinal_type;
  typedef GlobalOrdinal global_ordinal_type;
  typedef Node node_type;

#ifdef HAVE_XPETRA_TPETRA
  using local_matrix_type        = typename Xpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::local_matrix_type;
  using local_matrix_device_type = typename Xpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::local_matrix_device_type;
  using local_matrix_host_type   = typename Xpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::local_matrix_host_type;
#endif

#if KOKKOS_VERSION >= 40799
  using ATS = KokkosKernels::ArithTraits<Scalar>;
#else
  using ATS = Kokkos::ArithTraits<Scalar>;
#endif
  using impl_scalar_type = typename ATS::val_type;



  Matrix();

  virtual ~Matrix();



  void CreateView(viewLabel_t viewLabel, const RCP<const Map> &rowMap, const RCP<const Map> &colMap);

  // JG TODO: why this is a member function??
  void CreateView(const viewLabel_t viewLabel, const RCP<const Matrix> &A, bool transposeA = false, const RCP<const Matrix> &B = Teuchos::null, bool transposeB = false);

  void PrintViews(Teuchos::FancyOStream &out) const;

  void RemoveView(const viewLabel_t viewLabel);

  const viewLabel_t SwitchToView(const viewLabel_t viewLabel);

  bool IsView(const viewLabel_t viewLabel) const;

  const viewLabel_t SwitchToDefaultView();

  const viewLabel_t &GetDefaultViewLabel() const;

  const viewLabel_t &GetCurrentViewLabel() const;





  virtual void insertGlobalValues(GlobalOrdinal globalRow, const ArrayView<const GlobalOrdinal> &cols, const ArrayView<const Scalar> &vals) = 0;


  virtual void insertLocalValues(LocalOrdinal localRow, const ArrayView<const LocalOrdinal> &cols, const ArrayView<const Scalar> &vals) = 0;


  virtual void replaceGlobalValues(GlobalOrdinal globalRow,
                                   const ArrayView<const GlobalOrdinal> &cols,
                                   const ArrayView<const Scalar> &vals) = 0;


  virtual void replaceLocalValues(LocalOrdinal localRow,
                                  const ArrayView<const LocalOrdinal> &cols,
                                  const ArrayView<const Scalar> &vals) = 0;

  virtual void setAllToScalar(const Scalar &alpha) = 0;

  virtual void scale(const Scalar &alpha) = 0;




  virtual void resumeFill(const RCP<ParameterList> &params = null) = 0;

  virtual void fillComplete(const RCP<const Map> &domainMap, const RCP<const Map> &rangeMap, const RCP<ParameterList> &params = null) = 0;

  // TODO : Get ride of "Tpetra"::OptimizeOption
  virtual void fillComplete(const RCP<ParameterList> &params = null) = 0;




  virtual const RCP<const Map> &getRowMap() const;

  virtual const RCP<const Map> &getRowMap(viewLabel_t viewLabel) const;

  virtual const RCP<const Map> &getColMap() const;

  virtual const RCP<const Map> &getColMap(viewLabel_t viewLabel) const;


  virtual global_size_t getGlobalNumRows() const = 0;


  virtual global_size_t getGlobalNumCols() const = 0;

  virtual size_t getLocalNumRows() const = 0;

  virtual global_size_t getGlobalNumEntries() const = 0;

  virtual size_t getLocalNumEntries() const = 0;


  virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const = 0;


  virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const = 0;


  virtual size_t getGlobalMaxNumRowEntries() const = 0;


  virtual size_t getLocalMaxNumRowEntries() const = 0;

  virtual bool isLocallyIndexed() const = 0;

  virtual bool isGloballyIndexed() const = 0;

  virtual bool isFillComplete() const = 0;


  virtual void getLocalRowCopy(LocalOrdinal LocalRow,
                               const ArrayView<LocalOrdinal> &Indices,
                               const ArrayView<Scalar> &Values,
                               size_t &NumEntries) const = 0;


  virtual void getGlobalRowView(GlobalOrdinal GlobalRow, ArrayView<const GlobalOrdinal> &indices, ArrayView<const Scalar> &values) const = 0;


  virtual void getLocalRowView(LocalOrdinal LocalRow, ArrayView<const LocalOrdinal> &indices, ArrayView<const Scalar> &values) const = 0;


  virtual void getLocalDiagCopy(Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &diag) const = 0;

  virtual typename ScalarTraits<Scalar>::magnitudeType getFrobeniusNorm() const = 0;

  virtual void leftScale(const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &x) = 0;

  virtual void rightScale(const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &x) = 0;

  virtual bool haveGlobalConstants() const = 0;


  //{@

  virtual const Teuchos::RCP<const Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node> > getMap() const = 0;

  // TODO: first argument of doImport/doExport should be a Xpetra::DistObject

  virtual void doImport(const Matrix &source,
                        const Import<LocalOrdinal, GlobalOrdinal, Node> &importer, CombineMode CM) = 0;

  virtual void doExport(const Matrix &dest,
                        const Import<LocalOrdinal, GlobalOrdinal, Node> &importer, CombineMode CM) = 0;

  virtual void doImport(const Matrix &source,
                        const Export<LocalOrdinal, GlobalOrdinal, Node> &exporter, CombineMode CM) = 0;

  virtual void doExport(const Matrix &dest,
                        const Export<LocalOrdinal, GlobalOrdinal, Node> &exporter, CombineMode CM) = 0;

  // @}





  virtual std::string description() const = 0;

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


  virtual void setObjectLabel(const std::string &objectLabel) = 0;

  // JG: Added:

  virtual bool hasCrsGraph() const = 0;

  virtual RCP<const CrsGraph> getCrsGraph() const = 0;

  // To keep the normal virtual matrix-multivector definition of apply before overloading with the region variant
  using Xpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal, Node>::apply;

  virtual void apply(const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &X,
                     MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &Y,
                     Teuchos::ETransp mode,
                     Scalar alpha,
                     Scalar beta,
                     bool sumInterfaceValues,
                     const RCP<Import<LocalOrdinal, GlobalOrdinal, Node> > &regionInterfaceImporter,
                     const Teuchos::ArrayRCP<LocalOrdinal> &regionInterfaceLIDs) const = 0;

  // ----------------------------------------------------------------------------------
  // "TEMPORARY" VIEW MECHANISM
  void SetFixedBlockSize(LocalOrdinal blksize, GlobalOrdinal offset = 0);

  //==========================================================================

  LocalOrdinal GetFixedBlockSize() const;  // TODO: why LocalOrdinal?

  bool IsFixedBlockSizeSet() const;

  virtual LocalOrdinal GetStorageBlockSize() const = 0;

  // ----------------------------------------------------------------------------------

  virtual void SetMaxEigenvalueEstimate(Scalar const &sigma);

  // ----------------------------------------------------------------------------------

  virtual Scalar GetMaxEigenvalueEstimate() const;

  // ----------------------------------------------------------------------------------
#ifdef HAVE_XPETRA_TPETRA
  virtual local_matrix_type getLocalMatrixDevice() const = 0;
#if KOKKOS_VERSION >= 40799
  virtual typename local_matrix_type::host_mirror_type getLocalMatrixHost() const = 0;
#else
  virtual typename local_matrix_type::HostMirror getLocalMatrixHost() const = 0;
#endif
#else
#ifdef __GNUC__
#warning "Xpetra Kokkos interface for CrsMatrix is enabled (HAVE_XPETRA_KOKKOS_REFACTOR) but Tpetra is disabled. The Kokkos interface needs Tpetra to be enabled, too."
#endif
#endif
  // ----------------------------------------------------------------------------------

  virtual void residual(const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &X,
                        const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &B,
                        MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &R) const = 0;

 protected:
  Teuchos::Hashtable<viewLabel_t, RCP<MatrixView> > operatorViewTable_;  // hashtable storing the operator views (keys = view names, values = views).

  viewLabel_t defaultViewLabel_;  // label of the view associated with inital Matrix construction
  viewLabel_t currentViewLabel_;  // label of the current view

};  // class Matrix

}  // namespace Xpetra

#define XPETRA_MATRIX_SHORT
#endif  // XPETRA_MATRIX_DECL_HPP