Xpetra_EpetraIntVector.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_EPETRAINTVECTOR_HPP
#define XPETRA_EPETRAINTVECTOR_HPP

#include "Xpetra_EpetraConfigDefs.hpp"

#include "Xpetra_ConfigDefs.hpp"
#include "Xpetra_MultiVector.hpp"
#include "Xpetra_Vector.hpp"
#include "Xpetra_Exceptions.hpp"

#include "Xpetra_EpetraMap.hpp"
#include "Xpetra_EpetraMultiVector.hpp"
#include "Epetra_IntVector.h"

namespace Xpetra {

  template<class EpetraGlobalOrdinal>
  class EpetraIntVectorT
    : public Vector<int,int,EpetraGlobalOrdinal>
  {
    typedef int Scalar;
    typedef int LocalOrdinal;
    typedef EpetraGlobalOrdinal GlobalOrdinal;
    typedef KokkosClassic::DefaultNode::DefaultNodeType Node;

  public:



    explicit EpetraIntVectorT(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &map, bool zeroOut=true)
    {
      XPETRA_RCP_DYNAMIC_CAST(const EpetraMapT<GlobalOrdinal>, map, eMap, "Xpetra::EpetraCrsMatrixT constructors only accept Xpetra::EpetraMapT as input arguments.");
      vec_ = rcp(new Epetra_IntVector(eMap->getEpetra_BlockMap(), zeroOut));
    }

    ~EpetraIntVectorT() {  };




    int dot (const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &a) const;

    Teuchos::ScalarTraits<int>::magnitudeType norm1() const;

    Teuchos::ScalarTraits<int>::magnitudeType norm2() const;

    Teuchos::ScalarTraits<int>::magnitudeType normInf() const;

    Teuchos::ScalarTraits<int>::magnitudeType normWeighted(const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &weights) const;

    int meanValue() const;

    int maxValue() const;




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

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

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

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

    void putScalar(const int &value) {  vec_->PutValue(value); }

    void randomize(bool bUseXpetraImplementation = true);


    void setSeed(unsigned int seed);




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

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

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

    Teuchos::ArrayRCP<int> getDataNonConst(size_t j);




    void dot(const MultiVector<int,int,GlobalOrdinal,Node> &A, const Teuchos::ArrayView<int> &dots) const;

    void abs(const MultiVector<int,int,GlobalOrdinal,Node> &A);

    void reciprocal(const MultiVector<int,int,GlobalOrdinal,Node> &A);

    void scale(const int &alpha);

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

    void update(const int &alpha, const MultiVector<int,int,GlobalOrdinal,Node> &A, const int &beta);

    void update(const int &alpha, const MultiVector<int,int,GlobalOrdinal,Node> &A, const int &beta, const MultiVector<int,int,GlobalOrdinal,Node> &B, const int &gamma);

    void norm1(const Teuchos::ArrayView<Teuchos::ScalarTraits<int>::magnitudeType> &norms) const;

    void norm2(const Teuchos::ArrayView<Teuchos::ScalarTraits<int>::magnitudeType> &norms) const;

    void normInf(const Teuchos::ArrayView<Teuchos::ScalarTraits<int>::magnitudeType> &norms) const;

    void normWeighted(const MultiVector<int,int,GlobalOrdinal,Node> &weights, const Teuchos::ArrayView<Teuchos::ScalarTraits<int>::magnitudeType> &norms) const;

    void meanValue(const Teuchos::ArrayView<int> &means) const;

    void maxValue(const Teuchos::ArrayView<int> &maxs) const;

    void multiply(Teuchos::ETransp transA, Teuchos::ETransp transB, const int &alpha, const MultiVector<int,int,GlobalOrdinal,Node> &A, const MultiVector<int,int,GlobalOrdinal,Node> &B, const int &beta);

    void elementWiseMultiply(int scalarAB, const Vector<int,int,GlobalOrdinal,Node> &A, const MultiVector<int,int,GlobalOrdinal,Node> &B, int scalarThis);




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

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

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

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




    size_t getNumVectors() const;

    size_t getLocalLength() const {  return vec_->MyLength(); }

    global_size_t getGlobalLength() const {  return vec_->GlobalLength64(); }




    std::string description() const;

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


    RCP< Epetra_IntVector > getEpetra_IntVector() const {  return vec_; }

    const RCP<const Comm<int> > getComm() const {
      TEUCHOS_TEST_FOR_EXCEPTION(1, Xpetra::Exceptions::NotImplemented, "TODO getComm Epetra MultiVector not implemented");
    }

    // Implementing DistObject
    Teuchos::RCP<const Map<int, GlobalOrdinal> > getMap () const {
      RCP<const Epetra_BlockMap> map = rcp(new Epetra_BlockMap(vec_->Map()));
      return rcp (new Xpetra::EpetraMapT<GlobalOrdinal>(map));
    }

    void
    doImport (const DistObject<int, int, GlobalOrdinal> &source,
              const Import<int, GlobalOrdinal> &importer, CombineMode CM);

    void
    doExport (const DistObject<int, int, GlobalOrdinal> &dest,
              const Import<int, GlobalOrdinal>& importer, CombineMode CM);

    void
    doImport (const DistObject<int, int, GlobalOrdinal> &source,
              const Export<int, GlobalOrdinal>& exporter, CombineMode CM);

    void
    doExport (const DistObject<int, int, GlobalOrdinal> &dest,
              const Export<int, GlobalOrdinal>& exporter, CombineMode CM);

    void replaceMap(const RCP<const Map<int, GlobalOrdinal> >& map) {
      // do nothing
    }

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

  private:
    RCP< Epetra_IntVector > vec_;

  }; // class EpetraIntVectorT

#ifndef XPETRA_EPETRA_NO_32BIT_GLOBAL_INDICES
  typedef EpetraIntVectorT<int> EpetraIntVector;
#endif

#ifndef XPETRA_EPETRA_NO_64BIT_GLOBAL_INDICES
  typedef EpetraIntVectorT<long long> EpetraIntVector64;
#endif

} // namespace Xpetra

#endif // XPETRA_EPETRAINTVECTOR_HPP