pselinv.hpp

Go to the documentation of this file.

/*
   Copyright (c) 2012 The Regents of the University of California,
   through Lawrence Berkeley National Laboratory.  

   Authors: Lin Lin and Mathias Jacquelin

   This file is part of PEXSI. All rights reserved.

   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 University of California, Lawrence Berkeley
   National Laboratory, U.S. Dept. of Energy nor the names of its contributors may
   be used to endorse or promote products derived from this software without
   specific prior written permission.

   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT OWNER OR 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.

   You are under no obligation whatsoever to provide any bug fixes, patches, or
   upgrades to the features, functionality or performance of the source code
   ("Enhancements") to anyone; however, if you choose to make your Enhancements
   available either publicly, or directly to Lawrence Berkeley National
   Laboratory, without imposing a separate written license agreement for such
   Enhancements, then you hereby grant the following license: a non-exclusive,
   royalty-free perpetual license to install, use, modify, prepare derivative
   works, incorporate into other computer software, distribute, and sublicense
   such enhancements or derivative works thereof, in binary and source code form.
*/
#ifndef _PEXSI_PSELINV_HPP_
#define _PEXSI_PSELINV_HPP_

// *********************************************************************
//  Common utilities
// *********************************************************************

#include  "environment.hpp"
#include        "NumVec.hpp"
#include        "NumMat.hpp" 
#include  "sparse_matrix.hpp"

#include  "superlu_dist_interf.hpp"
#include  "mpi_interf.hpp"
#include        "utility.hpp"
#include        "blas.hpp"
#include        "lapack.hpp"
#include <set>


namespace PEXSI{


  typedef std::vector<bool> bitMask;
  typedef std::map<bitMask , std::vector<Int> > bitMaskSet;


  /**********************************************************************
   * Basic PSelInv data structure
   **********************************************************************/

  struct GridType{
    // Data
    MPI_Comm    comm;
    MPI_Comm    rowComm;
    MPI_Comm    colComm;
    Int         mpirank;
    Int         mpisize; 
    Int         numProcRow;
    Int         numProcCol;

    // Member function
    GridType( MPI_Comm Bcomm, int nprow, int npcol );
    ~GridType();
  };

  struct SuperNodeType{
    IntNumVec   perm;              
    IntNumVec   permInv;
    IntNumVec   superIdx;
    IntNumVec   superPtr;
    IntNumVec   etree;
  };


  template<typename T>
  struct LBlock{
    // Variables
    Int               blockIdx;

    Int               numRow;

    Int               numCol;

    IntNumVec         rows;

    NumMat<T>    nzval;

    // Member functions;
    LBlock() {blockIdx = -1; numRow = 0; numCol =0;}
    ~LBlock() {}
    LBlock& operator = (const LBlock& LB) {
      blockIdx    = LB.blockIdx;
      numRow      = LB.numRow;
      numCol      = LB.numCol;
      rows        = LB.rows;
      nzval       = LB.nzval;
      return *this;
    }
    friend std::ostream& operator<<(std::ostream& out, const LBlock& vec) // output
    {
      out << "(" << vec.blockIdx << ", " << vec.numRow << ", " << vec.numCol <<std::endl<< "rows " << vec.rows <<std::endl<< "nzval " <<std::endl<< vec.nzval << ")";
      return out;
    }


  };

  template<typename T>
  struct UBlock{
    // Variables
    Int               blockIdx;

    Int               numRow;

    Int               numCol;

    IntNumVec         cols;

    NumMat<T>    nzval;

    // Member functions;
    UBlock() {blockIdx = -1; numRow = 0; numCol =0;}
    ~UBlock() {}
    UBlock& operator = (const UBlock& UB) {
      blockIdx    = UB.blockIdx;
      numRow      = UB.numRow;
      numCol      = UB.numCol;
      cols        = UB.cols;
      nzval       = UB.nzval;
      return *this;
    }

    friend std::ostream& operator<<(std::ostream& out, const UBlock& vec) // output
    { 
      out << "(" << vec.blockIdx << ", " << vec.numRow << ", " << vec.numCol <<std::endl<< "cols " << vec.cols <<std::endl<< "nzval " <<std::endl<< vec.nzval << ")";
      return out;
    }
  };

  // *********************************************************************
  // SuperLU style utility functions
  // 
  // The SuperLU style macros are defined here as inline functions 
  // so that the code is more portable.
  // *********************************************************************

  inline Int MYPROC( const GridType* g )
  { return g->mpirank; }

  inline Int MYROW( const GridType* g )
  { return g->mpirank / g->numProcCol; }

  inline Int MYCOL( const GridType* g )
  { return g->mpirank % g->numProcCol; }

  inline Int PROW( Int bnum, const GridType* g ) 
  { return bnum % g->numProcRow; }

  inline Int PCOL( Int bnum, const GridType* g ) 
  { return bnum % g->numProcCol; }

  inline Int PNUM( Int i, Int j, const GridType* g )
  { return  (i%g->numProcRow) * g->numProcCol + j%g->numProcCol; }

  inline Int LBi( Int bnum, const GridType* g )
  { return bnum / g->numProcRow; }

  inline Int LBj( Int bnum, const GridType* g)
  { return bnum / g->numProcCol; }

  inline Int GBi( Int iLocal, const GridType* g )
  { return iLocal * g->numProcRow + MYROW( g ); }

  inline Int GBj( Int jLocal, const GridType* g )
  { return jLocal * g->numProcCol + MYCOL( g ); }

  inline Int CEILING( Int a, Int b )
  { return (a%b) ? ( a/b + 1 ) : ( a/b ); }

  inline Int BlockIdx( Int i, const SuperNodeType *s )
  { return s->superIdx[i]; }

  inline Int FirstBlockCol( Int bnum, const SuperNodeType *s )
  { return s->superPtr[bnum]; } 


  inline Int FirstBlockRow( Int bnum, const SuperNodeType *s )
  { return s->superPtr[bnum]; } 


  inline Int SuperSize( Int bnum, const SuperNodeType *s )
  { return s->superPtr[bnum+1] - s->superPtr[bnum]; } 

  inline Int NumSuper( const SuperNodeType *s )
  { return s->superPtr.m() - 1; }

  inline Int NumCol( const SuperNodeType *s )
  { return s->superIdx.m(); }


  // *********************************************************************
  // Serialize / Deserialize
  // *********************************************************************

  // L part

  namespace LBlockMask{
    enum {
      BLOCKIDX,
      NUMROW,
      NUMCOL,
      ROWS,
      NZVAL,
      TOTAL_NUMBER
    };
  }

  
  template<typename T>
  Int inline serialize(LBlock<T>& val, std::ostream& os, const std::vector<Int>& mask){
    Int i = 0;
    if(mask[i]==1) serialize(val.blockIdx, os, mask); i++;
    if(mask[i]==1) serialize(val.numRow,  os, mask); i++;
    if(mask[i]==1) serialize(val.numCol,  os, mask); i++;
    if(mask[i]==1) serialize(val.rows, os, mask);   i++;
    if(mask[i]==1) serialize(val.nzval, os, mask);  i++;
    return 0;
  }

  template<typename T>
  Int inline deserialize(LBlock<T>& val, std::istream& is, const std::vector<Int>& mask){
    Int i = 0;
    if(mask[i]==1) deserialize(val.blockIdx, is, mask); i++;
    if(mask[i]==1) deserialize(val.numRow,  is, mask); i++;
    if(mask[i]==1) deserialize(val.numCol,  is, mask); i++;
    if(mask[i]==1) deserialize(val.rows,   is, mask); i++;
    if(mask[i]==1) deserialize(val.nzval,  is, mask); i++; 
    return 0;
  }

  // U part
  namespace UBlockMask{
    enum {
      BLOCKIDX,
      NUMROW,
      NUMCOL,
      COLS,
      NZVAL,
      TOTAL_NUMBER
    };
  }

  template<typename T>
  Int inline serialize(UBlock<T>& val, std::ostream& os, const std::vector<Int>& mask){
    Int i = 0;
    if(mask[i]==1) serialize(val.blockIdx, os, mask); i++;
    if(mask[i]==1) serialize(val.numRow,  os, mask); i++;
    if(mask[i]==1) serialize(val.numCol,  os, mask); i++;
    if(mask[i]==1) serialize(val.cols, os, mask);   i++;
    if(mask[i]==1) serialize(val.nzval, os, mask);  i++;
    return 0;
  }

  template<typename T>
  Int inline deserialize(UBlock<T>& val, std::istream& is, const std::vector<Int>& mask){
    Int i = 0;
    if(mask[i]==1) deserialize(val.blockIdx, is, mask); i++;
    if(mask[i]==1) deserialize(val.numRow,  is, mask); i++;
    if(mask[i]==1) deserialize(val.numCol,  is, mask); i++;
    if(mask[i]==1) deserialize(val.cols,   is, mask); i++;
    if(mask[i]==1) deserialize(val.nzval,  is, mask); i++; 
    return 0;
  }


  /**********************************************************************
   * Main data structure in PSelInv: PMatrix
   **********************************************************************/


  template<typename T>
  class PMatrix{

    private:
      // *********************************************************************
      // Variables
      // *********************************************************************
      // Data variables

      const GridType*       grid_;

      const SuperNodeType*  super_;

      const SuperLUOptions * options_;

      std::vector<std::vector<Int> > ColBlockIdx_;
      std::vector<std::vector<Int> > RowBlockIdx_;
      std::vector<std::vector<LBlock<T> > > L_;
      std::vector<std::vector<UBlock<T> > > U_;

      std::vector<std::vector<Int> > workingSet_;


      // Communication variables
      BolNumMat                       isSendToBelow_;
      BolNumMat                       isSendToRight_;
      BolNumVec                       isSendToDiagonal_;
      BolNumMat                       isSendToCrossDiagonal_;

      BolNumMat                       isRecvFromBelow_;
      BolNumVec                       isRecvFromAbove_;
      BolNumVec                       isRecvFromLeft_;
      BolNumMat                       isRecvFromCrossDiagonal_;

      //Communicators for the Bcast variant

      IntNumVec maxCommSizes_;

      NumVec<Int>                       countSendToBelow_;
      bitMaskSet                        maskSendToBelow_;
      std::vector<MPI_Comm>             commSendToBelow_;
      std::vector<MPI_Comm*>            commSendToBelowPtr_;
      std::vector<Int>                  commSendToBelowRoot_;
      std::vector<bitMask *>         commSendToBelowMaskPtr_;
      std::vector<bitMask>         commSendToBelowMask_;

      NumVec<Int>                       countRecvFromBelow_;
      bitMaskSet                        maskRecvFromBelow_;
      std::vector<MPI_Comm>             commRecvFromBelow_;
      std::vector<MPI_Comm*>            commRecvFromBelowPtr_;
      std::vector<Int>                  commRecvFromBelowRoot_;

      std::vector<bitMask *>         commRecvFromBelowMaskPtr_;
      std::vector<bitMask>         commRecvFromBelowMask_;
      

      NumVec<Int>                       countSendToRight_;
      bitMaskSet                        maskSendToRight_;
      std::vector<MPI_Comm>             commSendToRight_;
      std::vector<MPI_Comm*>            commSendToRightPtr_;
      std::vector<Int>                  commSendToRightRoot_;
      std::vector<bitMask *>         commSendToRightMaskPtr_;
      std::vector<bitMask>         commSendToRightMask_;

      //NumVec<Int>                       countCrossDiag_;

      // This is the tag used for mpi communication for selinv

      enum{
        SELINV_TAG_U_SIZE,
        SELINV_TAG_U_CONTENT,
        SELINV_TAG_L_SIZE,
        SELINV_TAG_L_CONTENT,
        SELINV_TAG_L_REDUCE,
        SELINV_TAG_D_SIZE,
        SELINV_TAG_D_CONTENT,
        SELINV_TAG_D_REDUCE,
        SELINV_TAG_COUNT
      };




      struct SuperNodeBufferType{
        NumMat<T>    LUpdateBuf;
        NumMat<T>    DiagBuf;
        std::vector<Int>  RowLocalPtr;
        std::vector<Int>  BlockIdxLocal;
        std::vector<char> SstrLcolSend;
        std::vector<char> SstrUrowSend;
        std::vector<char> SstrLcolRecv;
        std::vector<char> SstrUrowRecv;
        Int               SizeSstrLcolSend;
        Int               SizeSstrUrowSend;
        Int               SizeSstrLcolRecv;
        Int               SizeSstrUrowRecv;
        Int               Index;
        Int               isReady;


        SuperNodeBufferType():
          SizeSstrLcolSend(0),
          SizeSstrUrowSend(0),
          SizeSstrLcolRecv(0),
          SizeSstrUrowRecv(0),
          Index(0), 
          isReady(0){}

        SuperNodeBufferType(Int &pIndex) :
          SizeSstrLcolSend(0),
          SizeSstrUrowSend(0),
          SizeSstrLcolRecv(0),
          SizeSstrUrowRecv(0),
          Index(pIndex),
          isReady(0) {}

      };

      inline void SelInvIntra_Collectives(Int lidx);

      inline void SelInvIntra_P2p(Int lidx);


      inline void SelInv_lookup_indexes(SuperNodeBufferType & snode, std::vector<LBlock<T> > & LcolRecv, std::vector<UBlock<T> > & UrowRecv, NumMat<T> & AinvBuf,NumMat<T> & UBuf);

      inline void GetWorkSet(std::vector<Int> & snodeEtree, std::vector<std::vector<Int> > & WSet);

      inline void UnpackData(SuperNodeBufferType & snode, std::vector<LBlock<T> > & LcolRecv, std::vector<UBlock<T> > & UrowRecv);

      inline void ComputeDiagUpdate(SuperNodeBufferType & snode);

      inline void SendRecvCD_UpdateU(std::vector<SuperNodeBufferType > & arrSuperNodes, Int stepSuper);

      void getMaxCommunicatorSizes();

      void ConstructCommunicators_Collectives(Int lidx);

      void DestructCommunicators_Collectives( );

    public:
      // *********************************************************************
      // Public member functions 
      // *********************************************************************

      PMatrix() {}

      PMatrix( const GridType* g, const SuperNodeType* s, const PEXSI::SuperLUOptions * o );

      ~PMatrix() {}

      void Setup( const GridType* g, const SuperNodeType* s, const PEXSI::SuperLUOptions * o );

      Int NumCol() const { return super_ -> superIdx.m(); }

      Int NumSuper() const { return super_ ->superPtr.m() - 1; }

      Int NumLocalBlockCol() const { return CEILING( this->NumSuper(), grid_->numProcCol ); }

      Int NumLocalBlockRow() const { return CEILING( this->NumSuper(), grid_->numProcRow); }


      std::vector< std::vector<Int> > & ColBlockIdx() { return ColBlockIdx_; }
      std::vector< std::vector<Int> > & RowBlockIdx() { return RowBlockIdx_; }
      std::vector<Int> & ColBlockIdx(Int jLocal) { return ColBlockIdx_[jLocal]; }
      std::vector<Int> & RowBlockIdx(Int iLocal) { return RowBlockIdx_[iLocal]; }


      Int NumBlockL( Int jLocal ) const { return L_[jLocal].size(); }

      Int NumBlockU( Int iLocal ) const { return U_[iLocal].size(); }

      const GridType* Grid() const { return grid_; }

      const SuperNodeType* SuperNode() const { return super_; } 

      std::vector<LBlock<T> >& L( Int jLocal ) { return L_[jLocal]; }   

      std::vector<UBlock<T> >& U( Int iLocal ) { return U_[iLocal]; }

      std::vector<std::vector<int> >& WorkingSet( ) { return workingSet_; }     

      Int CountSendToRight(Int ksup) {  Int count= std::count (isSendToRight_.VecData(ksup), isSendToRight_.VecData(ksup) + grid_->numProcCol, true); return (isSendToRight_(MYCOL(grid_),ksup)?count-1:count); }

      Int CountRecvFromBelow(Int ksup) {  Int count= std::count (isRecvFromBelow_.VecData(ksup), isRecvFromBelow_.VecData(ksup) + grid_->numProcRow, true); return (isRecvFromBelow_(MYROW(grid_),ksup)?count-1:count); }

      Int CountSendToCrossDiagonal(Int ksup) {  Int count= std::count (isSendToCrossDiagonal_.VecData(ksup), isSendToCrossDiagonal_.VecData(ksup) + grid_->numProcCol, true);  return ((isSendToCrossDiagonal_(MYCOL(grid_),ksup) && MYROW(grid_)==PROW(ksup,grid_))?count-1:count); }

      Int CountRecvFromCrossDiagonal(Int ksup) {  Int count= std::count (isRecvFromCrossDiagonal_.VecData(ksup), isRecvFromCrossDiagonal_.VecData(ksup) + grid_->numProcRow, true);  return ((isRecvFromCrossDiagonal_(MYROW(grid_),ksup) && MYCOL(grid_)==PCOL(ksup,grid_))?count-1:count); }




      void GetEtree(std::vector<Int> & etree_supno );


      void ConstructCommunicationPattern( );


      void ConstructCommunicationPattern_P2p( );

      void ConstructCommunicationPattern_Collectives( );


      void ConstructCommunicationPattern_Hybrid( );


      void PreSelInv( );

      void SelInv( );
      void SelInv_Collectives( );
      void SelInv_P2p( );
      void SelInv_Hybrid(Int threshold);


      void GetDiagonal( NumVec<T>& diag );
      void GetColumn    ( Int colIdx,  NumVec<T>& col );


      void PMatrixToDistSparseMatrix( DistSparseMatrix<T>& A );

      void PMatrixToDistSparseMatrix( 
          const DistSparseMatrix<T>& A,
          DistSparseMatrix<T>& B        );


      void PMatrixToDistSparseMatrix2( 
          const DistSparseMatrix<T>& A,
          DistSparseMatrix<T>& B );


      Int  NnzLocal();

      LongInt  Nnz();

      void GetNegativeInertia   ( Real& inertia );

  };



} // namespace PEXSI


#include "pselinv_impl.hpp"

#endif //_PEXSI_PSELINV_HPP_