Tpetra_Vector_decl.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//          Tpetra: Templated Linear Algebra Services Package
//
// Copyright 2008 NTESS and the Tpetra contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef TPETRA_VECTOR_DECL_HPP
#define TPETRA_VECTOR_DECL_HPP


#include "Tpetra_ConfigDefs.hpp"
#include "Tpetra_Vector_fwd.hpp"
#include "Tpetra_MultiVector_decl.hpp"

namespace Tpetra {

template <class Scalar,
          class LocalOrdinal,
          class GlobalOrdinal,
          class Node>
class Vector : public MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
 private:
  using base_type = MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>;

 public:


  typedef Scalar scalar_type;
  typedef typename base_type::impl_scalar_type impl_scalar_type;
  typedef LocalOrdinal local_ordinal_type;
  typedef GlobalOrdinal global_ordinal_type;
  typedef typename Node::device_type device_type;

  typedef Node node_type;

  typedef typename base_type::dot_type dot_type;

  typedef typename base_type::mag_type mag_type;

  typedef typename base_type::dual_view_type dual_view_type;

  typedef typename base_type::wrapped_dual_view_type wrapped_dual_view_type;

  typedef typename base_type::map_type map_type;



  Vector();

  //
  explicit Vector(const Teuchos::RCP<const map_type>& map,
                  const bool zeroOut = true);

  Vector(const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& source,
         const Teuchos::DataAccess copyOrView);

  Vector(const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& source,
         const Teuchos::RCP<const map_type>& map,
         const local_ordinal_type rowOffset = 0);

  Vector(const Teuchos::RCP<const map_type>& map,
         const Teuchos::ArrayView<const Scalar>& A);

  Vector(const Teuchos::RCP<const map_type>& map,
         const dual_view_type& view);

  Vector(const Teuchos::RCP<const map_type>& map,
         const dual_view_type& view,
         const dual_view_type& origView);

  Vector(const Teuchos::RCP<const map_type>& map,
         const wrapped_dual_view_type& d_view);

  Vector(const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& X,
         const size_t j);

  Vector(const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>&) = default;

  Vector(Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>&&) = default;

  Vector& operator=(const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>&) = default;

  Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>&
  operator=(Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>&&) = default;

  virtual ~Vector() = default;




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

  void
  sumIntoGlobalValue(const GlobalOrdinal globalRow,
                     const Scalar& value,
                     const bool atomic = base_type::useAtomicUpdatesByDefault);


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

  void
  sumIntoLocalValue(const LocalOrdinal myRow,
                    const Scalar& value,
                    const bool atomic = base_type::useAtomicUpdatesByDefault);




  using MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::get1dCopy;  // overloading, not hiding
  void get1dCopy(const Teuchos::ArrayView<Scalar>& A) const;

  using MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::getDataNonConst;  // overloading, not hiding
  Teuchos::ArrayRCP<Scalar> getDataNonConst() {
    return getDataNonConst(0);
  }

  using MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::getData;  // overloading, not hiding
  Teuchos::ArrayRCP<const Scalar> getData() const {
    return getData(0);
  }

  Teuchos::RCP<const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> >
  offsetView(const Teuchos::RCP<const map_type>& subMap,
             const size_t offset) const;

  Teuchos::RCP<Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> >
  offsetViewNonConst(const Teuchos::RCP<const map_type>& subMap,
                     const size_t offset);


  using MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::dot;  // overloading, not hiding
  dot_type dot(const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& y) const;

  using MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::norm1;  // overloading, not hiding
  mag_type norm1() const;

  using MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::norm2;  // overloading, not hiding
  mag_type norm2() const;

  using MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::normInf;  // overloading, not hiding
  mag_type normInf() const;

  using MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::meanValue;  // overloading, not hiding
  Scalar meanValue() const;



  virtual std::string description() const;

  virtual void
  describe(Teuchos::FancyOStream& out,
           const Teuchos::EVerbosityLevel verbLevel =
               Teuchos::Describable::verbLevel_default) const;
};  // class Vector

template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>
createCopy(const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& src);

template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
Teuchos::RCP<Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> >
createVector(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> >& map) {
  return rcp(new Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>(map));
}

}  // namespace Tpetra

#endif  // TPETRA_VECTOR_DECL_HPP