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

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

#include "Xpetra_ConfigDefs.hpp"

#include "Xpetra_BlockedMap_decl.hpp"
#include "Xpetra_BlockedMultiVector_decl.hpp"
#include "Xpetra_Map_decl.hpp"
#include "Xpetra_Vector.hpp"

namespace Xpetra {

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

  using Xpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::dot;                 // overloading, not hiding
  using Xpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::norm1;               // overloading, not hiding
  using Xpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::norm2;               // overloading, not hiding
  using Xpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::normInf;             // overloading, not hiding
  using Xpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::meanValue;           // overloading, not hiding
  using Xpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::replaceGlobalValue;  // overloading, not hiding
  using Xpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::sumIntoGlobalValue;  // overloading, not hiding
  using Xpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>::replaceLocalValue;   // overloading, not hiding
  using Xpetra::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);

  BlockedVector(Teuchos::RCP<const Xpetra::BlockedMap<LocalOrdinal, GlobalOrdinal, Node>> bmap,
                Teuchos::RCP<Xpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>> v);

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

  virtual ~BlockedVector();

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



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

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

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

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

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

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

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

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

  virtual void putScalar(const Scalar& value);




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

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

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

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




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

  virtual Scalar dot(const Xpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A) const;

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

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

  virtual void scale(const Scalar& alpha);

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

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

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

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

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

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

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

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

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

  virtual void meanValue(const Teuchos::ArrayView<Scalar>& /* means */) const;

  virtual Scalar meanValue() const;

  virtual void multiply(Teuchos::ETransp /* transA */,
                        Teuchos::ETransp /* transB */,
                        const Scalar& /* alpha */,
                        const Xpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& /* A */,
                        const Xpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& /* B */,
                        const Scalar& /* beta */);

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

  virtual void elementWiseMultiply(Scalar /* scalarAB */,
                                   const Xpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& /* A */,
                                   const Xpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& /* B */,
                                   Scalar /* scalarThis */);

  virtual void elementWiseMultiply(Scalar /* scalarAB */,
                                   const Xpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A,
                                   const Xpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& B,
                                   Scalar /* scalarThis */);




  virtual size_t getNumVectors() const;

  virtual size_t getLocalLength() const;

  virtual global_size_t getGlobalLength() const;

  virtual bool isSameSize(const Xpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& /* vec */) const;




  virtual std::string description() const;

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

  virtual void replaceMap(const RCP<const Map>& map);

  virtual void doImport(const DistObject<Scalar, LocalOrdinal, GlobalOrdinal, Node>& /* source */,
                        const Import& /* importer */,
                        CombineMode /* CM */);

  virtual void doExport(const DistObject<Scalar, LocalOrdinal, GlobalOrdinal, Node>& /* dest */,
                        const Import& /* importer */,
                        CombineMode /* CM */);

  virtual void doImport(const DistObject<Scalar, LocalOrdinal, GlobalOrdinal, Node>& /* source */,
                        const Export& /* exporter */,
                        CombineMode /* CM */);

  virtual void doExport(const DistObject<Scalar, LocalOrdinal, GlobalOrdinal, Node>& /* dest */,
                        const Export& /* exporter */,
                        CombineMode /* CM */);




  virtual void setSeed(unsigned int seed);

  virtual void randomize(bool bUseXpetraImplementation = false);

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

  virtual void Xpetra_randomize();

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


  Teuchos::RCP<const Map> getMap() const;

  Teuchos::RCP<Xpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>
  getMultiVector(size_t r) const;

  Teuchos::RCP<Xpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>
  getMultiVector(size_t r, bool bThyraMode) const;

  void
  setMultiVector(size_t r,
                 Teuchos::RCP<const Xpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>> v,
                 bool bThyraMode);

  Teuchos::RCP<Xpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>
  Merge() const;

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

  // virtual void assign (const MultiVector& rhs);

  // 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

}  // namespace Xpetra

#define XPETRA_BLOCKEDVECTOR_SHORT
#endif  // XPETRA_BLOCKEDVECTOR_DECL_HPP