Xpetra_BlockedVector.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)
//                    Tobias Wiesner    (tawiesn@sandia.gov)
//                    Ray Tuminaro      (rstumin@sandia.gov)
//
// ***********************************************************************
//
// @HEADER
#ifndef XPETRA_BLOCKEDVECTOR_HPP
#define XPETRA_BLOCKEDVECTOR_HPP

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

#include "Xpetra_ConfigDefs.hpp"
#include "Xpetra_Map.hpp"
#include "Xpetra_Vector.hpp"

#include "Xpetra_BlockedMap.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;
  template<class S, class LO, class GO, class N> class MapExtractor;
  template<class S, class LO, class GO, class N> class VectorFactory;
#endif

  template <class Scalar = double,
            class LocalOrdinal = Map<>::local_ordinal_type,
            class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type,
            class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
  class BlockedVector
    : public virtual Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node >,
      public virtual Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node>
  {
  public:
    typedef Scalar scalar_type;
    typedef LocalOrdinal local_ordinal_type;
    typedef GlobalOrdinal global_ordinal_type;
    typedef Node node_type;

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


  private:
#undef XPETRA_BLOCKEDVECTOR_SHORT
#include "Xpetra_UseShortNames.hpp"

  public:



    BlockedVector(const Teuchos::RCP< const BlockedMap > &map,
        bool zeroOut=true) :
          BlockedMultiVector(map,1,zeroOut) {    };

    BlockedVector(Teuchos::RCP<const Xpetra::BlockedMap<LocalOrdinal,GlobalOrdinal,Node> > bmap,
                     Teuchos::RCP<const Vector> v) :
                     BlockedMultiVector(bmap,v) {    }

    BlockedVector(Teuchos::RCP<const Xpetra::BlockedMap<LocalOrdinal,GlobalOrdinal,Node> > bmap,
                     Teuchos::RCP<Vector> v) :
                     BlockedMultiVector(bmap,v) {    }

    BlockedVector(Teuchos::RCP<const Xpetra::MapExtractor<Scalar,LocalOrdinal,GlobalOrdinal,Node> > mapExtractor,
                     Teuchos::RCP<const Vector> v) :
                     BlockedMultiVector(mapExtractor,v) {    }

    BlockedVector(Teuchos::RCP<const Xpetra::MapExtractor<Scalar,LocalOrdinal,GlobalOrdinal,Node> > mapExtractor,
                     Teuchos::RCP<Vector> v) :
                     BlockedMultiVector(mapExtractor,v) {    }

    virtual ~BlockedVector() { }

    BlockedVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>&
    operator= (const MultiVector& rhs) {
      assign (rhs); // dispatch to protected virtual method
      return *this;
    }



    virtual void replaceGlobalValue(GlobalOrdinal globalRow, size_t vectorIndex, const Scalar &value) {
      BlockedMultiVector::replaceGlobalValue(globalRow, vectorIndex, value);
    }

    virtual void sumIntoGlobalValue(GlobalOrdinal globalRow, size_t vectorIndex, const Scalar &value) {
      BlockedMultiVector::sumIntoGlobalValue(globalRow, vectorIndex, value);
    }

    virtual void replaceLocalValue(LocalOrdinal myRow, size_t vectorIndex, const Scalar &value) {
      BlockedMultiVector::replaceLocalValue(myRow, vectorIndex, value);
    }

    virtual void sumIntoLocalValue(LocalOrdinal myRow, size_t vectorIndex, const Scalar &value) {
      BlockedMultiVector::sumIntoLocalValue(myRow, vectorIndex, value);
    }

    virtual void replaceGlobalValue(GlobalOrdinal globalRow, const Scalar &value) {
      BlockedMultiVector::replaceGlobalValue(globalRow, 0, value);
    }

    virtual void sumIntoGlobalValue(GlobalOrdinal globalRow, const Scalar &value) {
      BlockedMultiVector::sumIntoGlobalValue(globalRow, 0, value);
    }

    virtual void replaceLocalValue(LocalOrdinal myRow, const Scalar &value) {
      BlockedMultiVector::replaceLocalValue(myRow, 0, value);
    }

    virtual void sumIntoLocalValue(LocalOrdinal myRow, const Scalar &value) {
      BlockedMultiVector::sumIntoLocalValue(myRow, 0, value);
    }


    virtual void putScalar(const Scalar &value) {
      BlockedMultiVector::putScalar(value);
    }




    virtual Teuchos::RCP< const Xpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > getVector(size_t j) const {
      return BlockedMultiVector::getVector(j);
    }

    virtual Teuchos::RCP< Xpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > getVectorNonConst(size_t j) {
      return BlockedMultiVector::getVectorNonConst(j);
    }

    virtual Teuchos::ArrayRCP< const Scalar > getData(size_t j) const {
      return BlockedMultiVector::getData(j);
    }

    virtual Teuchos::ArrayRCP< Scalar > getDataNonConst(size_t j) {
      return BlockedMultiVector::getDataNonConst(j);
    }




    virtual void dot(const MultiVector&A, const Teuchos::ArrayView< Scalar > &dots) const {
      BlockedMultiVector::dot(A,dots);
      return;
    }

    virtual Scalar dot(const Vector&A) const {
      Teuchos::Array< Scalar > dots = Teuchos::Array<Scalar>(1);
      BlockedMultiVector::dot(A,dots);
      return dots[0];
    }


    virtual void abs(const MultiVector&A) {
      BlockedMultiVector::abs(A);
      return;
    }

    virtual void reciprocal(const MultiVector&A) {
      BlockedMultiVector::reciprocal(A);
      return;
    }

    virtual void scale(const Scalar &alpha) {
      BlockedMultiVector::scale(alpha);
      return;
    }

    virtual void scale (Teuchos::ArrayView< const Scalar > alpha) {
      BlockedMultiVector::scale(alpha);
      return ;
    }

    virtual void update(const Scalar &alpha, const MultiVector&A, const Scalar &beta) {
      BlockedMultiVector::update(alpha,A,beta);
      return;
    }


    virtual void update(const Scalar &alpha, const MultiVector&A, const Scalar &beta, const MultiVector&B, const Scalar &gamma) {
      BlockedMultiVector::update(alpha,A,beta,B,gamma);
      return;
    }

    virtual typename Teuchos::ScalarTraits< Scalar >::magnitudeType norm1() const {
      Teuchos::Array< typename Teuchos::ScalarTraits< Scalar>::magnitudeType > norm =
          Teuchos::Array< typename Teuchos::ScalarTraits< Scalar>::magnitudeType >(1);
      this->norm1(norm);
      return norm[0];
    }

    virtual typename Teuchos::ScalarTraits< Scalar >::magnitudeType norm2() const {
      Teuchos::Array< typename Teuchos::ScalarTraits< Scalar>::magnitudeType > norm =
          Teuchos::Array< typename Teuchos::ScalarTraits< Scalar>::magnitudeType >(1);
      this->norm2(norm);
      return norm[0];
    }

    virtual typename Teuchos::ScalarTraits< Scalar >::magnitudeType normInf() const {
      Teuchos::Array< typename Teuchos::ScalarTraits< Scalar>::magnitudeType > norm =
          Teuchos::Array< typename Teuchos::ScalarTraits< Scalar>::magnitudeType >(1);
      this->normInf(norm);
      return norm[0];
    }

    virtual void norm1(const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const {
      BlockedMultiVector::norm1(norms);
    }

    virtual void norm2(const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const {
      BlockedMultiVector::norm2(norms);
    }

    virtual void normInf(const Teuchos::ArrayView< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &norms) const {
      BlockedMultiVector::normInf(norms);
    }

    virtual void meanValue(const Teuchos::ArrayView< Scalar > &/* means */) const {
      throw Xpetra::Exceptions::RuntimeError("BlockedVector::meanValue: Not (yet) supported by BlockedVector.");
    }

    virtual Scalar meanValue() const {
      throw Xpetra::Exceptions::RuntimeError("BlockedVector::meanValue: Not (yet) supported by BlockedVector.");
    }

    virtual void multiply(Teuchos::ETransp /* transA */, Teuchos::ETransp /* transB */, const Scalar &/* alpha */, const Vector&/* A */, const Vector&/* B */, const Scalar &/* beta */) {
      throw Xpetra::Exceptions::RuntimeError("BlockedVector::multiply: Not (yet) supported by BlockedVector.");
    }

    virtual void multiply(Teuchos::ETransp /* transA */, Teuchos::ETransp /* transB */, const Scalar &/* alpha */, const MultiVector&/* A */, const MultiVector&/* B */, const Scalar &/* beta */) {
      throw Xpetra::Exceptions::RuntimeError("BlockedVector::multiply: Not (yet) supported by BlockedVector.");
    }


    virtual void elementWiseMultiply(Scalar /* scalarAB */, const Xpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node>&/* A */, const MultiVector&/* B */, Scalar /* scalarThis */) {
      throw Xpetra::Exceptions::RuntimeError("BlockedVector::elementWiseMultiply: Not (yet) supported by BlockedVector.");
    }

    virtual void elementWiseMultiply(Scalar /* scalarAB */, const Xpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node>&A, const Vector&B, Scalar /* scalarThis */) {
      XPETRA_TEST_FOR_EXCEPTION(B.getMap()->isSameAs(*(this->getMap()))==false, Xpetra::Exceptions::RuntimeError, "BlockedVector::elementWiseMultipy: B must have same blocked map than this.");
      TEUCHOS_TEST_FOR_EXCEPTION(A.getMap()->getNodeNumElements() != B.getMap()->getNodeNumElements(), Xpetra::Exceptions::RuntimeError, "BlockedVector::elementWiseMultipy: A has " << A.getMap()->getNodeNumElements() << " elements, B has " << B.getMap()->getNodeNumElements() << ".");
      TEUCHOS_TEST_FOR_EXCEPTION(A.getMap()->getGlobalNumElements() != B.getMap()->getGlobalNumElements(), Xpetra::Exceptions::RuntimeError, "BlockedVector::elementWiseMultipy: A has " << A.getMap()->getGlobalNumElements() << " elements, B has " << B.getMap()->getGlobalNumElements() << ".");

      RCP<const BlockedMap> bmap = this->getBlockedMap();
      RCP<const Xpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node>> rcpA = Teuchos::rcpFromRef(A);
      RCP<const Vector> bmvec = Teuchos::rcpFromRef(B);
      RCP<const BlockedVector> bbmvec = Teuchos::rcp_dynamic_cast<const BlockedVector>(bmvec);
      TEUCHOS_TEST_FOR_EXCEPTION(bbmvec.is_null() == true, Xpetra::Exceptions::RuntimeError, "BlockedVector::elementWiseMultipy: B must be a BlockedVector.");

      // TODO implement me
      /*RCP<Xpetra::MapExtractor<Scalar,LocalOrdinal,GlobalOrdinal,Node> > me = Teuchos::rcp(new Xpetra::MapExtractor<Scalar,LocalOrdinal,GlobalOrdinal,Node>(bmap));

      for(size_t m = 0; m < bmap->getNumMaps(); m++) {
        // TODO introduce BlockedVector objects and "skip" this expensive ExtractVector call
        RCP<const Xpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > pd = me->ExtractVector(rcpA,m,bmap->getThyraMode());
        XPETRA_TEST_FOR_EXCEPTION(pd->getMap()->isSameAs(*(this->getBlockedMap()->getMap(m,bmap->getThyraMode())))==false, Xpetra::Exceptions::RuntimeError, "BlockedVector::elementWiseMultipy: sub map of B does not fit with sub map of this.");
        this->getMultiVector(m,bmap->getThyraMode())->elementWiseMultiply(scalarAB,*pd,*(bbmvec->getMultiVector(m,bmap->getThyraMode())),scalarThis);
      }*/
    }




    virtual size_t getNumVectors() const {
      return 1;
    }

    virtual size_t getLocalLength() const {
      throw Xpetra::Exceptions::RuntimeError("BlockedVector::getLocalLength: routine not implemented. It has no value as one must iterate on the partial vectors.");
      TEUCHOS_UNREACHABLE_RETURN(0);
    }

    virtual global_size_t getGlobalLength() const {
      return this->getBlockedMap()->getFullMap()->getGlobalNumElements();
    }

    virtual bool isSameSize(const Xpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> & /* vec */) const {
      throw Xpetra::Exceptions::RuntimeError("BlockedVector::isSameSize: routine not implemented. It has no value as one must iterate on the partial vectors.");
      TEUCHOS_UNREACHABLE_RETURN(0);
    }




    virtual std::string description() const {
      return std::string("BlockedVector");
    }

    virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const {
      out << description() << std::endl;
      for(size_t r = 0; r < this->getBlockedMap()->getNumMaps(); r++)
        getMultiVector(r)->describe(out, verbLevel);
    }

    virtual void replaceMap(const RCP<const Map>& map) {
      BlockedMultiVector::replaceMap(map);
    }

    virtual void doImport(const DistObject<Scalar, LocalOrdinal, GlobalOrdinal, Node> &/* source */, const Import& /* importer */, CombineMode /* CM */) {
      throw Xpetra::Exceptions::RuntimeError("BlockedVector::doImport: Not supported by BlockedVector.");
    }

    virtual void doExport(const DistObject<Scalar, LocalOrdinal, GlobalOrdinal, Node> &/* dest */, const Import& /* importer */, CombineMode /* CM */) {
      throw Xpetra::Exceptions::RuntimeError("BlockedVector::doExport: Not supported by BlockedVector.");
    }

    virtual void doImport(const DistObject<Scalar, LocalOrdinal, GlobalOrdinal, Node> &/* source */, const Export& /* exporter */, CombineMode /* CM */) {
      throw Xpetra::Exceptions::RuntimeError("BlockedVector::doImport: Not supported by BlockedVector.");
    }

    virtual void doExport(const DistObject<Scalar, LocalOrdinal, GlobalOrdinal, Node> &/* dest */, const Export& /* exporter */, CombineMode /* CM */) {
      throw Xpetra::Exceptions::RuntimeError("BlockedVector::doExport: Not supported by BlockedVector.");
    }




    virtual void setSeed(unsigned int seed) {
      for(size_t r = 0; r < this->getBlockedMap()->getNumMaps(); ++r) {
        getMultiVector(r)->setSeed(seed);
      }
    }


    virtual void randomize(bool bUseXpetraImplementation = false) {
      for(size_t r = 0; r < this->getBlockedMap()->getNumMaps(); ++r) {
        getMultiVector(r)->randomize(bUseXpetraImplementation);
      }
    }

    virtual void Xpetra_randomize()
    {
      Xpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node>::Xpetra_randomize();
    }

#ifdef HAVE_XPETRA_KOKKOS_REFACTOR
    typedef typename Kokkos::Details::ArithTraits<Scalar>::val_type impl_scalar_type;
    typedef Kokkos::DualView<impl_scalar_type**, Kokkos::LayoutStride,
        typename node_type::execution_space,
        Kokkos::MemoryUnmanaged> dual_view_type;
    typedef typename dual_view_type::host_mirror_space host_execution_space;
    typedef typename dual_view_type::t_dev::execution_space dev_execution_space;

    template<class TargetDeviceType>
    typename Kokkos::Impl::if_c<
      Kokkos::Impl::is_same<
        typename dev_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 () const {
      if(Kokkos::Impl::is_same<
                   typename host_execution_space::memory_space,
                   typename TargetDeviceType::memory_space
         >::value) {
        return getHostLocalView();
      } else {
        return getDeviceLocalView();
      }
    }

    virtual typename dual_view_type::t_host_um getHostLocalView ()  const {
      typename dual_view_type::t_host_um test;
      return test;
    }
    virtual typename dual_view_type::t_dev_um  getDeviceLocalView() const {
      typename dual_view_type::t_dev_um test;
      return test;
    }

#endif


    Teuchos::RCP< const Map> getMap() const { XPETRA_MONITOR("BlockedVector::getMap"); return this->getBlockedMap(); }

    Teuchos::RCP<MultiVector> getMultiVector(size_t r) const {
      return BlockedMultiVector::getMultiVector(r);
    }

    Teuchos::RCP<MultiVector> getMultiVector(size_t r, bool bThyraMode) const {
      return BlockedMultiVector::getMultiVector(r,bThyraMode);
    }

    void setMultiVector(size_t r, Teuchos::RCP<const Vector> v, bool bThyraMode) {
      BlockedMultiVector::setMultiVector(r,v,bThyraMode);
      return;
    }

    Teuchos::RCP<MultiVector> Merge() const {
      return BlockedMultiVector::Merge();
    }


  protected:
    virtual void assign (const MultiVector& rhs) {
      BlockedMultiVector::assign(rhs);
    }

    //virtual void assign (const MultiVector& rhs) {
    //  throw Xpetra::Exceptions::RuntimeError("BlockedVector::assign: Not supported by BlockedVector.");
    //}

  private:
    //Teuchos::RCP<const BlockedMap>          map_;         ///< blocked map containing the sub block maps (either thyra or xpetra mode)
    //std::vector<Teuchos::RCP<Vector> > vv_;          ///< array containing RCPs of the partial vectors
  }; // BlockedVector class

} // Xpetra namespace

#define XPETRA_BLOCKEDVECTOR_SHORT
#endif // XPETRA_BLOCKEDVECTOR_HPP