Tpetra_RowMatrix.hpp

//@HEADER
// ************************************************************************
// 
//               Tpetra: Templated Linear Algebra Services Package 
//                 Copyright (2008) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ************************************************************************
//@HEADER

#ifndef TPETRA_ROWMATRIX_HPP
#define TPETRA_ROWMATRIX_HPP

#include <Teuchos_Describable.hpp>
#include <Kokkos_DefaultNode.hpp>

#include "Tpetra_ConfigDefs.hpp"
#include "Tpetra_Map.hpp"
#include "Tpetra_Operator.hpp"
#include "Tpetra_RowGraph.hpp"
#include "Tpetra_Vector.hpp"

namespace Tpetra {


  template <class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
  class RowMatrix : virtual public Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node> {
    public:


      virtual ~RowMatrix();




      virtual const Teuchos::RCP<const Teuchos::Comm<int> > & getComm() const = 0;

      virtual Teuchos::RCP<Node> getNode() const = 0;

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

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

      virtual Teuchos::RCP<const RowGraph<LocalOrdinal,GlobalOrdinal,Node> > getGraph() const = 0;

      virtual global_size_t getGlobalNumRows() const = 0;

      virtual global_size_t getGlobalNumCols() const = 0;

      virtual size_t getNodeNumRows() const = 0;

      virtual size_t getNodeNumCols() const = 0;

      virtual GlobalOrdinal getIndexBase() const = 0;

      virtual global_size_t getGlobalNumEntries() const = 0;

      virtual size_t getNodeNumEntries() const = 0;


      virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const = 0;


      virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const = 0;

      virtual global_size_t getGlobalNumDiags() const = 0;

      virtual size_t getNodeNumDiags() const = 0;

      virtual size_t getGlobalMaxNumRowEntries() const = 0;

      virtual size_t getNodeMaxNumRowEntries() const = 0;

      virtual bool hasColMap() const = 0;

      virtual bool isLowerTriangular() const = 0;

      virtual bool isUpperTriangular() const = 0;

      virtual bool isLocallyIndexed() const = 0;

      virtual bool isGloballyIndexed() const = 0;

      virtual bool isFillComplete() const = 0;





      virtual void getGlobalRowCopy(GlobalOrdinal GlobalRow,
                                    const Teuchos::ArrayView<GlobalOrdinal> &Indices,
                                    const Teuchos::ArrayView<Scalar> &Values,
                                    size_t &NumEntries) const = 0;


      virtual void getLocalRowCopy(LocalOrdinal LocalRow, 
                                   const Teuchos::ArrayView<LocalOrdinal> &Indices, 
                                   const Teuchos::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;





      TPETRA_DEPRECATED virtual void getGlobalRowView(GlobalOrdinal GlobalRow, 
                                                      Teuchos::ArrayRCP<const GlobalOrdinal> &indices,
                                                      Teuchos::ArrayRCP<const Scalar>        &values) const = 0;


      TPETRA_DEPRECATED virtual void getLocalRowView(LocalOrdinal LocalRow,
                                                    Teuchos::ArrayRCP<const LocalOrdinal> &indices,
                                                    Teuchos::ArrayRCP<const Scalar>       &values) const = 0;


  }; // class RowMatrix

  template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
  RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node>::~RowMatrix() {
  }

} // namespace Tpetra

#endif