Xpetra_MatrixView.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_MATRIXVIEW_HPP
#define XPETRA_MATRIXVIEW_HPP

#include <Teuchos_Describable.hpp>
#include <Tpetra_KokkosCompat_DefaultNode.hpp>

#include "Xpetra_ConfigDefs.hpp"
#include "Xpetra_Map.hpp"

namespace Xpetra {

template <class Scalar,
          class LocalOrdinal,
          class GlobalOrdinal,
          class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
class MatrixView {  // TODO : virtual public Teuchos::Describable {
  typedef Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node> Map;

 public:


  MatrixView(const RCP<const Map> &rowMap, const RCP<const Map> &colMap)
    : rowMap_(rowMap)
    , colMap_(colMap)
    , maxEigValueEstimate_(-Teuchos::ScalarTraits<Scalar>::one()) {}

  virtual ~MatrixView() {}



  const RCP<const Map> &GetRowMap() const { return rowMap_; }

  const RCP<const Map> &GetColMap() const { return colMap_; }

  void SetRowMap(const RCP<const Map> &rowMap) { rowMap_ = rowMap; }

  void SetColMap(const RCP<const Map> &colMap) { colMap_ = colMap; }

  void SetMaxEigenvalueEstimate(Scalar const &sigma) { maxEigValueEstimate_ = sigma; }

  Scalar GetMaxEigenvalueEstimate() const { return maxEigValueEstimate_; }

 private:
  RCP<const Map> rowMap_;
  RCP<const Map> colMap_;

  Scalar maxEigValueEstimate_;

};  // class MatrixView

}  // namespace Xpetra

#define XPETRA_MATRIXVIEW_SHORT
#endif  // XPETRA_MATRIX_VIEW_DECL_HPP