set_default_options (3p)

Name

set_default_options - C function that sets to default parameters the options that control the behavior of the serial SuperLU solver.

Synopsis

#include <sunperf.h>

void set_default_options(superlu_options_t options);

void set_default_options_64(superlu_options_t_64 options);

Description

Oracle Solaris Studio Performance Library              set_default_options(3P)



NAME
       set_default_options  -  C  function that sets to default parameters the
       options that control the behavior of the serial SuperLU solver.


SYNOPSIS
       #include <sunperf.h>

       void set_default_options(superlu_options_t options);

       void set_default_options_64(superlu_options_t_64 options);


PURPOSE
       set_default_options() sets to default values various options that  con-
       trol how a linear system is to be solved.


ARGUMENTS
       options  (output) - A structure of type superlu_options_t whose members
       are


       fact_t Fact

                 specifies whether or not the factored form of the matrix A is
                 supplied  on entry, and if not, how the matrix A will be fac-
                 torized based on the previous history, such  as  factor  from
                 scratch,  reuse  row/column  permutation,  or  reuse the data
                 structures of L and U.


       yes_no_t Equil

                 specifies whether to equilibrate the  system  (scale  A'srows
                 and columns to have unit norm).


       colperm_t ColPerm

                 specifies  how to permute the columns of the matrix for spar-
                 sity preservation.


       trans_t Trans

                 specifies whether to solve the transposed system.


       IterRefine_t IterRefine

                 specifies whether to perform  iterative  refinement,  and  in
                 what precision to compute the residual.


       yes_no_t PrintStat

                 specifies whether to print the solver's statistics.


       yes_no_t SymmetricMode

                 specifies whether to use symmetric mode.


       double DiagPivotThresh

                 specifies  the  threshold  used for a diagonal entry to be an
                 acceptable pivot.


       yes_no_t PivotGrowth

                 specifies whether to compute the reciprocal pivot growth fac-
                 tor.


       yes_no_t ConditionNumber

                 specifies whether to compute an estimate of the reciprocal of
                 the condition number of A.


       fact_t, yes_no_t, colperm_t, trans_t and IterRefine_t  are  enum  types
       defined as:

       fact_t       = {DOFACT, SamePattern, SamePattern_SameRowPerm, FACTORED,
       EQUILIBRATE}

       yes_no_t     = {NO, YES}

       colperm_t    = {NATURAL, MMD_ATA, MMD_AT_PLUS_A, COLAMD, MY_PERMC}

       trans_t      = {NOTRANS, TRANS, CONJ}

       IterRefine_t = {NOREFINE, SINGLE=1, DOUBLE, EXTRA}


       Upon return, options is set to:


       options.Fact            = DOFACT

       options.Trans           = NO

       options.Equil           = YES

       options.ColPerm         = COLAMD

       options.DiagPivotThresh = 1.0

       options.SymmetricMode   = NO

       options.IterRefine      = NO

       options.PrintStat       = YES

The users can reset each default value according to their needs.


SEE ALSO
       SuperMatrix
       http://crd.lbl.gov/~xiaoye/SuperLU/
       James W. Demmel, Stanley C. Eisenstat, John R. Gilbert,  Xiaoye  S.  Li
       and  Joseph  W. H. Liu, "A supernodal approach to sparse partial pivot-
       ing", SIAM J. Matrix Analysis and Applications, Vol. 20, Num. 3,  1999,
       pp. 720-755.



                                  7 Nov 2015           set_default_options(3P)