Xpetra_TpetraCrsMatrix_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
 
#ifndef XPETRA_TPETRACRSMATRIX_DECL_HPP
#define XPETRA_TPETRACRSMATRIX_DECL_HPP
 
/* this file is automatically generated - do not edit (see scripts/tpetra.py) */
 
// FIXME (mfh 03 Sep 2014) The above is probably not true anymore.
// Furthermore, I don't think anyone maintains the scripts.
// Feel free to correct this comment if I'm wrong.
 
#include "Xpetra_TpetraConfigDefs.hpp"
 
#include "Tpetra_CrsMatrix.hpp"
#include "Tpetra_FECrsMatrix.hpp"
#include "Tpetra_replaceDiagonalCrsMatrix.hpp"
 
#include "Xpetra_CrsMatrix.hpp"
#include "Xpetra_TpetraMap_decl.hpp"
#include "Xpetra_TpetraImport_decl.hpp"
#include "Xpetra_TpetraExport_decl.hpp"
#include "Xpetra_TpetraMultiVector_decl.hpp"
#include "Xpetra_TpetraVector_decl.hpp"
#include "Xpetra_TpetraCrsGraph.hpp"
#include "Xpetra_Exceptions.hpp"
 
namespace Xpetra {
 
template <class Scalar,
          class LocalOrdinal,
          class GlobalOrdinal,
          class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
class TpetraCrsMatrix
  : public CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>  //, public TpetraRowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node>
{
#undef XPETRA_TPETRACRSMATRIX_SHORT
#include "Xpetra_UseShortNamesScalar.hpp"
 
 public:
  // The following typedef are used by the XPETRA_DYNAMIC_CAST() macro.
  typedef TpetraCrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> TpetraCrsMatrixClass;
  typedef TpetraVector TpetraVectorClass;
  typedef TpetraImport<LocalOrdinal, GlobalOrdinal, Node> TpetraImportClass;
  typedef TpetraExport<LocalOrdinal, GlobalOrdinal, Node> TpetraExportClass;
 
  // The following typedefs are used by the Kokkos interface
  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;
 
#if KOKKOS_VERSION >= 40799
  using ATS = KokkosKernels::ArithTraits<Scalar>;
#else
  using ATS = Kokkos::ArithTraits<Scalar>;
#endif
  using impl_scalar_type = typename ATS::val_type;



  TpetraCrsMatrix(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &rowMap, size_t maxNumEntriesPerRow, const Teuchos::RCP<Teuchos::ParameterList> &params = Teuchos::null);

  TpetraCrsMatrix(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &rowMap, const ArrayRCP<const size_t> &NumEntriesPerRowToAlloc, const Teuchos::RCP<Teuchos::ParameterList> &params = Teuchos::null);

  TpetraCrsMatrix(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &rowMap, const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &colMap, size_t maxNumEntriesPerRow, const Teuchos::RCP<Teuchos::ParameterList> &params = Teuchos::null);

  TpetraCrsMatrix(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &rowMap, const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &colMap, const ArrayRCP<const size_t> &NumEntriesPerRowToAlloc, const Teuchos::RCP<Teuchos::ParameterList> &params = Teuchos::null);

  TpetraCrsMatrix(const Teuchos::RCP<const CrsGraph<LocalOrdinal, GlobalOrdinal, Node>> &graph, const Teuchos::RCP<Teuchos::ParameterList> &params = Teuchos::null);

  TpetraCrsMatrix(const Teuchos::RCP<const CrsGraph<LocalOrdinal, GlobalOrdinal, Node>> &graph, typename Xpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::local_matrix_type::values_type &values, const Teuchos::RCP<Teuchos::ParameterList> &params = Teuchos::null);

  TpetraCrsMatrix(const Teuchos::RCP<const CrsMatrix> &sourceMatrix,
                  const Import<LocalOrdinal, GlobalOrdinal, Node> &importer,
                  const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &domainMap = Teuchos::null,
                  const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &rangeMap  = Teuchos::null,
                  const Teuchos::RCP<Teuchos::ParameterList> &params                          = Teuchos::null);

  TpetraCrsMatrix(const Teuchos::RCP<const CrsMatrix> &sourceMatrix,
                  const Export<LocalOrdinal, GlobalOrdinal, Node> &exporter,
                  const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &domainMap = Teuchos::null,
                  const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &rangeMap  = Teuchos::null,
                  const Teuchos::RCP<Teuchos::ParameterList> &params                          = Teuchos::null);

  TpetraCrsMatrix(const Teuchos::RCP<const CrsMatrix> &sourceMatrix,
                  const Import<LocalOrdinal, GlobalOrdinal, Node> &RowImporter,
                  const Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node>> DomainImporter,
                  const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &domainMap,
                  const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &rangeMap,
                  const Teuchos::RCP<Teuchos::ParameterList> &params);

  TpetraCrsMatrix(const Teuchos::RCP<const CrsMatrix> &sourceMatrix,
                  const Export<LocalOrdinal, GlobalOrdinal, Node> &RowExporter,
                  const Teuchos::RCP<const Export<LocalOrdinal, GlobalOrdinal, Node>> DomainExporter,
                  const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &domainMap,
                  const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &rangeMap,
                  const Teuchos::RCP<Teuchos::ParameterList> &params);

  TpetraCrsMatrix(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &rowMap,
                  const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &colMap,
                  const local_matrix_type &lclMatrix,
                  const Teuchos::RCP<Teuchos::ParameterList> &params = null);

  TpetraCrsMatrix(
      const local_matrix_type &lclMatrix,
      const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &rowMap,
      const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &colMap,
      const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &domainMap = Teuchos::null,
      const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &rangeMap  = Teuchos::null,
      const Teuchos::RCP<Teuchos::ParameterList> &params                          = null);

  TpetraCrsMatrix(
      const local_matrix_type &lclMatrix,
      const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &rowMap,
      const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &colMap,
      const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &domainMap,
      const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &rangeMap,
      const Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node>> &importer,
      const Teuchos::RCP<const Export<LocalOrdinal, GlobalOrdinal, Node>> &exporter,
      const Teuchos::RCP<Teuchos::ParameterList> &params = null);

  virtual ~TpetraCrsMatrix();




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

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

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

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

  void setAllToScalar(const Scalar &alpha);

  void scale(const Scalar &alpha);

  //** \warning This is an expert-only routine and should not be called from user code. */
  void allocateAllValues(size_t numNonZeros, ArrayRCP<size_t> &rowptr, ArrayRCP<LocalOrdinal> &colind, ArrayRCP<Scalar> &values);

  void setAllValues(const ArrayRCP<size_t> &rowptr, const ArrayRCP<LocalOrdinal> &colind, const ArrayRCP<Scalar> &values);

  void getAllValues(ArrayRCP<const size_t> &rowptr, ArrayRCP<const LocalOrdinal> &colind, ArrayRCP<const Scalar> &values) const;

  void getAllValues(ArrayRCP<Scalar> &values);
 
  bool haveGlobalConstants() const;




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

  void fillComplete(const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &domainMap, const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &rangeMap, const RCP<ParameterList> &params = null);

  void fillComplete(const RCP<ParameterList> &params = null);

  void replaceDomainMapAndImporter(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &newDomainMap, Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node>> &newImporter);

  void expertStaticFillComplete(const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &domainMap,
                                const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &rangeMap,
                                const RCP<const Import<LocalOrdinal, GlobalOrdinal, Node>> &importer = Teuchos::null,
                                const RCP<const Export<LocalOrdinal, GlobalOrdinal, Node>> &exporter = Teuchos::null,
                                const RCP<ParameterList> &params                                     = Teuchos::null);




  const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> getRowMap() const;

  const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> getColMap() const;

  RCP<const CrsGraph<LocalOrdinal, GlobalOrdinal, Node>> getCrsGraph() const;

  global_size_t getGlobalNumRows() const;

  global_size_t getGlobalNumCols() const;

  size_t getLocalNumRows() const;

  size_t getLocalNumCols() const;

  global_size_t getGlobalNumEntries() const;

  size_t getLocalNumEntries() const;

  size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const;

  size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const;

  size_t getGlobalMaxNumRowEntries() const;

  size_t getLocalMaxNumRowEntries() const;

  bool isLocallyIndexed() const;

  bool isGloballyIndexed() const;

  bool isFillComplete() const;

  bool isFillActive() const;

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

  bool supportsRowViews() const;

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

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

  void getGlobalRowCopy(GlobalOrdinal GlobalRow, const ArrayView<GlobalOrdinal> &indices, const ArrayView<Scalar> &values, size_t &numEntries) const;

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




  void apply(const MultiVector &X, MultiVector &Y, Teuchos::ETransp mode = Teuchos::NO_TRANS, Scalar alpha = ScalarTraits<Scalar>::one(), Scalar beta = ScalarTraits<Scalar>::zero()) const;

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

  const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> getDomainMap() const;

  const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> getRangeMap() const;




  std::string description() const;

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



  void setObjectLabel(const std::string &objectLabel);

  TpetraCrsMatrix(const TpetraCrsMatrix &matrix);

  void getLocalDiagCopy(Vector &diag) const;

  void getLocalDiagOffsets(Teuchos::ArrayRCP<size_t> &offsets) const;

  void getLocalDiagCopy(Vector &diag, const Teuchos::ArrayView<const size_t> &offsets) const;

  void getLocalDiagCopy(Vector &diag, const Kokkos::View<const size_t *, typename Node::device_type, Kokkos::MemoryUnmanaged> &offsets) const;

  void replaceDiag(const Vector &diag);

  void leftScale(const Vector &x);

  void rightScale(const Vector &x);

  //{@

  Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> getMap() const;

  void doImport(const DistObject<char, LocalOrdinal, GlobalOrdinal, Node> &source,
                const Import<LocalOrdinal, GlobalOrdinal, Node> &importer, CombineMode CM);

  void doExport(const DistObject<char, LocalOrdinal, GlobalOrdinal, Node> &dest,
                const Import<LocalOrdinal, GlobalOrdinal, Node> &importer, CombineMode CM);

  void doImport(const DistObject<char, LocalOrdinal, GlobalOrdinal, Node> &source,
                const Export<LocalOrdinal, GlobalOrdinal, Node> &exporter, CombineMode CM);

  void doExport(const DistObject<char, LocalOrdinal, GlobalOrdinal, Node> &dest,
                const Export<LocalOrdinal, GlobalOrdinal, Node> &exporter, CombineMode CM);
 
  void removeEmptyProcessesInPlace(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &newMap);
 
  // @}


  bool hasMatrix() const;

  TpetraCrsMatrix(const Teuchos::RCP<Tpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>> &mtx);

  RCP<const Tpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>> getTpetra_CrsMatrix() const;

  RCP<Tpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>> getTpetra_CrsMatrixNonConst() const;  // TODO: remove

#if KOKKOS_VERSION >= 40799
  typename local_matrix_type::host_mirror_type getLocalMatrixHost() const {
#else
  typename local_matrix_type::HostMirror getLocalMatrixHost() const {
#endif
    return getTpetra_CrsMatrixNonConst()->getLocalMatrixHost();
  }

  local_matrix_type getLocalMatrixDevice() const {
    return getTpetra_CrsMatrixNonConst()->getLocalMatrixDevice();
  }
 
  void setAllValues(const typename local_matrix_type::row_map_type &ptr,
                    const typename local_matrix_type::StaticCrsGraphType::entries_type::non_const_type &ind,
                    const typename local_matrix_type::values_type &val) {
    getTpetra_CrsMatrixNonConst()->setAllValues(ptr, ind, val);
  }

  LocalOrdinal GetStorageBlockSize() const { return 1; }

  void residual(const MultiVector &X,
                const MultiVector &B,
                MultiVector &R) const;

 
 private:
  RCP<Tpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>> mtx_;
};  // TpetraCrsMatrix class
 
template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
Teuchos::RCP<Tpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>>
toTpetra(const Teuchos::RCP<Xpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>> &A) {
  return Teuchos::rcp_dynamic_cast<Xpetra::TpetraCrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>>(A, true)->getTpetra_CrsMatrixNonConst();
}
 
template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
Teuchos::RCP<const Tpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>>
toTpetra(const Teuchos::RCP<const Xpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>> &A) {
  return Teuchos::rcp_dynamic_cast<const Xpetra::TpetraCrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>>(A, true)->getTpetra_CrsMatrix();
}
 
template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
Tpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> &
toTpetra(Xpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> &A) {
  return *dynamic_cast<Xpetra::TpetraCrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> &>(A).getTpetra_CrsMatrixNonConst();
}
 
template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
Tpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> &
toTpetra(const Xpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> &A) {
  return *dynamic_cast<const Xpetra::TpetraCrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> &>(A).getTpetra_CrsMatrix();
}
 
}  // namespace Xpetra
 
#define XPETRA_TPETRACRSMATRIX_SHORT
#endif  // XPETRA_TPETRACRSMATRIX_DECL_HPP