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 "pexsi/environment.hpp"
#include "pexsi/NumVec.hpp"
#include "pexsi/NumMat.hpp" 
#include "pexsi/sparse_matrix.hpp"

#include "pexsi/superlu_dist_interf.hpp"
#include "pexsi/mpi_interf.hpp"
#include "pexsi/utility.hpp"
#include "pexsi/blas.hpp"
#include "pexsi/lapack.hpp"

#include "pexsi/TreeBcast.hpp"


#include <set>


//#define IDX_TO_TAG(lidx,tag) (SELINV_TAG_COUNT*(lidx)+(tag)) 
#define IDX_TO_TAG(lidx,tag,max) ((SELINV_TAG_COUNT*(lidx%(max+1))+(tag)))
#define IDX_TO_TAG2(sidx,lidx,tag) (SELINV_TAG_COUNT*(sidx)+(tag)) 
#define TAG_TO_IDX(tag,typetag) (((tag)-(typetag))/SELINV_TAG_COUNT) 


//#define LIST_BARRIER
//#define ALL_BARRIER

namespace PEXSI{

enum MSGTYPE {LSIZE=0,LROWSIZE,USIZE,UCOLSIZE,LCONTENT,LROWCONTENT,UCONTENT,UCOLCONTENT,MSGCOUNT};

struct ULComparator {
  IntNumVec & lookup;
  ULComparator(IntNumVec & v):lookup(v){}
  bool operator() (int i,int j) { return ((lookup)(i)<(lookup)(j));}
};



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





struct PSelInvOptions{
  Int              maxPipelineDepth; 

  // Member functions to setup the default value
  PSelInvOptions(): maxPipelineDepth(-1) {}
};


struct FactorizationOptions{
  std::string ColPerm;
  std::string RowPerm;
  Int Symmetric;

  // Member functions to setup the default value
  FactorizationOptions(): Symmetric(1) {}
};





/**********************************************************************
 * 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   perm_r;              
  IntNumVec   permInv_r;
  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; 
    nzval.Resize(0,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){
  if(mask[LBlockMask::BLOCKIDX]==1) serialize(val.blockIdx, os, mask);
  if(mask[LBlockMask::NUMROW  ]==1) serialize(val.numRow,  os, mask);
  if(mask[LBlockMask::NUMCOL  ]==1) serialize(val.numCol,  os, mask);
  if(mask[LBlockMask::ROWS    ]==1) serialize(val.rows, os, mask); 
  if(mask[LBlockMask::NZVAL   ]==1) serialize(val.nzval, os, mask); 
  return 0;
}

template<typename T>
Int inline deserialize(LBlock<T>& val, std::istream& is, const std::vector<Int>& mask){
  if(mask[LBlockMask::BLOCKIDX]==1) deserialize(val.blockIdx, is, mask);
  if(mask[LBlockMask::NUMROW  ]==1) deserialize(val.numRow,  is, mask);
  if(mask[LBlockMask::NUMCOL  ]==1) deserialize(val.numCol,  is, mask);
  if(mask[LBlockMask::ROWS    ]==1) deserialize(val.rows,   is, mask);
  if(mask[LBlockMask::NZVAL   ]==1) deserialize(val.nzval,  is, mask);
  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{
public:

  static PMatrix<T> * Create(const GridType * pGridType, const SuperNodeType * pSuper, const PSelInvOptions * pSelInvOpt , const FactorizationOptions * pFactOpt);
  static PMatrix<T> * Create(const FactorizationOptions * pFactOpt);

public:
  // 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_L_SIZE_CD,
    SELINV_TAG_L_CONTENT_CD,
    SELINV_TAG_COUNT
  };


  std::vector<std::vector<Int> > ColBlockIdx_;
  std::vector<std::vector<Int> > RowBlockIdx_;
protected:
  // *********************************************************************
  // Variables
  // *********************************************************************
  // Data variables

  const GridType*       grid_;

  const SuperNodeType*  super_;

  const PSelInvOptions * options_;
  const FactorizationOptions * optionsFact_;

  Int limIndex_;
  Int maxTag_;

  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_;


#ifdef NEW_BCAST
  std::vector<TreeBcast2<T> *> fwdToBelowTree2_; 
  std::vector<TreeBcast2<T> *> fwdToRightTree2_; 
#endif
  std::vector<TreeBcast *> fwdToBelowTree_; 
  std::vector<TreeBcast *> fwdToRightTree_; 
  std::vector<TreeReduce<T> *> redToLeftTree_; 
  std::vector<TreeReduce<T> *> redToAboveTree_; 



  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               Rank;
    Int               isReady;


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

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

  };


  inline void SelInvIntra_P2p(Int lidx,Int & rank);

  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);

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

  PMatrix();

  PMatrix( const GridType* g, const SuperNodeType* s, const PEXSI::PSelInvOptions * o, const PEXSI::FactorizationOptions * oFact  );

  void deallocate();


  virtual ~PMatrix();
  PMatrix( const PMatrix & C);
  PMatrix & operator = ( const PMatrix & C);

  void Setup( const GridType* g, const SuperNodeType* s, const PEXSI::PSelInvOptions * o, const PEXSI::FactorizationOptions * oFact  );

  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_; }         
  //void WorkingSet(const std::vector<std::vector<int> > * pWSet,const std::vector<std::vector<int> > * pWRanks) { pWSet = &workingSet_; pWRanks = &workingRanks_; }    

  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 CountSendToBelow(Int ksup) {  Int count= std::count (isSendToBelow_.VecData(ksup), isSendToBelow_.VecData(ksup) + grid_->numProcRow, true); return (isSendToBelow_(MYROW(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 );


  virtual void ConstructCommunicationPattern( );


  void ConstructCommunicationPattern_P2p( );



  virtual void PreSelInv( );

  virtual void SelInv( );

  void SelInv_P2p( );


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


  void PMatrixToDistSparseMatrix( DistSparseMatrix<T>& A );

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


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


  Int  NnzLocal();

  LongInt  Nnz();

  void GetNegativeInertia       ( Real& inertia );

  //      inline int IdxToTag(Int lidx, Int tag) { return SELINV_TAG_COUNT*(lidx)+(tag);}

  void DumpLU();      

  void CopyLU( const PMatrix & C);
  inline int IdxToTag(Int lidx, Int tag) { return SELINV_TAG_COUNT*(lidx)+(tag);}
};

template<typename T>  class PMatrixUnsym;


} // namespace PEXSI


#include "pexsi/pselinv_impl.hpp"


#endif //_PEXSI_PSELINV_HPP_