lis_solver_set_option(3)

1lis_solver_set_option(3)     Lis Library Functions    lis_solver_set_option(3)
2
3
4

NAME

6       lis_solver_set_option - set the options for the solver
7
8

SYNOPSIS

10       #include "lis.h"
11
12       LIS_INT lis_solver_set_option(char *text, LIS_SOLVER *solver);
13
14

DESCRIPTION

16       Set the options for the solver.
17
18

INPUT

20       text   The command line options
21
22

OUTPUT

24       solver The solver
25
26

EXIT STATUS

28       The following exit values are returned:
29
30       0      The process is normally terminated
31
32       unspecified
33              An error occurred
34
35

NOTE

37       The  table  below  shows  the  available command line options, where -i
38       {cg|1} means -i cg or -i 1 and -maxiter [1000] indicates that  -maxiter
39       defaults to 1,000.
40
41

OPTIONS

43       The following options are supported:
44
45       -i linear solver
46              The following options are supported for linear solver:
47
48              -i {cg|1}
49                     CG
50
51              -i {bicg|2}
52                     BiCG
53
54              -i {cgs|3}
55                     CGS
56
57              -i {bicgstab|4}
58                     BiCGSTAB
59
60              -i {bicgstabl|5}
61                     BiCGSTAB(l)
62
63                     -ell [2]
64                            The degree l
65
66              -i {gpbicg|6}
67                     GPBiCG
68
69              -i {tfqmr|7}
70                     TFQMR
71
72              -i {orthomin|8}
73                     Orthomin(m)
74
75                     -restart [40]
76                            The restart value m
77
78              -i {gmres|9}
79                     GMRES(m)
80
81                     -restart [40]
82                            The restart value m
83
84              -i {jacobi|10}
85                     Jacobi
86
87              -i {gs|11}
88                     Gauss-Seidel
89
90              -i {sor|12}
91                     SOR
92
93                     -omega [1.9]
94                            The relaxation coefficient omega (0<omega<2)
95
96              -i {bicgsafe|13}
97                     BiCGSafe
98
99              -i {cr|14}
100                     CR
101
102              -i {bicr|15}
103                     BiCR
104
105              -i {crs|16}
106                     CRS
107
108              -i {bicrstab|17}
109                     BiCRSTAB
110
111              -i {gpbicr|18}
112                     GPBiCR
113
114              -i {bicrsafe|19}
115                     BiCRSafe
116
117              -i {fgmres|20}
118                     FGMRES(m)
119
120                     -restart [40]
121                            The restart value m
122
123              -i {idrs|21}
124                     IDR(s)
125
126                     -irestart [2]
127                            The restart value s
128
129              -i {idr1|22}
130                     IDR(1)
131
132              -i {minres|23}
133                     MINRES
134
135              -i {cocg|24}
136                     COCG
137
138              -i {cocr|25}
139                     COCR
140
141
142       -p preconditioner
143              The following options are supported for preconditioner:
144
145              -p {none|0}
146                     None
147
148              -p {jacobi|1}
149                     Jacobi
150
151              -p {ilu|2}
152                     ILU(k)
153
154                     -ilu_fill [0]
155                            The fill level k
156
157              -p {ssor|3}
158                     SSOR
159
160                     -ssor_omega [1.0]
161                            The relaxation coefficient omega (0<omega<2)
162
163              -p {hybrid|4}
164                     Hybrid
165
166                     -hybrid_i [sor]
167                            The linear solver
168
169                     -hybrid_maxiter [25]
170                            The maximum number of iterations
171
172                     -hybrid_tol [1.0e-3]
173                            The convergence criterion
174
175                     -hybrid_omega [1.5]
176                            The   relaxation  coefficient  omega  of  the  SOR
177                            (0<omega<2)
178
179                     -hybrid_ell [2]
180                            The degree l of the BiCGSTAB(l)
181
182                     -hybrid_restart [40]
183                            The restart values of the GMRES and Orthomin
184
185              -p {is|5}
186                     I+S
187
188                     -is_alpha [1.0]
189                            The parameter alpha of I+alpha*S(m)
190
191                     -is_m [3]
192                            The parameter m of I+alpha*S(m)
193
194              -p {sainv|6}
195                     SAINV
196
197                     -sainv_drop [0.05]
198                            The drop criterion
199
200              -p {saamg|7}
201                     SA-AMG
202
203                     -saamg_unsym [false]
204                            Select the unsymmetric version (The matrix  struc‐
205                            ture must be symmetric)
206
207                     -saamg_theta [0.05|0.12]
208                            The drop criterion
209
210              -p {iluc|8}
211                     Crout ILU
212
213                     -iluc_drop [0.05]
214                            The drop criterion
215
216                     -iluc_rate [5.0]
217                            The ration of maximum fill-in
218
219              -p {ilut|9}
220                     ILUT
221
222                     -ilut_drop [0.05]
223                            The drop criterion
224
225                     -ilut_rate [5.0]
226                            The ration of maximum fill-in
227
228              -adds true
229                     Additive Schwarz
230
231                     -adds_iter [1]
232                            The number of iteration
233
234       Other Options:
235
236       -maxiter [1000]
237              The maximum number of iterations
238
239       -tol [1.0e-12]
240              The convergence criterion
241
242       -print [0]
243              The display of the residual
244
245              -print {none|0}
246                     None
247
248              -print {mem|1}
249                     Save the residual history
250
251              -print {out|2}
252                     Display the residual history
253
254              -print {all|3}
255                     Save the residual history and display it on the screen
256
257       -scale [0]
258              The scaling
259
260              -scale {none|0}
261                     No scaling
262
263              -scale {jacobi|1}
264                     The Jacobi scaling
265
266              -scale {symm_diag|2}
267                     The diagonal scaling
268
269       -initx_zeros [true]
270              The behavior of the initial vector x_0
271
272              -initx_zero {false|0}
273                     Given values
274
275              -initx_zero {true|1}
276                     All values are set to 0
277
278       -omp_num_threads [t]
279              The  number  of  threads  (t  represents  the  maximum number of
280              threads)
281
282       -storage [0]
283              The matrix storage format
284
285       -storage_block [2]
286              The block size of the BSR and BSC formats
287
288       -f [0] The precision of the linear solver
289
290              -f {double|0}
291                     Double precision
292
293              -f {quad|1}
294                     Double-double (quadruple) precision
295
296       See Lis User Guide for full description.
297
298