Ifpack2_Details_MultiVectorLocalGatherScatter.hpp

Go to the documentation of this file.

/*@HEADER
// ***********************************************************************
//
//       Ifpack2: Templated Object-Oriented Algebraic Preconditioner Package
//                 Copyright (2009) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// 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 Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
//@HEADER
*/

#ifndef IFPACK2_DETAILS_MULTIVECTORLOCALGATHERSCATTER_HPP
#define IFPACK2_DETAILS_MULTIVECTORLOCALGATHERSCATTER_HPP


#include "Tpetra_MultiVector.hpp"
#include "Tpetra_Map.hpp"

namespace Ifpack2 {
namespace Details {

template<class MV_in, class MV_out>
class MultiVectorLocalGatherScatter {
public:
  typedef typename MV_in::scalar_type InScalar;
  typedef typename MV_out::scalar_type OutScalar;
  typedef typename MV_in::local_ordinal_type LO;
  typedef typename MV_in::global_ordinal_type GO;
  typedef typename MV_in::node_type NO;

  /**************/
  /* MV <==> MV */
  /**************/
  void
  gather (MV_out& X_out,
          const MV_in& X_in,
          const Teuchos::ArrayView<const LO> perm) const
  {
    using Teuchos::ArrayRCP;
    const size_t numRows = X_out.getLocalLength ();
    const size_t numVecs = X_in.getNumVectors ();
    for (size_t j = 0; j < numVecs; ++j) {
      ArrayRCP<const InScalar> X_in_j = X_in.getData(j);
      ArrayRCP<OutScalar> X_out_j = X_out.getDataNonConst(j);
      for (size_t i = 0; i < numRows; ++i) {
        const size_t i_perm = perm[i];
        X_out_j[i] = X_in_j[i_perm];
      }
    }
  }

  //Gather blocks (contiguous groups of blockSize rows)
  //X_out and X_in are point indexed, but perm uses block indices.
  //So X_out.getLocalLength() / blockSize gives the number of blocks.
  void
  gatherBlock (
        MV_out& X_out,
        const MV_in& X_in,
        const Teuchos::ArrayView<const LO> perm,
        LO blockSize) const
  {
    using Teuchos::ArrayRCP;
    const size_t numBlocks = X_out.getLocalLength() / blockSize;
    const size_t numVecs = X_in.getNumVectors ();
    for (size_t j = 0; j < numVecs; ++j) {
      ArrayRCP<const InScalar> X_in_j = X_in.getData(j);
      ArrayRCP<OutScalar> X_out_j = X_out.getDataNonConst(j);
      for (size_t i = 0; i < numBlocks; ++i) {
        const size_t i_perm = perm[i];
        for (LO k = 0; k < blockSize; k++) {
          X_out_j[i * blockSize + k] = X_in_j[i_perm * blockSize + k];
        }
      }
    }
  }

  void
  scatter (MV_in& X_in,
           const MV_out& X_out,
           const Teuchos::ArrayView<const LO> perm) const
  {
    using Teuchos::ArrayRCP;
    const size_t numRows = X_out.getLocalLength();
    const size_t numVecs = X_in.getNumVectors();
    for (size_t j = 0; j < numVecs; ++j) {
      ArrayRCP<InScalar> X_in_j = X_in.getDataNonConst(j);
      ArrayRCP<const OutScalar> X_out_j = X_out.getData(j);
      for (size_t i = 0; i < numRows; ++i) {
        const size_t i_perm = perm[i];
        X_in_j[i_perm] = X_out_j[i];
      }
    }
  }

  void
  scatterBlock (
        MV_in& X_in,
        const MV_out& X_out,
        const Teuchos::ArrayView<const LO> perm,
        LO blockSize) const
  {
    using Teuchos::ArrayRCP;
    const size_t numBlocks = X_out.getLocalLength() / blockSize;
    const size_t numVecs = X_in.getNumVectors ();
    for (size_t j = 0; j < numVecs; ++j) {
      ArrayRCP<const InScalar> X_in_j = X_in.getData(j);
      ArrayRCP<OutScalar> X_out_j = X_out.getDataNonConst(j);
      for (size_t i = 0; i < numBlocks; ++i) {
        const size_t i_perm = perm[i];
        for (LO k = 0; k < blockSize; k++) {
           X_in_j[i_perm * blockSize + k] = X_out_j[i * blockSize + k];
        }
      }
    }
  }

  /******************/
  /* View <==> View */
  /******************/
  template<typename InView, typename OutView>
  void gatherViewToView(OutView X_out,
                        const InView X_in,
                        const Teuchos::ArrayView<const LO> perm) const
  {
    //note: j is col, i is row
    for(size_t j = 0; j < X_out.extent(1); ++j) {
      for(size_t i = 0; i < X_out.extent(0); ++i) {
        const LO i_perm = perm[i];
        X_out(i, j) = X_in(i_perm, j);
      }
    }
  }

  template<typename InView, typename OutView>
  void scatterViewToView(InView X_in,
                         const OutView X_out,
                         const Teuchos::ArrayView<const LO> perm) const
  {
    for(size_t j = 0; j < X_out.extent(1); ++j) {
      for(size_t i = 0; i < X_out.extent(0); ++i) {
        const LO i_perm = perm[i];
        X_in(i_perm, j) = X_out(i, j);
      }
    }
  }

  template<typename InView, typename OutView>
  void gatherViewToViewBlock(OutView X_out,
                             const InView X_in,
                             const Teuchos::ArrayView<const LO> perm,
                             LO blockSize) const
  {
    //note: j is col, i is row
    size_t numBlocks = X_out.extent(0) / blockSize;
    for(size_t j = 0; j < X_out.extent(1); ++j) {
      for(size_t i = 0; i < numBlocks; ++i) {
        const LO i_perm = perm[i];
        for(LO k = 0; k < blockSize; k++) {
          X_out(i * blockSize + k, j) = X_in(i_perm * blockSize + k, j);
        }
      }
    }
  }

  template<typename InView, typename OutView>
  void scatterViewToViewBlock(InView X_in,
                              const OutView X_out,
                              const Teuchos::ArrayView<const LO> perm,
                              LO blockSize) const
  {
    //note: j is col, i is row
    size_t numBlocks = X_out.extent(0) / blockSize;
    for(size_t j = 0; j < X_out.extent(1); ++j) {
      for(size_t i = 0; i < numBlocks; ++i) {
        const LO i_perm = perm[i];
        for(LO k = 0; k < blockSize; k++) {
          X_in(i_perm * blockSize + k, j) = X_out(i * blockSize + k, j);
        }
      }
    }
  }

  /*******************************/
  /* MV <==> View specialization */
  /*******************************/
  template<typename InView>
  void gatherMVtoView(MV_out X_out,
                      InView X_in,
                      const Teuchos::ArrayView<const LO> perm) const
  {
    //note: j is col, i is row
    size_t numRows = X_out.getLocalLength();
    for(size_t j = 0; j < X_out.getNumVectors(); ++j) {
      Teuchos::ArrayRCP<OutScalar> X_out_j = X_out.getDataNonConst(j);
      for(size_t i = 0; i < numRows; ++i) {
        const LO i_perm = perm[i];
        X_out_j[i] = X_in(i_perm, j);
      }
    }
  }

  template<typename InView>
  void scatterMVtoView(InView X_in,
                       MV_out X_out,
                       const Teuchos::ArrayView<const LO> perm) const
  {
    size_t numRows = X_out.getLocalLength(); 
    for(size_t j = 0; j < X_in.extent(1); ++j) {
      Teuchos::ArrayRCP<const OutScalar> X_out_j = X_out.getData(j);
      for(size_t i = 0; i < numRows; ++i) {
        const LO i_perm = perm[i];
        X_in(i_perm, j) = X_out_j[i];
      }
    }
  }

  template<typename InView>
  void gatherMVtoViewBlock(MV_out X_out,
                           InView X_in,
                           const Teuchos::ArrayView<const LO> perm,
                           LO blockSize) const
  {
    //note: j is col, i is row
    size_t numBlocks = X_out.getLocalLength() / blockSize;
    for(size_t j = 0; j < X_out.getNumVectors(); ++j) {
      Teuchos::ArrayRCP<OutScalar> X_out_j = X_out.getDataNonConst(j);
      for(size_t i = 0; i < numBlocks; ++i) {
        const LO i_perm = perm[i];
        for(LO k = 0; k < blockSize; k++) {
          X_out_j[i * blockSize + k] = X_in(i_perm * blockSize + k, j);
        }
      }
    }
  }

  template<typename InView>
  void scatterMVtoViewBlock(InView X_in,
                            MV_out X_out,
                            const Teuchos::ArrayView<const LO> perm,
                            LO blockSize) const
  {
    size_t numBlocks = X_out.getLocalLength() / blockSize;
    for(size_t j = 0; j < X_in.extent(1); ++j) {
      Teuchos::ArrayRCP<const OutScalar> X_out_j = X_out.getData(j);
      for(size_t i = 0; i < numBlocks; ++i) {
        const LO i_perm = perm[i];
        for(LO k = 0; k < blockSize; k++) {
          X_in(i_perm * blockSize + k, j) = X_out_j[i * blockSize + k];
        }
      }
    }
  }
};

} // namespace Details
} // namespace Ifpack2

#endif // IFPACK2_DETAILS_MULTIVECTORLOCALGATHERSCATTER_HPP