Xpetra_CrsMatrix.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_CRSMATRIX_HPP
#define XPETRA_CRSMATRIX_HPP

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

#include <Tpetra_KokkosCompat_DefaultNode.hpp>
#include "Xpetra_ConfigDefs.hpp"
#include "Xpetra_RowMatrix.hpp"
#include "Xpetra_DistObject.hpp"
#include "Xpetra_CrsGraph.hpp"
#include "Xpetra_Vector.hpp"

#ifdef HAVE_XPETRA_TPETRA
#include <Kokkos_StaticCrsGraph.hpp>
#include <KokkosSparse_CrsMatrix.hpp>
#endif

namespace Xpetra {

template <class Scalar,
          class LocalOrdinal,
          class GlobalOrdinal,
          class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
class CrsMatrix
  : public RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>,
    public DistObject<char, LocalOrdinal, GlobalOrdinal, Node> {
 public:
  typedef Scalar scalar_type;
  typedef LocalOrdinal local_ordinal_type;
  typedef GlobalOrdinal global_ordinal_type;
  typedef Node node_type;



  virtual ~CrsMatrix() {}



  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 allocateAllValues(size_t numNonZeros, ArrayRCP<size_t> &rowptr, ArrayRCP<LocalOrdinal> &colind, ArrayRCP<Scalar> &values) = 0;

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

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

  virtual void getAllValues(ArrayRCP<Scalar> &values) = 0;




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

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

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

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

  virtual 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) = 0;



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

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

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

  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 bool isFillActive() const = 0;

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

  virtual bool supportsRowViews() const = 0;

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

  virtual void getGlobalRowCopy(GlobalOrdinal GlobalRow, const ArrayView<GlobalOrdinal> &indices, const ArrayView<Scalar> &values, size_t &numEntries) 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 void getLocalDiagOffsets(Teuchos::ArrayRCP<size_t> &offsets) const = 0;

  virtual void getLocalDiagCopy(Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &diag, const Teuchos::ArrayView<const size_t> &offsets) const = 0;

  virtual void getLocalDiagCopy(Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &diag, const Kokkos::View<const size_t *, typename Node::device_type, Kokkos::MemoryUnmanaged> &offsets) const = 0;

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

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

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

  virtual void removeEmptyProcessesInPlace(const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &newMap) = 0;

  virtual bool haveGlobalConstants() const = 0;




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

  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;

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

  virtual const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > getRangeMap() const = 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;


#ifdef HAVE_XPETRA_TPETRA
  using impl_scalar_type = typename Kokkos::ArithTraits<Scalar>::val_type;
  using execution_space  = typename node_type::device_type;

  // that is the local_graph_type in Tpetra::CrsGraph...
  using local_graph_type = Kokkos::StaticCrsGraph<LocalOrdinal,
                                                  Kokkos::LayoutLeft,
                                                  execution_space,
                                                  void,
                                                  size_t>;
  using local_matrix_type = KokkosSparse::CrsMatrix<impl_scalar_type, LocalOrdinal, execution_space, void,
                                                    typename local_graph_type::size_type>;

  virtual local_matrix_type getLocalMatrixDevice() const                    = 0;
  virtual typename local_matrix_type::HostMirror getLocalMatrixHost() const = 0;

  virtual void setAllValues(const typename local_matrix_type::row_map_type &ptr,
                            const typename local_graph_type::entries_type::non_const_type &ind,
                            const typename local_matrix_type::values_type &val) = 0;
#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


  //  Adding these functions by hand, as they're in the skip list.

  virtual size_t getLocalNumCols() const = 0;

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

  virtual bool hasMatrix() const = 0;

  virtual LocalOrdinal GetStorageBlockSize() const = 0;

  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;

};  // CrsMatrix class

}  // namespace Xpetra

#define XPETRA_CRSMATRIX_SHORT
#endif  // XPETRA_CRSMATRIX_HPP