Xpetra_Vector.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_VECTOR_HPP
#define XPETRA_VECTOR_HPP

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

#include "Xpetra_ConfigDefs.hpp"
#include "Xpetra_MultiVector.hpp"

namespace Xpetra {

template <class Scalar,
          class LocalOrdinal,
          class GlobalOrdinal,
          class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
class Vector
  : public virtual MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
 public:
  using scalar_type         = Scalar;
  using local_ordinal_type  = LocalOrdinal;
  using global_ordinal_type = GlobalOrdinal;
  using node_type           = Node;

  using MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::dot;                 // overloading, not hiding
  using MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::norm1;               // overloading, not hiding
  using MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::norm2;               // overloading, not hiding
  using MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::normInf;             // overloading, not hiding
  using MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::meanValue;           // overloading, not hiding
  using MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::replaceGlobalValue;  // overloading, not hiding
  using MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::sumIntoGlobalValue;  // overloading, not hiding
  using MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::replaceLocalValue;   // overloading, not hiding
  using MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::sumIntoLocalValue;   // overloading, not hiding

  typedef typename Xpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::dual_view_type dual_view_type;

  template <class TargetDeviceType, class AccessType>
  typename std::conditional<
      std::is_same<
          typename dual_view_type::t_dev_um::execution_space::memory_space,
          typename TargetDeviceType::memory_space>::value,
      typename dual_view_type::t_dev_um,
      typename dual_view_type::t_host_um>::type
  getLocalView(AccessType access_type) const {
    return this->MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::template getLocalView<TargetDeviceType>(access_type);
  }



  virtual ~Vector() {}




  virtual void replaceGlobalValue(GlobalOrdinal globalRow, const Scalar &value) = 0;

  virtual void sumIntoGlobalValue(GlobalOrdinal globalRow, const Scalar &value) = 0;

  virtual void replaceLocalValue(LocalOrdinal myRow, const Scalar &value) = 0;

  virtual void sumIntoLocalValue(LocalOrdinal myRow, const Scalar &value) = 0;




  virtual Scalar dot(const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &a) const = 0;

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

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

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

  virtual Scalar meanValue() const = 0;




  virtual std::string description() const = 0;

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


};  // Vector class
}  // namespace Xpetra

#define XPETRA_VECTOR_SHORT
#endif  // XPETRA_VECTOR_HPP