PEXSI
 All Classes Namespaces Files Functions Variables Typedefs Pages
superlu_dist_internal.hpp
Go to the documentation of this file.
1 /*
2  Copyright (c) 2012 The Regents of the University of California,
3  through Lawrence Berkeley National Laboratory.
4 
5  Author: Mathias Jacquelin and Lin Lin
6 
7  This file is part of PEXSI. All rights reserved.
8 
9  Redistribution and use in source and binary forms, with or without
10  modification, are permitted provided that the following conditions are met:
11 
12  (1) Redistributions of source code must retain the above copyright notice, this
13  list of conditions and the following disclaimer.
14  (2) Redistributions in binary form must reproduce the above copyright notice,
15  this list of conditions and the following disclaimer in the documentation
16  and/or other materials provided with the distribution.
17  (3) Neither the name of the University of California, Lawrence Berkeley
18  National Laboratory, U.S. Dept. of Energy nor the names of its contributors may
19  be used to endorse or promote products derived from this software without
20  specific prior written permission.
21 
22  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
23  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
24  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
26  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
27  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
29  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 
33  You are under no obligation whatsoever to provide any bug fixes, patches, or
34  upgrades to the features, functionality or performance of the source code
35  ("Enhancements") to anyone; however, if you choose to make your Enhancements
36  available either publicly, or directly to Lawrence Berkeley National
37  Laboratory, without imposing a separate written license agreement for such
38  Enhancements, then you hereby grant the following license: a non-exclusive,
39  royalty-free perpetual license to install, use, modify, prepare derivative
40  works, incorporate into other computer software, distribute, and sublicense
41  such enhancements or derivative works thereof, in binary and source code form.
42  */
46 
47 #ifndef _PEXSI_SUPERLU_INTERNAL_HPP_
48 #define _PEXSI_SUPERLU_INTERNAL_HPP_
49 
50 #include "pexsi/environment.hpp"
51 #include <string>
52 #include "pexsi/sparse_matrix.hpp"
53 #include "pexsi/NumMat.hpp"
54 #include "pexsi/NumVec.hpp"
55 #include "pexsi/SuperLUGrid.hpp"
56 
57 namespace PEXSI{
69 
84  std::string ColPerm;
85 
95  std::string RowPerm;
96 
105  std::string Equil;
106 
109 
114 
115 
116  // Member functions to setup the default value
117  SuperLUOptions(): numProcSymbFact(0), ColPerm("MMD_AT_PLUS_A"), Symmetric(1), RowPerm("NOROWPERM"), Transpose(0), Equil("NO") {}
118  };
119 
120 
121  struct SuperNodeType;
122  template<typename T> class PMatrix;
123 
124 class ComplexSuperLUData_internal;
125 class RealSuperLUData_internal;
126 
128  protected:
129  RealSuperLUData_internal * ptrData;
130  public:
131  RealSuperLUData( const SuperLUGrid<Real>& g, const SuperLUOptions& opt );
132  ~RealSuperLUData();
133  RealSuperLUData(const RealSuperLUData & g);
134  RealSuperLUData & operator = (const RealSuperLUData & g);
135 
136  Int m() const;
137  Int n() const;
138  void DistSparseMatrixToSuperMatrixNRloc( DistSparseMatrix<Real>& sparseA , const SuperLUOptions& opt);
139  void DestroyAOnly();
140  void SymbolicFactorize();
141  void Distribute();
142  void NumericalFactorize();
143  void ConvertNRlocToNC ( RealSuperLUData * aptrData );
144  void MultiplyGlobalMultiVector( NumMat<Real>& xGlobal, NumMat<Real>& bGlobal );
145  void DistributeGlobalMultiVector( NumMat<Real>& xGlobal, NumMat<Real>& xLocal );
146  void GatherDistributedMultiVector ( NumMat<Real>& xGlobal, NumMat<Real>& xLocal );
147  void SolveDistMultiVector( NumMat<Real>& bLocal, DblNumVec& berr );
148  void CheckErrorDistMultiVector( NumMat<Real>& xLocal, NumMat<Real>& xTrueLocal );
149  void LUstructToPMatrix( PMatrix<Real>& PMloc );
150  void SymbolicToSuperNode( SuperNodeType& super );
151 };
152 
153 
155  protected:
156  ComplexSuperLUData_internal * ptrData;
157  public:
161  ComplexSuperLUData & operator = (const ComplexSuperLUData & g);
162 
163  Int m() const;
164  Int n() const;
165  void DistSparseMatrixToSuperMatrixNRloc( DistSparseMatrix<Complex>& sparseA , const SuperLUOptions& opt);
166  void DestroyAOnly();
167  void SymbolicFactorize();
168  void Distribute();
169  void NumericalFactorize();
170  void ConvertNRlocToNC ( ComplexSuperLUData * aptrData );
171  void MultiplyGlobalMultiVector( NumMat<Complex>& xGlobal, NumMat<Complex>& bGlobal );
172  void DistributeGlobalMultiVector( NumMat<Complex>& xGlobal, NumMat<Complex>& xLocal );
173  void GatherDistributedMultiVector ( NumMat<Complex>& xGlobal, NumMat<Complex>& xLocal );
174  void SolveDistMultiVector( NumMat<Complex>& bLocal, DblNumVec& berr );
175  void CheckErrorDistMultiVector( NumMat<Complex>& xLocal, NumMat<Complex>& xTrueLocal );
176  void LUstructToPMatrix( PMatrix<Complex>& PMloc );
177  void SymbolicToSuperNode( SuperNodeType& super );
178 };
179 
180 
181 }
182 
183 
184 
185 #endif //_PEXSI_SUPERLU_INTERNAL_HPP_
Environmental variables.
Definition: superlu_dist_internal_real.cpp:130
A thin interface for passing parameters to set the SuperLU options.
Definition: superlu_dist_internal.hpp:62
std::string RowPerm
Option of matrix row permutation strategy.
Definition: superlu_dist_internal.hpp:95
SuperNodeType describes mapping between supernode and column, the permutation information, and potentially the elimination tree (not implemented here).
Definition: pselinv.hpp:166
Definition: superlu_dist_internal.hpp:154
Int Symmetric
Option to specify if matrix is symmetric or not.
Definition: superlu_dist_internal.hpp:108
Definition: superlu_dist_internal_complex.cpp:139
SuperLU processor grid.
std::string Equil
Option whether to equilibrate the system.
Definition: superlu_dist_internal.hpp:105
Sparse matrix and Distributed sparse matrix in compressed column format.
Numerical matrix.
Definition: superlu_dist_internal.hpp:127
Numerical matrix.
Definition: NumMat.hpp:61
std::string ColPerm
Option of matrixi column permutation strategy.
Definition: superlu_dist_internal.hpp:84
Int numProcSymbFact
Number of processors for parallel symbolic factorization.
Definition: superlu_dist_internal.hpp:68
Definition: SuperLUGrid.hpp:124
Definition: SuperLUGrid.hpp:111
Numerical vector.
Int Transpose
Option to specify whether selected elements should be computed in the pattern of the transposed matri...
Definition: superlu_dist_internal.hpp:113