Xpetra_TpetraRowMatrix.hpp

Go to the documentation of this file.

// @HEADER
//
// ***********************************************************************
//
//             Xpetra: A linear algebra interface package
//                  Copyright 2012 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact
//                    Jonathan Hu       (jhu@sandia.gov)
//                    Andrey Prokopenko (aprokop@sandia.gov)
//                    Ray Tuminaro      (rstumin@sandia.gov)
//
// ***********************************************************************
//
// @HEADER
#ifndef XPETRA_TPETRAROWMATRIX_HPP
#define XPETRA_TPETRAROWMATRIX_HPP

/* this file is automatically generated - do not edit (see script/tpetra.py) */

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

#include <Teuchos_Describable.hpp>
#include "Xpetra_ConfigDefs.hpp"
#include "Xpetra_Map.hpp"
#include "Xpetra_Vector.hpp"

#include "Xpetra_TpetraMap.hpp"

#include "Tpetra_RowMatrix.hpp"

#include "Xpetra_RowMatrix.hpp"
#include "Xpetra_Exceptions.hpp"

namespace Xpetra {

template <class Scalar,
          class LocalOrdinal,
          class GlobalOrdinal,
          class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
class TpetraRowMatrix
  : virtual public RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
 public:


  virtual ~TpetraRowMatrix() = default;




  const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > getRowMap() const {
    XPETRA_MONITOR("TpetraRowMatrix::getRowMap");
    return toXpetra(mtx_->getRowMap());
  }

  const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > getColMap() const {
    XPETRA_MONITOR("TpetraRowMatrix::getColMap");
    return toXpetra(mtx_->getColMap());
  }

  Tpetra::global_size_t getGlobalNumRows() const {
    XPETRA_MONITOR("TpetraRowMatrix::getGlobalNumRows");
    return mtx_->getGlobalNumRows();
  }

  Tpetra::global_size_t getGlobalNumCols() const {
    XPETRA_MONITOR("TpetraRowMatrix::getGlobalNumCols");
    return mtx_->getGlobalNumCols();
  }

  size_t getLocalNumRows() const {
    XPETRA_MONITOR("TpetraRowMatrix::getLocalNumRows");
    return mtx_->getLocalNumRows();
  }

  size_t getLocalNumCols() const {
    XPETRA_MONITOR("TpetraRowMatrix::getLocalNumCols");
    return mtx_->getLocalNumCols();
  }

  Tpetra::global_size_t getGlobalNumEntries() const {
    XPETRA_MONITOR("TpetraRowMatrix::getGlobalNumEntries");
    return mtx_->getGlobalNumEntries();
  }

  size_t getNodeNumEntries() const {
    XPETRA_MONITOR("TpetraRowMatrix::getNodeNumEntries");
    return mtx_->getNodeNumEntries();
  }

  size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const {
    XPETRA_MONITOR("TpetraRowMatrix::getNumEntriesInLocalRow");
    return mtx_->getNumEntriesInLocalRow(localRow);
  }

  size_t getGlobalMaxNumRowEntries() const {
    XPETRA_MONITOR("TpetraRowMatrix::getGlobalMaxNumRowEntries");
    return mtx_->getGlobalMaxNumRowEntries();
  }

  size_t getLocalMaxNumRowEntries() const {
    XPETRA_MONITOR("TpetraRowMatrix::getLocalMaxNumRowEntries");
    return mtx_->getLocalMaxNumRowEntries();
  }

  bool isLocallyIndexed() const {
    XPETRA_MONITOR("TpetraRowMatrix::isLocallyIndexed");
    return mtx_->isLocallyIndexed();
  }

  bool isGloballyIndexed() const {
    XPETRA_MONITOR("TpetraRowMatrix::isGloballyIndexed");
    return mtx_->isGloballyIndexed();
  }

  bool isFillComplete() const {
    XPETRA_MONITOR("TpetraRowMatrix::isFillComplete");
    return mtx_->isFillComplete();
  }

  bool supportsRowViews() const {
    XPETRA_MONITOR("TpetraRowMatrix::supportsRowViews");
    return mtx_->supportsRowViews();
  }




  void getLocalRowCopy(LocalOrdinal LocalRow, const Teuchos::ArrayView<LocalOrdinal> &Indices, const Teuchos::ArrayView<Scalar> &Values, size_t &NumEntries) const {
    XPETRA_MONITOR("TpetraRowMatrix::getLocalRowCopy");
    typename Tpetra::RowGraph<LocalOrdinal, GlobalOrdinal, Node>::nonconst_local_inds_host_view_type indices("indices", Indices.size());
    typename Tpetra::RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::nonconst_values_host_view_type values("values", Values.size());

    mtx_->getLocalRowCopy(LocalRow, indices, values, NumEntries);
    for (size_t i = 0; i < NumEntries; ++i) {
      Indices[i] = indices(i);
      Values[i]  = values(i);
    }
  }

  void getGlobalRowView(GlobalOrdinal GlobalRow, ArrayView<const GlobalOrdinal> &indices, ArrayView<const Scalar> &values) const {
    XPETRA_MONITOR("TpetraRowMatrix::getGlobalRowView");
    typename Tpetra::RowGraph<LocalOrdinal, GlobalOrdinal, Node>::global_inds_host_view_type k_indices;
    typename Tpetra::RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::values_host_view_type k_values;

    mtx_->getGlobalRowView(GlobalRow, k_indices, k_values);
    indices = ArrayView<const GlobalOrdinal>(k_indices.data(), k_indices.extent(0));
    values  = ArrayView<const Scalar>(reinterpret_cast<const Scalar *>(k_values.data()), k_values.extent(0));
  }

  void getLocalRowView(LocalOrdinal LocalRow, ArrayView<const LocalOrdinal> &indices, ArrayView<const Scalar> &values) const {
    XPETRA_MONITOR("TpetraRowMatrix::getLocalRowView");
    typename Tpetra::RowGraph<LocalOrdinal, GlobalOrdinal, Node>::local_inds_host_view_type k_indices;
    typename Tpetra::RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::values_host_view_type k_values;

    mtx_->getLocalRowView(LocalRow, k_indices, k_values);
    indices = ArrayView<const LocalOrdinal>(k_indices.data(), k_indices.extent(0));
    values  = ArrayView<const Scalar>(reinterpret_cast<const Scalar *>(k_values.data()), k_values.extent(0));
  }

  void getLocalDiagCopy(Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &diag) const { TEUCHOS_TEST_FOR_EXCEPTION(1, Xpetra::Exceptions::NotImplemented, "TODO"); }
  //{ XPETRA_MONITOR("TpetraRowMatrix::getLocalDiagCopy"); mtx_->getLocalDiagCopy(diag); }




  typename ScalarTraits<Scalar>::magnitudeType getFrobeniusNorm() const {
    XPETRA_MONITOR("TpetraRowMatrix::getFrobeniusNorm");
    return mtx_->getFrobeniusNorm();
  }




  const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > getDomainMap() const {
    XPETRA_MONITOR("TpetraRowMatrix::getDomainMap");
    return toXpetra(mtx_->getDomainMap());
  }

  const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > getRangeMap() const {
    XPETRA_MONITOR("TpetraRowMatrix::getRangeMap");
    return toXpetra(mtx_->getRangeMap());
  }

  void apply(const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &X, 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 { TEUCHOS_TEST_FOR_EXCEPTION(1, Xpetra::Exceptions::NotImplemented, "TODO"); }
  //{ XPETRA_MONITOR("TpetraRowMatrix::apply"); mtx_->apply(X, Y, mode, alpha, beta); }




  TpetraRowMatrix() = default;

  TpetraRowMatrix(const Teuchos::RCP<Tpetra::RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> > &mtx)
    : mtx_(mtx) {}

  void setTpetra_RowMatrix(const Teuchos::RCP<Tpetra::RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> > &mtx) { mtx_ = mtx; }

  RCP<const Tpetra::RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> > getTpetra_RowMatrix() const { return mtx_; }

  RCP<Tpetra::RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> > getTpetra_RowMatrixNonConst() const { return mtx_; }  // TODO: remove


 private:
  RCP<Tpetra::RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> > mtx_;

};  // TpetraRowMatrix class

}  // namespace Xpetra

#define XPETRA_TPETRAROWMATRIX_SHORT
#endif  // XPETRA_TPETRAROWMATRIX_HPP