SuperLUMatrix.hpp

Go to the documentation of this file.

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

    Author: Mathias Jacquelin and Lin Lin

    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_SUPERLUMATRIX_HPP_
#define _PEXSI_SUPERLUMATRIX_HPP_

// Interface with PSelInv
#include "pexsi/pselinv.hpp"

// Interface with sparse matrix (CSC format)
#include "pexsi/sparse_matrix.hpp"

// Interface with LAPACK
#include "pexsi/lapack.hpp"


#include "pexsi/superlu_dist_internal.hpp"
#include "pexsi/SuperLUGrid.hpp"
//#include "pexsi/SuperLUData.hpp"

namespace PEXSI{


  struct SuperNodeType;
  template<typename T>  class PMatrix;



  template<typename T> class SuperLUMatrix{
    private:
      void *  ptrData;


    public:

      SuperLUMatrix( const SuperLUGrid<T>& g, const SuperLUOptions& opt = SuperLUOptions() ){ }
      ~SuperLUMatrix(){ }
      SuperLUMatrix(const SuperLUMatrix & g){};
      SuperLUMatrix & operator = (const SuperLUMatrix & g){};

      Int m() const {return -1;}

      Int n() const { return -1;}

      void DistSparseMatrixToSuperMatrixNRloc( DistSparseMatrix<T>& sparseA , const SuperLUOptions & options){ }

      void DestroyAOnly(){ }

      void SymbolicFactorize(){ }

      void Distribute(){ }

      void NumericalFactorize(){ }

      void ConvertNRlocToNC( SuperLUMatrix<T>& AGlobal ){ }

      void MultiplyGlobalMultiVector( NumMat<T>& xGlobal, NumMat<T>& bGlobal ){ }

      void DistributeGlobalMultiVector( NumMat<T>& xGlobal, NumMat<T>& xLocal ){ }

      void GatherDistributedMultiVector ( NumMat<T>& xGlobal, NumMat<T>& xLocal ){ }

      void SolveDistMultiVector( NumMat<T>& bLocal, DblNumVec& berr ){ }


      void CheckErrorDistMultiVector( NumMat<T>& xLocal, NumMat<T>& xTrueLocal ){
      } 
      void LUstructToPMatrix( PMatrix<T>& PMloc ){ }

      void SymbolicToSuperNode( SuperNodeType& super ){ }
  };

  template< > class SuperLUMatrix<Real>{
    private:
      RealSuperLUData*  ptrData;

    public:

      SuperLUMatrix();
      SuperLUMatrix( const SuperLUGrid<Real>& g, const SuperLUOptions& opt = SuperLUOptions() ); 
      ~SuperLUMatrix();
      SuperLUMatrix(const SuperLUMatrix & g);
      SuperLUMatrix & operator = (const SuperLUMatrix & g);

      void Setup( const SuperLUGrid<Real>& g, const SuperLUOptions& opt = SuperLUOptions() );

      Int m() const;
      Int n() const;

      void DistSparseMatrixToSuperMatrixNRloc( DistSparseMatrix<Real>& sparseA , const SuperLUOptions & opt);

      void DestroyAOnly();

      void SymbolicFactorize();

      void Distribute();

      void NumericalFactorize();

      void ConvertNRlocToNC( SuperLUMatrix<Real>& AGlobal );

      void MultiplyGlobalMultiVector( NumMat<Real>& xGlobal, NumMat<Real>& bGlobal );

      void DistributeGlobalMultiVector( NumMat<Real>& xGlobal, NumMat<Real>& xLocal );

      void GatherDistributedMultiVector ( NumMat<Real>& xGlobal, NumMat<Real>& xLocal );

      void SolveDistMultiVector( NumMat<Real>& bLocal, DblNumVec& berr );

      void CheckErrorDistMultiVector( NumMat<Real>& xLocal, NumMat<Real>& xTrueLocal );

      void LUstructToPMatrix( PMatrix<Real>& PMloc );

      void SymbolicToSuperNode( SuperNodeType& super );
  };

  template< > class SuperLUMatrix<Complex>{
    private:
      ComplexSuperLUData*  ptrData;
      

    public:

      SuperLUMatrix();
      SuperLUMatrix( const SuperLUGrid<Complex>& g, const SuperLUOptions& opt = SuperLUOptions() );
      ~SuperLUMatrix();
      SuperLUMatrix(const SuperLUMatrix & g);
      SuperLUMatrix & operator = (const SuperLUMatrix & g);
      
      void Setup( const SuperLUGrid<Complex>& g, const SuperLUOptions& opt = SuperLUOptions() );

      Int m() const;
      Int n() const;

      void DistSparseMatrixToSuperMatrixNRloc( DistSparseMatrix<Complex>& sparseA , const SuperLUOptions & options);

      void DestroyAOnly();

      void SymbolicFactorize();

      void Distribute();

      void NumericalFactorize();

      void ConvertNRlocToNC( SuperLUMatrix<Complex>& AGlobal );

      void MultiplyGlobalMultiVector( NumMat<Complex>& xGlobal, NumMat<Complex>& bGlobal );

      void DistributeGlobalMultiVector( NumMat<Complex>& xGlobal, NumMat<Complex>& xLocal );

      void GatherDistributedMultiVector ( NumMat<Complex>& xGlobal, NumMat<Complex>& xLocal );

      void SolveDistMultiVector( NumMat<Complex>& bLocal, DblNumVec& berr );


      void CheckErrorDistMultiVector( NumMat<Complex>& xLocal, NumMat<Complex>& xTrueLocal );

      void LUstructToPMatrix( PMatrix<Complex>& PMloc );

      void SymbolicToSuperNode( SuperNodeType& super );
  };

  } // namespace PEXSI

#include "pexsi/SuperLUMatrix_impl.hpp"

#endif // _PEXSI_SUPERLUMATRIX_HPP_