slu__util_8h-source.html

SuperLU is a general purpose library for the direct solution of large, sparse, nonsymmetric systems

<a name="l00148"></a>00148 <span class="comment"> *             prior to this one. Therefore, this factorization will reuse</span>
<a name="l00149"></a>00149 <span class="comment"> *             both row and column scaling factors R and C, both row and</span>
<a name="l00150"></a>00150 <span class="comment"> *             column permutation vectors perm_r and perm_c, and the</span>
<a name="l00151"></a>00151 <span class="comment"> *             data structure set up from the previous symbolic factorization.</span>
<a name="l00152"></a>00152 <span class="comment"> *        = FACTORED: On entry, L, U, perm_r and perm_c contain the </span>
<a name="l00153"></a>00153 <span class="comment"> *              factored form of A. If DiagScale is not NOEQUIL, the matrix</span>
<a name="l00154"></a>00154 <span class="comment"> *              A has been equilibrated with scaling factors R and C.</span>
<a name="l00155"></a>00155 <span class="comment"> *</span>
<a name="l00156"></a>00156 <span class="comment"> * Equil  (yes_no_t)</span>
<a name="l00157"></a>00157 <span class="comment"> *        Specifies whether to equilibrate the system (scale A's row and</span>
<a name="l00158"></a>00158 <span class="comment"> *        columns to have unit norm).</span>
<a name="l00159"></a>00159 <span class="comment"> *</span>
<a name="l00160"></a>00160 <span class="comment"> * ColPerm (colperm_t)</span>
<a name="l00161"></a>00161 <span class="comment"> *        Specifies what type of column permutation to use to reduce fill.</span>
<a name="l00162"></a>00162 <span class="comment"> *        = NATURAL: use the natural ordering </span>
<a name="l00163"></a>00163 <span class="comment"> *        = MMD_ATA: use minimum degree ordering on structure of A'*A</span>
<a name="l00164"></a>00164 <span class="comment"> *        = MMD_AT_PLUS_A: use minimum degree ordering on structure of A'+A</span>
<a name="l00165"></a>00165 <span class="comment"> *        = COLAMD: use approximate minimum degree column ordering</span>
<a name="l00166"></a>00166 <span class="comment"> *        = MY_PERMC: use the ordering specified in ScalePermstruct-&gt;perm_c[]</span>
<a name="l00167"></a>00167 <span class="comment"> *         </span>
<a name="l00168"></a>00168 <span class="comment"> * Trans  (trans_t)</span>
<a name="l00169"></a>00169 <span class="comment"> *        Specifies the form of the system of equations:</span>
<a name="l00170"></a>00170 <span class="comment"> *        = NOTRANS: A * X = B        (No transpose)</span>
<a name="l00171"></a>00171 <span class="comment"> *        = TRANS:   A**T * X = B     (Transpose)</span>
<a name="l00172"></a>00172 <span class="comment"> *        = CONJ:    A**H * X = B     (Transpose)</span>
<a name="l00173"></a>00173 <span class="comment"> *</span>
<a name="l00174"></a>00174 <span class="comment"> * IterRefine (IterRefine_t)</span>
<a name="l00175"></a>00175 <span class="comment"> *        Specifies whether to perform iterative refinement.</span>
<a name="l00176"></a>00176 <span class="comment"> *        = NO: no iterative refinement</span>
<a name="l00177"></a>00177 <span class="comment"> *        = WorkingPrec: perform iterative refinement in working precision</span>
<a name="l00178"></a>00178 <span class="comment"> *        = ExtraPrec: perform iterative refinement in extra precision</span>
<a name="l00179"></a>00179 <span class="comment"> *</span>
<a name="l00180"></a>00180 <span class="comment"> * DiagPivotThresh (double, in [0.0, 1.0]) (only for sequential SuperLU)</span>
<a name="l00181"></a>00181 <span class="comment"> *        Specifies the threshold used for a diagonal entry to be an</span>
<a name="l00182"></a>00182 <span class="comment"> *        acceptable pivot.</span>
<a name="l00183"></a>00183 <span class="comment"> *</span>
<a name="l00184"></a>00184 <span class="comment"> * PivotGrowth (yes_no_t)</span>
<a name="l00185"></a>00185 <span class="comment"> *        Specifies whether to compute the reciprocal pivot growth.</span>
<a name="l00186"></a>00186 <span class="comment"> *</span>
<a name="l00187"></a>00187 <span class="comment"> * ConditionNumber (ues_no_t)</span>
<a name="l00188"></a>00188 <span class="comment"> *        Specifies whether to compute the reciprocal condition number.</span>
<a name="l00189"></a>00189 <span class="comment"> *</span>
<a name="l00190"></a>00190 <span class="comment"> * RowPerm (rowperm_t) (only for SuperLU_DIST)</span>
<a name="l00191"></a>00191 <span class="comment"> *        Specifies whether to permute rows of the original matrix.</span>
<a name="l00192"></a>00192 <span class="comment"> *        = NO: not to permute the rows</span>
<a name="l00193"></a>00193 <span class="comment"> *        = LargeDiag: make the diagonal large relative to the off-diagonal</span>
<a name="l00194"></a>00194 <span class="comment"> *        = MY_PERMR: use the permutation given in ScalePermstruct-&gt;perm_r[]</span>
<a name="l00195"></a>00195 <span class="comment"> *           </span>
<a name="l00196"></a>00196 <span class="comment"> * SymmetricMode (yest_no_t)</span>
<a name="l00197"></a>00197 <span class="comment"> *        Specifies whether to use symmetric mode.</span>
<a name="l00198"></a>00198 <span class="comment"> *</span>
<a name="l00199"></a>00199 <span class="comment"> * PrintStat (yes_no_t)</span>
<a name="l00200"></a>00200 <span class="comment"> *        Specifies whether to print the solver's statistics.</span>
<a name="l00201"></a>00201 <span class="comment"> *</span>
<a name="l00202"></a>00202 <span class="comment"> * ReplaceTinyPivot (yes_no_t) (only for SuperLU_DIST)</span>
<a name="l00203"></a>00203 <span class="comment"> *        Specifies whether to replace the tiny diagonals by</span>
<a name="l00204"></a>00204 <span class="comment"> *        sqrt(epsilon)*||A|| during LU factorization.</span>
<a name="l00205"></a>00205 <span class="comment"> *</span>
<a name="l00206"></a>00206 <span class="comment"> * SolveInitialized (yes_no_t) (only for SuperLU_DIST)</span>
<a name="l00207"></a>00207 <span class="comment"> *        Specifies whether the initialization has been performed to the</span>
<a name="l00208"></a>00208 <span class="comment"> *        triangular solve.</span>
<a name="l00209"></a>00209 <span class="comment"> *</span>
<a name="l00210"></a>00210 <span class="comment"> * RefineInitialized (yes_no_t) (only for SuperLU_DIST)</span>
<a name="l00211"></a>00211 <span class="comment"> *        Specifies whether the initialization has been performed to the</span>
<a name="l00212"></a>00212 <span class="comment"> *        sparse matrix-vector multiplication routine needed in iterative</span>
<a name="l00213"></a>00213 <span class="comment"> *        refinement.</span>
<a name="l00214"></a>00214 <span class="comment"> */</span>
<a name="l00215"></a><a class="code" href="structsuperlu__options__t.html">00215</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{
<a name="l00216"></a><a class="code" href="structsuperlu__options__t.html#cbd3cc1d27bbaf5bc168ebbbd6bf60fe">00216</a>     <a class="code" href="slu__util_8h.html#c785c8235480e5cfef9848d89c047c0a">fact_t</a>        Fact;
<a name="l00217"></a><a class="code" href="structsuperlu__options__t.html#3fe998e3518ad90532072fa8929a1e2f">00217</a>     <a class="code" href="slu__util_8h.html#e6553118ce91b9c08f9376941ae1536f">yes_no_t</a>      Equil;
<a name="l00218"></a><a class="code" href="structsuperlu__options__t.html#f6e41a7d8ca989c5396f6edc67be0409">00218</a>     <a class="code" href="slu__util_8h.html#bd17bbb14f57694750d96639e738e89c">colperm_t</a>     ColPerm;
<a name="l00219"></a><a class="code" href="structsuperlu__options__t.html#23fa8259c7091d82f10f0dfc7718dc36">00219</a>     <a class="code" href="slu__util_8h.html#0c4e17b2d5cea33f9991ccc6a6678d62">trans_t</a>       Trans;
<a name="l00220"></a><a class="code" href="structsuperlu__options__t.html#3e40fb39641e0caf27feb6998d21d98a">00220</a>     <a class="code" href="slu__util_8h.html#7e73e9d3a9caeec3586c03e01c494e37">IterRefine_t</a>  IterRefine;
<a name="l00221"></a><a class="code" href="structsuperlu__options__t.html#e574f08a3f4094dae8f635690b71d944">00221</a>     <span class="keywordtype">double</span>        DiagPivotThresh;
<a name="l00222"></a><a class="code" href="structsuperlu__options__t.html#a75cfd534f156c78b7dc69e7e68596da">00222</a>     <a class="code" href="slu__util_8h.html#e6553118ce91b9c08f9376941ae1536f">yes_no_t</a>      PivotGrowth;
<a name="l00223"></a><a class="code" href="structsuperlu__options__t.html#3394d6658ec588071a9fee24a728eb07">00223</a>     <a class="code" href="slu__util_8h.html#e6553118ce91b9c08f9376941ae1536f">yes_no_t</a>      ConditionNumber;
<a name="l00224"></a><a class="code" href="structsuperlu__options__t.html#d38e45769deca7564ea75caec2ad58e6">00224</a>     <a class="code" href="slu__util_8h.html#a38fa2e7f17b86333ca49e4b8a151adf">rowperm_t</a>     RowPerm;
<a name="l00225"></a><a class="code" href="structsuperlu__options__t.html#ad1b52d0366ae8601e97fab5c470c45d">00225</a>     <a class="code" href="slu__util_8h.html#e6553118ce91b9c08f9376941ae1536f">yes_no_t</a>      SymmetricMode;