Xpetra_MultiVector_decl.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_MULTIVECTOR_DECL_HPP
#define XPETRA_MULTIVECTOR_DECL_HPP

#include <Teuchos_LabeledObject.hpp>
#include <Teuchos_DataAccess.hpp>
#include <Teuchos_BLAS_types.hpp>
#include <Teuchos_Range1D.hpp>

#include "Xpetra_ConfigDefs.hpp"
#include "Xpetra_DistObject.hpp"
#include "Xpetra_Map_decl.hpp"

#include "Xpetra_Access.hpp"

#include <Kokkos_Core.hpp>
#include <Kokkos_DualView.hpp>
#include <Kokkos_ArithTraits.hpp>

namespace Xpetra {

#ifndef DOXYGEN_SHOULD_SKIP_THIS
// forward declaration of Vector, needed to prevent circular inclusions
template <class S, class LO, class GO, class N>
class Vector;
#endif

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



  virtual ~MultiVector();

  MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>&
  operator=(const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& rhs);



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

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

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

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

  virtual void putScalar(const Scalar& value) = 0;




  virtual Teuchos::RCP<const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>> getVector(size_t j) const = 0;

  virtual Teuchos::RCP<Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>> getVectorNonConst(size_t j) = 0;

  virtual Teuchos::ArrayRCP<const Scalar> getData(size_t j) const = 0;

  virtual Teuchos::ArrayRCP<Scalar> getDataNonConst(size_t j) = 0;




  virtual void dot(const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A, const Teuchos::ArrayView<Scalar>& dots) const = 0;

  virtual void abs(const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A) = 0;

  virtual void reciprocal(const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A) = 0;

  virtual void scale(const Scalar& alpha) = 0;

  virtual void scale(Teuchos::ArrayView<const Scalar> alpha) = 0;

  virtual void update(const Scalar& alpha, const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A, const Scalar& beta) = 0;

  virtual void update(const Scalar& alpha, const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A,
                      const Scalar& beta, const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& B,
                      const Scalar& gamma) = 0;

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

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

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

  virtual void meanValue(const Teuchos::ArrayView<Scalar>& means) const = 0;

  virtual void multiply(Teuchos::ETransp transA,
                        Teuchos::ETransp transB,
                        const Scalar& alpha,
                        const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A,
                        const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& B,
                        const Scalar& beta) = 0;

  virtual void elementWiseMultiply(Scalar scalarAB,
                                   const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A,
                                   const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& B,
                                   Scalar scalarThis) = 0;




  virtual size_t getNumVectors() const = 0;

  virtual size_t getLocalLength() const = 0;

  virtual global_size_t getGlobalLength() const = 0;

  // \brief Checks to see if the local length, number of vectors and size of Scalar type match
  virtual bool isSameSize(const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& vec) 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 replaceMap(const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& map) = 0;




  virtual void setSeed(unsigned int seed) = 0;

  virtual void randomize(bool bUseXpetraImplementation = false) = 0;

  virtual void randomize(const Scalar& minVal, const Scalar& maxVal, bool bUseXpetraImplementation = false) = 0;

  virtual void Xpetra_randomize();

  virtual void Xpetra_randomize(const Scalar& minVal, const Scalar& maxVal);

  using impl_scalar_type     = typename Kokkos::ArithTraits<Scalar>::val_type;
  using dual_view_type       = Kokkos::DualView<impl_scalar_type**, Kokkos::LayoutStride, typename node_type::device_type, Kokkos::MemoryUnmanaged>;
  using dual_view_type_const = Kokkos::DualView<const impl_scalar_type**, Kokkos::LayoutStride, typename node_type::device_type, Kokkos::MemoryUnmanaged>;
  using host_execution_space = typename dual_view_type::host_mirror_space;
  using dev_execution_space  = typename dual_view_type::t_dev::execution_space;

  virtual typename dual_view_type::t_host_const_um getHostLocalView(Access::ReadOnlyStruct) const {
    throw std::runtime_error("Dummy function getHostLocalView(Access::ReadOnlyStruct), should be overwritten at" + std::string(__FILE__) + ":" + std::to_string(__LINE__));
#ifndef __NVCC__
    typename dual_view_type::t_host_um test;
#endif
    TEUCHOS_UNREACHABLE_RETURN(test);
  }

  virtual typename dual_view_type::t_dev_const_um getDeviceLocalView(Access::ReadOnlyStruct) const {
    throw std::runtime_error("Dummy function getDeviceLocalView(Access::ReadOnlyStruct), should be overwritten at" + std::string(__FILE__) + ":" + std::to_string(__LINE__));
#ifndef __NVCC__
    typename dual_view_type::t_dev_um test;
#endif
    TEUCHOS_UNREACHABLE_RETURN(test);
  }

  virtual typename dual_view_type::t_host_um getHostLocalView(Access::OverwriteAllStruct) const {
    throw std::runtime_error("Dummy function getHostLocalView(Access::OverwriteAllStruct), should be overwritten at" + std::string(__FILE__) + ":" + std::to_string(__LINE__));
#ifndef __NVCC__
    typename dual_view_type::t_host_um test;
#endif
    TEUCHOS_UNREACHABLE_RETURN(test);
  }

  virtual typename dual_view_type::t_dev_um getDeviceLocalView(Access::OverwriteAllStruct) const {
    throw std::runtime_error("Dummy function getDeviceLocalView(Access::OverwriteAllStruct), should be overwritten at" + std::string(__FILE__) + ":" + std::to_string(__LINE__));
#ifndef __NVCC__
    typename dual_view_type::t_dev_um test;
#endif
    TEUCHOS_UNREACHABLE_RETURN(test);
  }

  virtual typename dual_view_type::t_host_um getHostLocalView(Access::ReadWriteStruct) const {
    throw std::runtime_error("Dummy function getHostLocalView(Access::ReadWriteStruct), should be overwritten at" + std::string(__FILE__) + ":" + std::to_string(__LINE__));
#ifndef __NVCC__
    typename dual_view_type::t_host_um test;
#endif
    TEUCHOS_UNREACHABLE_RETURN(test);
  }

  virtual typename dual_view_type::t_dev_um getDeviceLocalView(Access::ReadWriteStruct) const {
    throw std::runtime_error("Dummy function getDeviceLocalView(Access::ReadWriteStruct), should be overwritten at" + std::string(__FILE__) + ":" + std::to_string(__LINE__));
#ifndef __NVCC__
    typename dual_view_type::t_dev_um test;
#endif
    TEUCHOS_UNREACHABLE_RETURN(test);
  }


 protected:
  virtual void assign(const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& rhs) = 0;

};  // MultiVector class

}  // namespace Xpetra

#define XPETRA_MULTIVECTOR_SHORT

#endif  // XPETRA_MULTIVECTOR_DECL_HPP