1lis_esolver_set_option(3) Lis Library Functions lis_esolver_set_option(3)
2
6 lis_esolver_set_option - set the options for the eigensolver
7
10 #include "lis.h"
11 LIS_INT lis_esolver_set_option(char *text, LIS_ESOLVER *esolver);
13
16 Set the options for the eigensolver.
17
20 text The command line options
21
24 esolver
25 The eigensolver
26
29 The following exit values are returned:
30 0 The process is normally terminated
32 unspecified
34 An error occurred
35
38 The table below shows the available command line options, where -e
39 {pi|1} means -e pi or -e 1 and -emaxiter [1000] indicates that -emax‐
40 iter defaults to 1,000.
41
44 The following options are supported:
45 -e eigensolver
47 The following options are supported for eigensolver:
48 -e {pi|1}
50 Power
51 -e {ii|2}
53 Inverse
54 -i [bicg]
56 The linear solver
57 -e {rqi|3}
59 Rayleigh Quotient
60 -i [bicg]
62 The linear solver
63 -e {cg|4}
65 CG
66 -i [cg]
68 The linear solver
69 -e {cr|5}
71 CR
72 -i [bicg]
74 The linear solver
75 -e {si|6}
77 Subspace
78 -ss [1]
80 The size of the subspace
81 -e {li|7}
83 Lanczos
84 -ss [1]
86 The size of the subspace
87 -e {ai|8}
89 Arnoldi
90 -ss [1]
92 The size of the subspace
93 -e {gpi|9}
95 Generalized Power
96 -i [bicg]
98 The linear solver
99 -e {gii|10}
101 Generalized Inverse
102 -i [bicg]
104 The linear solver
105 -e {grqi|11}
107 Generalized Rayleigh Quotient
108 -i [bicg]
110 The linear solver
111 -e {gcg|12}
113 Generalized CG
114 -i [cg]
116 The linear solver
117 -e {gcr|13}
119 Generalized CR
120 -i [bicg]
122 The linear solver
123 -e {gsi|14}
125 Generalized Subspace
126 -ss [1]
128 The size of the subspace
129 -e {gli|15}
131 Generalized Lanczos
132 -ss [1]
134 The size of the subspace
135 -e {gai|16}
137 Generalized Arnoldi
138 -ss [1]
140 The size of the subspace
141 -i linear solver
143 The following options are supported for inner linear solver:
144 -i {cg|1}
146 CG
147 -i {bicg|2}
149 BiCG
150 -i {cgs|3}
152 CGS
153 -i {bicgstab|4}
155 BiCGSTAB
156 -i {bicgstabl|5}
158 BiCGSTAB(l)
159 -ell [2]
161 The degree l
162 -i {gpbicg|6}
164 GPBiCG
165 -i {tfqmr|7}
167 TFQMR
168 -i {orthomin|8}
170 Orthomin(m)
171 -restart [40]
173 The restart value m
174 -i {gmres|9}
176 GMRES(m)
177 -restart [40]
179 The restart value m
180 -i {jacobi|10}
182 Jacobi
183 -i {gs|11}
185 Gauss-Seidel
186 -i {sor|12}
188 SOR
189 -omega [1.9]
191 The relaxation coefficient omega (0<omega<2)
192 -i {bicgsafe|13}
194 BiCGSafe
195 -i {cr|14}
197 CR
198 -i {bicr|15}
200 BiCR
201 -i {crs|16}
203 CRS
204 -i {bicrstab|17}
206 BiCRSTAB
207 -i {gpbicr|18}
209 GPBiCR
210 -i {bicrsafe|19}
212 BiCRSafe
213 -i {fgmres|20}
215 FGMRES(m)
216 -restart [40]
218 The restart value m
219 -i {idrs|21}
221 IDR(s)
222 -irestart [2]
224 The restart value s
225 -i {idr1|22}
227 IDR(1)
228 -i {minres|23}
230 MINRES
231 -i {cocg|24}
233 COCG
234 -i {cocr|25}
236 COCR
237 -p preconditioner
240 The following options are supported for preconditioner:
241 -p {none|0}
243 None
244 -p {jacobi|1}
246 Jacobi
247 -p {ilu|2}
249 ILU(k)
250 -ilu_fill [0]
252 The fill level k
253 -p {ssor|3}
255 SSOR
256 -ssor_omega [1.0]
258 The relaxation coefficient omega (0<omega<2)
259 -p {hybrid|4}
261 Hybrid
262 -hybrid_i [sor]
264 The linear solver
265 -hybrid_maxiter [25]
267 The maximum number of iterations
268 -hybrid_tol [1.0e-3]
270 The convergence criterion
271 -hybrid_omega [1.5]
273 The relaxation coefficient omega of the SOR
274 (0<omega<2)
275 -hybrid_ell [2]
277 The degree l of the BiCGSTAB(l)
278 -hybrid_restart [40]
280 The restart values of the GMRES and Orthomin
281 -p {is|5}
283 I+S
284 -is_alpha [1.0]
286 The parameter alpha of I+alpha*S(m)
287 -is_m [3]
289 The parameter m of I+alpha*S(m)
290 -p {sainv|6}
292 SAINV
293 -sainv_drop [0.05]
295 The drop criterion
296 -p {saamg|7}
298 SA-AMG
299 -saamg_unsym [false]
301 Select the unsymmetric version (The matrix struc‐
302 ture must be symmetric)
303 -saamg_theta [0.05|0.12]
305 The drop criterion
306 -p {iluc|8}
308 Crout ILU
309 -iluc_drop [0.05]
311 The drop criterion
312 -iluc_rate [5.0]
314 The ration of maximum fill-in
315 -p {ilut|9}
317 ILUT
318 -ilut_drop [0.05]
320 The drop criterion
321 -ilut_rate [5.0]
323 The ration of maximum fill-in
324 -adds true
326 Additive Schwarz
327 -adds_iter [1]
329 The number of iteration
330 Other Options for eigensolver:
332 -emaxiter [1000]
334 The maximum number of iterations
335 -etol [1.0e-12]
337 The convergence criterion
338 -eprint [0]
340 The display of the residual
341 -eprint {none|0}
343 None
344 -eprint {mem|1}
346 Save the residual history
347 -eprint {out|2}
349 Display the residual history
350 -eprint {all|3}
352 Save the residual history and display it on the screen
353 -ie [ii]
355 The inner eigensolver used in Subspace, Lanczos, and Arnoldi
356 -ige [ii]
358 The inner eigensolver used in Generalized Subspace, Generalized
359 Lanczos, and Generalized Arnoldi
360 -shift [0.0]
362 The amount of the shift
363 -initx_ones [true]
365 The behavior of the initial vector x_0
366 -initx_ones {false|0}
368 Given values
369 -initx_ones {true|1}
371 All values are set to 1
372 -omp_num_threads [t]
374 The number of threads (t represents the maximum number of
375 threads)
376 -estorage [0]
378 The matrix storage format
379 -estorage_block [2]
381 The block size of the BSR and BSC formats
382 -ef [0]
384 The precision of the eigensolver
385 -ef {double|0}
387 Double precision
388 -ef {quad|1}
390 Double-double (quadruple) precision
391 Other options for inner linear solver:
393 -maxiter [1000]
395 The maximum number of iterations
396 -tol [1.0e-12]
398 The convergence criterion
399 -print [0]
401 The display of the residual
402 -print {none|0}
404 None
405 -print {mem|1}
407 Save the residual history
408 -print {out|2}
410 Display the residual history
411 -print {all|3}
413 Save the residual history and display it on the screen
414 -scale [0]
416 The scaling
417 -scale {none|0}
419 No scaling
420 -scale {jacobi|1}
422 The Jacobi scaling
423 -scale {symm_diag|2}
425 The diagonal scaling
426 -initx_zeros [true]
428 The behavior of the initial vector x_0
429 -initx_zero {false|0}
431 Given values
432 -initx_zero {true|1}
434 All values are set to 0
435 -omp_num_threads [t]
437 The number of threads (t represents the maximum number of
438 threads)
439 -storage [0]
441 The matrix storage format
442 -storage_block [2]
444 The block size of the BSR and BSC formats
445 -f [0] The precision of the linear solver
447 -f {double|0}
449 Double precision
450 -f {quad|1}
452 Double-double (quadruple) precision
453 See Lis User Guide for full description.
455
458 lis(3)
459 http://www.ssisc.org/lis/
461Man Page 14 Sep 2017 lis_esolver_set_option(3)