-
Notifications
You must be signed in to change notification settings - Fork 0
/
README
205 lines (157 loc) · 8.72 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
SuperLU_DIST (version 4.1)
==========================
Copyright (c) 2003, The Regents of the University of California, through
Lawrence Berkeley National Laboratory (subject to receipt of any required
approvals from U.S. Dept. of Energy)
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 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.
SuperLU_DIST contains a set of subroutines to solve a sparse linear system
A*X=B. It uses Gaussian elimination with static pivoting (GESP).
Static pivoting is a technique that combines the numerical stability of
partial pivoting with the scalability of Cholesky (no pivoting),
to run accurately and efficiently on large numbers of processors.
SuperLU_DIST is a parallel extension to the serial SuperLU library.
It is targeted for the distributed memory parallel machines.
SuperLU_DIST is implemented in ANSI C, and MPI for communications.
Currently, the LU factorization and triangular solution routines,
which are the most time-consuming part of the solution process,
are parallelized. The other routines, such as static pivoting and
column preordering for sparsity are performed sequentially.
This "alpha" release contains double-precision real and double-precision
complex data types.
The distribution contains the following directory structure:
SuperLU_DIST/README instructions on installation
SuperLU_DIST/CBLAS/ needed BLAS routines in C, not necessarily fast
SuperLU_DIST/DOC/ the Users' Guide
SuperLU_DIST/EXAMPLE/ example programs
SuperLU_DIST/INSTALL/ test machine dependent parameters
SuperLU_DIST/SRC/ C source code, to be compiled into libsuperlu_dist.a
SuperLU_DIST/lib/ contains library archive libsuperlu_dist.a
SuperLU_DIST/Makefile top level Makefile that does installation and testing
SuperLU_DIST/make.inc compiler, compiler flags, library definitions and C
preprocessor definitions, included in all Makefiles.
(You may need to edit it to suit for your system
before compiling the whole package.)
SuperLU_DIST/MAKE_INC/ sample machine-specific make.inc files
Before installing the package, please examine the three things dependent
on your system setup:
1. Edit the make.inc include file.
This make include file is referenced inside each of the Makefiles
in the various subdirectories. As a result, there is no need to
edit the Makefiles in the subdirectories. All information that is
machine specific has been defined in this include file.
Sample machine-specific make.inc are provided in the MAKE_INC/
directory for several platforms, such as Cray XT5 and IBM SP.
When you have selected the machine to which you wish to install
SuperLU_DIST, copy the appropriate sample include file (if one is present)
into make.inc. For example, if you wish to run SuperLU_DIST on a
Cray XT5, you can do
cp MAKE_INC/make.xc30 make.inc
For the systems other than listed above, some porting effort is needed
for parallel factorization routines. Please refer to the Users' Guide
for detailed instructions on porting.
The following CPP definitions can be set in CFLAGS.
o -D_LONGINT
use 64-bit integers for indexing sparse matrices. (default is 32 bit)
o -DPRNTlevel=[0,1,2,...]
printing level to show solver's execution details. (default is 0)
o -DDEBUGlevel=[0,1,2,...]
diagnostic printing level for debugging purpose. (default is 0)
2. The BLAS library.
The parallel routines in SuperLU_DIST uses some sequential BLAS routines
on each process. If there is BLAS library available on your machine,
you may define the following in the file make.inc:
BLASDEF = -DUSE_VENDOR_BLAS
BLASLIB = <BLAS library you wish to link with>
The CBLAS/ subdirectory contains the part of the C BLAS needed by
SuperLU_DIST package. However, these codes are intended for use only if
there is no faster implementation of the BLAS already available on your
machine. In this case, you should go to the top-level SuperLU_DIST/
directory and do the following:
1) In make.inc, undefine (comment out) BLASDEF, and define:
BLASLIB = ../lib/libblas$(PLAT).a
2) Type:
make blaslib
to make the BLAS library from the routines in the CBLAS/ subdirectory.
3. External libraries: Metis and ParMetis.
If you will use Metis or ParMetis ordering, you will
need to install them yourself. Since ParMetis package already
contains the source code for the Metis library, you can just
download and compile ParMetis from:
http://glaros.dtc.umn.edu/gkhome/metis/parmetis/download
After you have installed it, you should define the following in make.inc:
METISLIB = -L<metis directory> -lmetis
PARMETISLIB = -L<parmetis directory> -lparmetis
I_PARMETIS = -I<parmetis directory>/include -I<parmetis directory>/metis/include
4. C preprocessor definition CDEFS.
In the header file SRC/Cnames.h, we use macros to determine how
C routines should be named so that they are callable by Fortran.
(Some vendor-supplied BLAS libraries do not have C interfaces. So the
re-naming is needed in order for the SuperLU BLAS calls (in C) to
interface with the Fortran-style BLAS.)
The possible options for CDEFS are:
o -DAdd_: Fortran expects a C routine to have an underscore
postfixed to the name;
o -DNoChange: Fortran expects a C routine name to be identical to
that compiled by C;
o -DUpCase: Fortran expects a C routine name to be all uppercase.
5. Multicore and GPU (optional).
To use OpenMP parallelism, need to set the number of threads as follows:
setenv OMP_NUM_THREADS <##>
To enable Nvidia GPU access, need to take the following 2 step:
1) set the following Linux environment variable:
setenv ACC GPU
2) Add the CUDA library location in make.inc:
ifeq "${ACC}" "GPU"
CUDA_FLAGS = -DGPU_ACC
INCS += -I<CUDA directory>/include
LIBS += -L<CUDA directory>/lib64 -lcublas -lcudart
endif
A Makefile is provided in each subdirectory. The installation can be done
completely automatically by simply typing "make" at the top level.
REFERENCES
[1] SuperLU_DIST: A Scalable Distributed-Memory Sparse Direct Solver for
Unsymmetric Linear Systems. Xiaoye S. Li and James W. Demmel.
ACM Trans. on Math. Solftware, Vol. 29, No. 2, June 2003, pp. 110-140.
[2] Parallel Symbolic Factorization for Sparse LU with Static Pivoting.
L. Grigori, J. Demmel and X.S. Li. SIAM J. Sci. Comp., Vol. 29, Issue 3,
1289-1314, 2007.
[3] A distributed CPU-GPU sparse direct solver. P. Sao, R. Vuduc and X.S. Li,
Proc. of EuroPar-2014 Parallel Processing, August 25-29, 2014.
Porto, Portugal.
Xiaoye S. Li Lawrence Berkeley National Lab, xsli@lbl.gov
Laura Grigori INRIA, France, Laura.Grigori@inria.fr
Piyush Sao Georgia Institute of Technology, piyush.feynman@gmail.com
Ichitaro Yamazaki Univ. of Tennessee, ic.yamazaki@gmail.com
--------------------
| RELEASE VERSIONS |
--------------------
October 15, 2003 Version 2.0
October 1, 2007 Version 2.1
Feburary 20, 2008 Version 2.2
October 15, 2008 Version 2.3
June 9, 2010 Version 2.4
November 23, 2010 Version 2.5
March 31, 2013 Version 3.3
October 1, 2014 Version 4.0
July 15, 2014 Version 4.1