diff --git a/docs/amg4psblas_1.0-guide.pdf b/docs/amg4psblas_1.0-guide.pdf index 33c53b30..37305504 100644 Binary files a/docs/amg4psblas_1.0-guide.pdf and b/docs/amg4psblas_1.0-guide.pdf differ diff --git a/docs/html/userhtml.css b/docs/html/userhtml.css index fe7f3289..2e1d7cd1 100644 --- a/docs/html/userhtml.css +++ b/docs/html/userhtml.css @@ -13,34 +13,32 @@ .cmbx-12{font-size:109%; font-weight: bold;} .cmbx-12{ font-weight: bold;} .cmbx-12{ font-weight: bold;} -.cmtt-12{font-size:109%;font-family: monospace,monospace;} -.cmtt-12{font-family: monospace,monospace;} -.cmtt-12{font-family: monospace,monospace;} +.cmtt-12{font-size:109%;font-family: monospace;} +.cmtt-12{font-family: monospace;} +.cmtt-12{font-family: monospace;} .cmcsc-10x-x-120{font-size:109%;} .cmr-8{font-size:72%;} .cmmi-12{font-size:109%;font-style: italic;} .cmmi-8{font-size:72%;font-style: italic;} .cmsy-8{font-size:72%;} -.tctt-1200{font-size:109%;font-family: monospace,monospace;} .cmmi-10x-x-109{font-style: italic;} .cmsy-10x-x-109{} -.cmtt-10x-x-109{font-family: monospace,monospace;} -.cmtt-10x-x-109{font-family: monospace,monospace;} -.cmtt-10x-x-109{font-family: monospace,monospace;} +.cmtt-10x-x-109{font-family: monospace;} +.cmtt-10x-x-109{font-family: monospace;} +.cmtt-10x-x-109{font-family: monospace;} .cmcsc-10x-x-109{} -.cmtt-10{font-size:90%;font-family: monospace,monospace;} -.cmtt-10{font-family: monospace,monospace;} -.cmtt-10{font-family: monospace,monospace;} +.cmtt-10{font-size:90%;font-family: monospace;} +.cmtt-10{font-family: monospace;} +.cmtt-10{font-family: monospace;} .cmbx-10x-x-109{ font-weight: bold;} .cmbx-10x-x-109{ font-weight: bold;} .cmbx-10x-x-109{ font-weight: bold;} .cmcsc-10{font-size:90%;} .small-caps{font-variant: small-caps; } -p{margin-top:0;margin-bottom:0} -p.indent{text-indent:0;} -p + p{margin-top:1em;} -p + div, p + pre {margin-top:1em;} -div + p, pre + p {margin-top:1em;} +p.noindent { text-indent: 0em } +td p.noindent { text-indent: 0em; margin-top:0em; } +p.nopar { text-indent: 0em; } +p.indent{ text-indent: 1.5em } @media print {div.crosslinks {visibility:hidden;}} a img { border-top: 0; border-left: 0; border-right: 0; } center { margin-top:1em; margin-bottom:1em; } @@ -63,7 +61,7 @@ div.obeylines-v p { margin-top:0; margin-bottom:0; } td.displaylines {text-align:center; white-space:nowrap;} .centerline {text-align:center;} .rightline {text-align:right;} -div.verbatim {font-family: monospace,monospace; white-space: nowrap; text-align:left; clear:both; } +div.verbatim {font-family: monospace; white-space: nowrap; text-align:left; clear:both; } .fbox {padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } div.fbox {display:table} div.center div.fbox {text-align:center; clear:both; padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } @@ -96,16 +94,18 @@ td.td01{ padding-left:0pt; padding-right:5pt; } td.td10{ padding-left:5pt; padding-right:0pt; } td.td11{ padding-left:5pt; padding-right:5pt; } table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; } -.hline hr, .cline hr{ height : 0px; margin:0px; } -.hline td, .cline td{ padding: 0; } -.hline hr, .cline hr{border:none;border-top:1px solid black;} +.hline hr, .cline hr{ height : 1px; margin:0px; } .tabbing-right {text-align:right;} +span.TEX {letter-spacing: -0.125em; } +span.TEX span.E{ position:relative;top:0.5ex;left:-0.0417em;} +a span.TEX span.E {text-decoration: none; } +span.LATEX span.A{ position:relative; top:-0.5ex; left:-0.4em; font-size:85%;} +span.LATEX span.TEX{ position:relative; left: -0.4em; } div.float, div.figure {margin-left: auto; margin-right: auto;} div.float img {text-align:center;} div.figure img {text-align:center;} -.marginpar,.reversemarginpar {width:20%; float:right; text-align:left; margin-left:auto; margin-top:0.5em; font-size:85%; text-decoration:underline;} -.marginpar p,.reversemarginpar p{margin-top:0.4em; margin-bottom:0.4em;} -.reversemarginpar{float:left;} +.marginpar {width:20%; float:right; text-align:left; margin-left:auto; margin-top:0.5em; font-size:85%; text-decoration:underline;} +.marginpar p{margin-top:0.4em; margin-bottom:0.4em;} table.equation {width:100%;} .equation td{text-align:center; } td.equation { margin-top:1em; margin-bottom:1em; } @@ -148,11 +148,10 @@ div.abstract {width:100%;} .Ovalbox-thick { padding-left:3pt; padding-right:3pt; border:solid thick; } .shadowbox { padding-left:3pt; padding-right:3pt; border:solid thin; border-right:solid thick; border-bottom:solid thick; } .doublebox { padding-left:3pt; padding-right:3pt; border-style:double; border:solid thick; } -.rotatebox{display: inline-block;} .figure img.graphics {margin-left:10%;} .lstlisting .label{margin-right:0.5em; } -div.lstlisting{font-family: monospace,monospace; white-space: nowrap; margin-top:0.5em; margin-bottom:0.5em; } -div.lstinputlisting{ font-family: monospace,monospace; white-space: nowrap; } +div.lstlisting{font-family: monospace; white-space: nowrap; margin-top:0.5em; margin-bottom:0.5em; } +div.lstinputlisting{ font-family: monospace; white-space: nowrap; } .lstinputlisting .label{margin-right:0.5em;} #TBL-1 colgroup{border-left: 1px solid black;border-right:1px solid black;} #TBL-1{border-collapse:collapse;} @@ -186,9 +185,9 @@ div.lstinputlisting{ font-family: monospace,monospace; white-space: nowrap; } #TBL-5{border-collapse:collapse;} #TBL-5 colgroup{border-left: 1px solid black;border-right:1px solid black;} #TBL-5{border-collapse:collapse;} -td#TBL-5-10-1{border-left:solid black 0.4pt;border-right:solid black 0.4pt;} -td#TBL-5-11-1{border-left:solid black 0.4pt;border-right:solid black 0.4pt;} -td#TBL-5-12-1{border-left:solid black 0.4pt;border-right:solid black 0.4pt;} +td#TBL-5-10-5{border-left:solid black 0.4pt;border-right:solid black 0.4pt;} +td#TBL-5-11-5{border-left:solid black 0.4pt;border-right:solid black 0.4pt;} +td#TBL-5-12-5{border-left:solid black 0.4pt;border-right:solid black 0.4pt;} #TBL-6 colgroup{border-left: 1px solid black;border-right:1px solid black;} #TBL-6{border-collapse:collapse;} #TBL-6 colgroup{border-left: 1px solid black;border-right:1px solid black;} @@ -201,8 +200,8 @@ td#TBL-5-12-1{border-left:solid black 0.4pt;border-right:solid black 0.4pt;} #TBL-6{border-collapse:collapse;} #TBL-6 colgroup{border-left: 1px solid black;border-right:1px solid black;} #TBL-6{border-collapse:collapse;} -td#TBL-6-5-1{border-left:solid black 0.4pt;border-right:solid black 0.4pt;} -td#TBL-6-6-1{border-left:solid black 0.4pt;border-right:solid black 0.4pt;} +td#TBL-6-5-5{border-left:solid black 0.4pt;border-right:solid black 0.4pt;} +td#TBL-6-6-5{border-left:solid black 0.4pt;border-right:solid black 0.4pt;} #TBL-7 colgroup{border-left: 1px solid black;border-right:1px solid black;} #TBL-7{border-collapse:collapse;} #TBL-7 colgroup{border-left: 1px solid black;border-right:1px solid black;} @@ -215,11 +214,11 @@ td#TBL-6-6-1{border-left:solid black 0.4pt;border-right:solid black 0.4pt;} #TBL-7{border-collapse:collapse;} #TBL-7 colgroup{border-left: 1px solid black;border-right:1px solid black;} #TBL-7{border-collapse:collapse;} -td#TBL-7-5-1{border-left:solid black 0.4pt;border-right:solid black 0.4pt;} -td#TBL-7-6-1{border-left:solid black 0.4pt;border-right:solid black 0.4pt;} -td#TBL-7-7-1{border-left:solid black 0.4pt;border-right:solid black 0.4pt;} -td#TBL-7-12-1{border-left:solid black 0.4pt;border-right:solid black 0.4pt;} -td#TBL-7-13-1{border-left:solid black 0.4pt;border-right:solid black 0.4pt;} +td#TBL-7-5-5{border-left:solid black 0.4pt;border-right:solid black 0.4pt;} +td#TBL-7-6-5{border-left:solid black 0.4pt;border-right:solid black 0.4pt;} +td#TBL-7-7-5{border-left:solid black 0.4pt;border-right:solid black 0.4pt;} +td#TBL-7-12-5{border-left:solid black 0.4pt;border-right:solid black 0.4pt;} +td#TBL-7-13-5{border-left:solid black 0.4pt;border-right:solid black 0.4pt;} #TBL-8 colgroup{border-left: 1px solid black;border-right:1px solid black;} #TBL-8{border-collapse:collapse;} #TBL-8 colgroup{border-left: 1px solid black;border-right:1px solid black;} diff --git a/docs/html/userhtml0x.png b/docs/html/userhtml0x.png index f004430a..96c5cb9b 100644 Binary files a/docs/html/userhtml0x.png and b/docs/html/userhtml0x.png differ diff --git a/docs/html/userhtml1x.png b/docs/html/userhtml1x.png index 20f909a7..4c10c200 100644 Binary files a/docs/html/userhtml1x.png and b/docs/html/userhtml1x.png differ diff --git a/docs/html/userhtmlli5.html b/docs/html/userhtmlli5.html index c3152118..6525b8c9 100644 --- a/docs/html/userhtmlli5.html +++ b/docs/html/userhtmlli5.html @@ -198,7 +198,7 @@ class="cmr-12"> Pothen, Distributed-memory parallel algorithms for matching and coloring, in PCO’11 New Trends in Parallel Computing and Optimization, +class="cmr-12">, in PCO11 New Trends in Parallel Computing and Optimization, IEEE International Symposium on Parallel and Distributed Processing type e

string g

der

No preconditioner No preconditioner

’NONE’ ’

Considered to use the PSBLAS Krylov solvers with no preconditioner.

Diagonal Diagonal

’DIAG’L1-JACOBI’ ’

Diagonal preconditioner. For any zero diagonal entry of the matrix to be preconditioned, the corresponding entry @@ -308,7 +308,7 @@ of the preconditioner is set to 1.

Gauss-Seidel Gauss-Seidel

’GS’L1-GS’ ’

Hybrid Gauss-Seidel (forward), that is, global block Jacobi with Gauss-Seidel as local solver.

Symmetrized Gauss-SeidelSymmetrized Gauss-Seidel

’FBGS’L1-FBGS’ ’

Symmetrized hybrid Gauss-Seidel, that is, forward Gauss-Seidel followed by backward Gauss-Seidel.

Block Jacobi Block Jacobi

’BJAC’L1-BJAC’ ’

Block-Jacobi with ILU(0) on the local blocks.

Additive Schwarz Additive Schwarz

’AS’ ’

Additive Schwarz (AS), with overlap 1 and ILU(0) on the local blocks.

Multilevel Multilevel

’ML’ ’

V-cycle with one hybrid forward Gauss-Seidel (GS) sweep as pre-smoother and one hybrid backward diff --git a/docs/html/userhtmlse6.html b/docs/html/userhtmlse6.html index b4614460..cf4b33c9 100644 --- a/docs/html/userhtmlse6.html +++ b/docs/html/userhtmlse6.html @@ -170,33 +170,33 @@ cellspacing="0" cellpadding="0" >

smoother smoother

class(amg_x_base_smoother_type)

The user-defined new smoother to be employed in the preconditioner.

solver solver

class(amg_x_base_solver_type)

The user-defined new solver to be employed in the preconditioner.

Trolling, insulting or derogatory comments, and personal or polit class="cmr-12">Public or private harassment

  • Publishing others’ private information, such as a physical or email address, +class="cmr-12">Publishing others private information, such as a physical or email address, without their explicit permission
    • @@ -234,7 +234,7 @@ class="cmr-12">_of_conduct .html. Community Impact Guidelines were inspired by Mozilla’s code of conduct +class="cmr-12">. Community Impact Guidelines were inspired by Mozillas code of conduct enforcement ladder. For answers to common questions about this code of conduct, see -

    [nextMethod smoothers_build

    -

    -

    +

    call p,imold])

    -

    This method builds the smoothers and the coarsest-level solvers for the multilevel preconditioner  5.3). -

    Arguments

    a

    a

    type(psb_in).

    The sparse matrix structure containing the local part of the matrix to be preconditioned. Note that 18].

    desc_a

    desc_a

    type(psb_desc_typein).

    The communication descriptor of a. See the PSBLAS User’s Guide @@ -149,10 +149,10 @@ class="cmr-12">18].

    info

    info

    integer, out).

    Error code. If no error, 0 is returned. See Section 7 for details.

    amold

    amold

    class(psb_ optional.

    The desired dynamic type for internal matrix components; this allows e.g. running on GPUs; it needs not be the same on all @@ -204,10 +204,10 @@ class="cmr-12">18].

    vmold

    vmold

    class(psb_ optional.

    The desired dynamic type for internal vector components; this allows e.g. running on GPUs.

    imold

    imold

    class(psb_i_base_vect_type optional.

    The desired dynamic type for internal integer vector components; this allows e.g. running on GPUs.

    @@ -262,7 +262,7 @@ class="td11">
    -

    [next] [up]

    -

    diff --git a/docs/html/userhtmlsu11.html b/docs/html/userhtmlsu11.html index 6576be86..405e9838 100644 --- a/docs/html/userhtmlsu11.html +++ b/docs/html/userhtmlsu11.html @@ -10,7 +10,7 @@ -

    [next5.5 Method build

    -

    -

    +

    call p,imold])

    -

    This method builds the preconditioner p according to the requirements made by the @@ -83,17 +83,17 @@ class="cmtt-12">smoothers_build, whose nomenclature would however be somewhat unnatural when dealing with simple one-level preconditioners. -

    Arguments

    a

    a

    type(psb_in).

    The sparse matrix structure containing the local part of the matrix to be preconditioned. Note that 18].

    desc_a

    desc_a

    type(psb_desc_typein).

    The communication descriptor of a. See the PSBLAS User’s Guide @@ -157,10 +157,10 @@ class="cmr-12">18].

    info

    info

    integer, out).

    Error code. If no error, 0 is returned. See Section 7 for details.

    amold

    amold

    class(psb_ optional.

    The desired dynamic type for internal matrix components; this allows e.g. running on GPUs; it needs not be the same on all @@ -212,10 +212,10 @@ class="cmr-12">18].

    vmold

    vmold

    class(psb_ optional.

    The desired dynamic type for internal vector components; this allows e.g. running on GPUs.

    imold

    imold

    class(psb_i_base_vect_type optional.

    The desired dynamic type for internal integer vector components; this allows e.g. running on GPUs.

    -

    The method can be used to build multilevel preconditioners too. @@ -272,7 +272,7 @@ class="cmr-12">The method can be used to build multilevel preconditioners too.

    [next] [up]

    -

    diff --git a/docs/html/userhtmlsu12.html b/docs/html/userhtmlsu12.html index 2689d6c3..4a36f3b8 100644 --- a/docs/html/userhtmlsu12.html +++ b/docs/html/userhtmlsu12.html @@ -10,7 +10,7 @@ -

    [next5.6 Method apply

    -

    -

    +

    call p,work])

    -

    This method computes y = psb_krylov and hence it is completely transparent to the user. -

    Arguments

    x

    x

    type(kind_parameter), dimension(:), intent(in)—.

    The local part of the vector x. Note that , single/double precision version of AMG4PSBLAS under use.

    y

    y

    type(kind_parameter), dimension(:), intent(out)—.

    The local part of the vector y. Note that , single/double precision version of AMG4PSBLAS under use.

    desc_a

    desc_a

    type(psb_desc_typein).

    The communication descriptor associated to the matrix to be preconditioned.

    info

    info

    integer, out).

    Error code. If no error, 0 is returned. See Section 7 for details.

    trans

    trans

    character(len(in).

    If trans = -1).

    work

    work

    type(kind_parameter), dimension(:), optional, target—.

    Workspace. Its size should be at least 4 , single/double precision version of AMG4PSBLAS under use.

    @@ -339,7 +339,7 @@ class="td11">
    -

    [next] [up]

    -

    diff --git a/docs/html/userhtmlsu13.html b/docs/html/userhtmlsu13.html index 2a82b611..236f088f 100644 --- a/docs/html/userhtmlsu13.html +++ b/docs/html/userhtmlsu13.html @@ -10,7 +10,7 @@ -

    [next5.7 Method free

    -

    -

    +

    call p,info)

    -

    This method deallocates the preconditioner data structure p. -

    Arguments

    info

    info

    integer, out).

    Error code. If no error, 0 is returned. See Section for details.

    @@ -89,7 +89,7 @@ class="td11">
    -

    [next] [up]

    -

    diff --git a/docs/html/userhtmlsu14.html b/docs/html/userhtmlsu14.html index 054451ae..947fd021 100644 --- a/docs/html/userhtmlsu14.html +++ b/docs/html/userhtmlsu14.html @@ -10,7 +10,7 @@ -

    [next5.8 Method descr

    -

    -

    +

    call p verbosity])

    -

    This method prints a description of the preconditioner p to the standard output or to a @@ -68,17 +68,17 @@ class="cmtt-12">build, have been called. -

    Arguments

    info

    info

    integer, out).

    Error code. If no error, 0 is returned. See Section 7 for details.

    iout

    iout

    integer,  optional.

    The id of the file where the preconditioner description will be printed; the default is the standard output.

    root

    root

    integer,  optional.

    The id of the process where the preconditioner description will be printed; the default is psb_root_.

    verbosity

    verbosity

    integer,  optional.

    The verbosity level of the description. Default value is 0. For values higher than 0, it prints out further information, e.g., for @@ -169,12 +169,12 @@ class="cmr-12">a distributed multilevel preconditioner the size of the coarsematrices on every process.

    -

    [next] [up]

    -

    diff --git a/docs/html/userhtmlsu15.html b/docs/html/userhtmlsu15.html index 0a318d17..f3adc621 100644 --- a/docs/html/userhtmlsu15.html +++ b/docs/html/userhtmlsu15.html @@ -10,7 +10,7 @@ -

    [prev]

    class="cmr-12">5.9 Auxiliary Methods -

    Various functionalities are implemented as additional methods of the preconditioner object. -

    +

    5.9.1 Method: dump
    -

    -

    +

    call p,global_num])

    -

    Dump on file. -

    Arguments

    info

    info

    integer, out).

    Error code. If no error, 0 is returned. See Section 7 for details.

    amold

    amold

    class(psb_ optional.

    The desired dynamic type for internal matrix components; this allows e.g. running on GPUs; it needs not be the same on all @@ -132,17 +132,17 @@ class="cmr-12">18].

    -

    +

    5.9.2 Method: clone
    -

    -

    +

    call p)
    -

    Create a (deep) copy of the preconditioner object. -

    Arguments

    pout

    pout

    type(amg_out).

    The copy of the preconditioner data structure. Note that x must @@ -198,10 +198,10 @@ class="cmr-12">, single/double precision version of AMG4PSBLAS under use.

    info

    info

    integer, out).

    Error code. If no error, 0 is returned. See Section 7 for details.

    -

    +

    5.9.3 Method: sizeof
    -

    -

    +

    sz =

    global

    global

    logical, optional.

    Whether the global or local preconditioner memory occupatio is desired. Default: false..

    Return memory footprint in bytes. -

    +

    5.9.4 Method: allocate_wrk
    -

    -

    +

    call p vmold])

    -

    n Allocate internal work vectors. Each application of the preconditioner uses a number of work vectors which are allocated internally as necessary; therefore allocation and @@ -326,17 +326,17 @@ class="cmr-12">argument to the apply method. -

    Arguments

    info

    info

    integer, out).

    Error code. If no error, 0 is returned. See Section 7 for details.

    vmold

    vmold

    class(psb_ optional.

    The desired dynamic type for internal vector components; this allows e.g. running on GPUs.

    -

    +

    5.9.5 Method: free_wrk
    -

    -

    +

    call p(info)

    -

    Deallocate internal work vectors. -

    Arguments

    info

    info

    integer, out).

    Error code. If no error, 0 is returned. See Section 7 for details.

    diff --git a/docs/html/userhtmlsu3.html b/docs/html/userhtmlsu3.html index 6106476b..6f47ede0 100644 --- a/docs/html/userhtmlsu3.html +++ b/docs/html/userhtmlsu3.html @@ -687,8 +687,7 @@ class="cmtt-12"> ‘--prefix=$HOME$HOME’. 

    contxt contxt

    type(in).

    The communication context.

    ptype ptype

    character(in) .

    The type of preconditioner. Its values are specified in Table 1.

    Note that strings are case insensitive.

    info info

    integer,out).

    Error code. If no error, 0 is returned. See Section 7 for details.

    diff --git a/docs/html/userhtmlsu8.html b/docs/html/userhtmlsu8.html index d3f36cc0..faa34dc7 100644 --- a/docs/html/userhtmlsu8.html +++ b/docs/html/userhtmlsu8.html @@ -79,9 +79,9 @@ cellspacing="0" cellpadding="0" >

    what what

    character(len=*).

    The parameter to be set. It can be specified through its name; the 8.

    val   

    integer or in).

    The value of the parameter to be set. The list of allowed values and len=*), it is also treated as case insensitive.

    info info

    integer,out).

    Error code. If no error, 0 is returned. See Section 7 for details.

    ilev ilev

    integer,in).

    For the multilevel preconditioner, the level at which the 8).

    ilmax ilmax

    integer,in).

    For the multilevel preconditioner, when both ilev The levels are numbered in increasing order starting from the fin one, i.e., level 1 is the finest level.

    pos pos

    character(in).

    Whether the other arguments apply only to the pre-smoother not concern the smoothers, class="cmtt-12">pos is ignored.

    idx idx

    integer,in).

    An auxiliary input argument that can be passed to the underlying

    what a type e

    val val

    dfault t

    cnts

    ’ML_CYCLE

    character(len=*) =*)

    ’VCYCLE’

    ’ADD’ ’

    ’VCYCLE’ ’

    Multilevel cycle: V-cycle, W-cycle, K-cycle, and additive composition.

    ’CYCLE_SWEEPS’

    integer integer

    Any integer

    number ≥ 1

    1 ≥ 1

    1

    Number of multilevel cycles.


    Table 2:

    what a type e

    val val

    dfault t

    cnts

    ’MIN_COARSE_SIZE_PER_PROCESS’

    integer integer

    Any number

    > 0

    200 > 0

    200

    Coarse size threshold per process. The aggregation stops if the global number of variables of the computed coarsest matrix @@ -723,17 +723,17 @@ multiplied by the number of processes (see Note).

    ’MIN_COARSE_SIZE’

    integer integer

    Any number

    > 0

    -1 > 0

    -1

    Coarse size threshold. The aggregation stops if the global number of variables of the computed coarsest matrix is lower @@ -746,17 +746,17 @@ class="cmtt-10x-x-109">MIN_COARSE_SIZE_PER_PROCESS’.

    ’MIN_CR_RATIO’

    real real

    Any number

    > 1

    1.5 > 1

    1.5

    Minimum coarsening ratio. The aggregation stops if the ratio between the global matrix dimensions at @@ -764,23 +764,23 @@ two consecutive levels is lower than or equal to this threshold (see Note).

    ’MAX_LEVS’

    integer integer

    Any integer

    number > 1

    20 > 1

    20

    Maximum number of levels. The aggregation stops if the number of levels reaches this value (see Note).

    ’PAR_AGGR_ALG

    character(len=*) =*)

    ’DEC’, ’SYMDEC’, ’COUPLED’ ’COUPLED’

    ’DEC’ ’DEC’

    Parallel aggregation algorithm.

    the SYMDEC option applies decoupled @@ -808,7 +808,7 @@ class="cmmi-10x-x-109">AT .

    ’AGGR_TYPE

    character(len=*) =*)

    ’SOC1’, ’MATCHBOXP’’

    ’SOC1’ ’

    Type of aggregation algorithm: currently, for the decoupled aggregation we implement two @@ -849,13 +849,13 @@ package [8].

    ’AGGR_SIZE’

    integer integer

    Any integer

    power of 2, with @@ -863,8 +863,8 @@ with class="cmtt-10x-x-109">aggr_size ≥ -2

    4

    4

    Maximum size of aggregates when the coupled aggregation based on matching is applied. For aggressive coarsening @@ -876,7 +876,7 @@ and ’MATCHBOXP’

    ’AGGR_PROL

    character(len=*) =*)

    ’SMOOTHED’, ’UNSMOOTHED’ ’

    ’SMOOTHED’ ’

    Prolongator used by the aggregation algorithm: smoothed or unsmoothed (i.e., tentative prolongator).

    Note. The aggregation algorithm stops when at least one of the following criteria is met: the coarse size threshold,
    -
    the minimum coarsening ratio, or the maximum number of levels is reached.
    -
    Therefore, the actual number of levels may be smaller than the specified maximum number of levels.
    -
    the minimum coarsening ratio, or the maximum number of levels is reached.
    +
    Therefore, the actual number of levels may be smaller than the specified maximum number of levels.
    +
    @@ -951,7 +951,7 @@ id="TBL-6-3">

    what a type e

    val val

    dfault t

    cnts

    ’AGGR_ORD

    character(len=*) =*)

    ’NATURAL’

    ’DEGREE’ ’DEGREE’

    ’NATURAL’ ’NATURAL’

    Initial ordering of indices for the decoupled aggregation algorithm: either natural ordering or sorted by @@ -1009,7 +1009,7 @@ descending degrees of the nodes in the matrix graph.

    ’AGGR_THRESH

    real(kind_parameter) )

    Any real

    number ∈ [0,1]

    0.01 ,1]

    0.01

    The threshold θ in the strength of connection algorithm. See also the note at the bottom of this table.

    ’AGGR_FILTER

    character(len=*) =*)

    ’FILTER’

    ’NOFILTER’ ’NOFILTER’

    ’NOFILTER’ ’NOFILTER’

    Matrix used in computing the smoothed prolongator: filtered or unfiltered.

    Note. Different thresholds at different levels, such as those used in [31, Section 5.1], can be easily set by invoking the rou-
    -
    tine
    tine set with the parameter ilev.
    -

    Table 4:

    what a type e

    val val

    dfault t

    cnts

    ’COARSE_MAT

    character(len=*) =*)

    ’DIST’

    ’REPL’ ’

    ’REPL’ ’

    Coarsest matrix layout: distributed among the processes or replicated on each of them.

    ’COARSE_SOLVE

    character(len=*) =*)

    ’MUMPS’

    ’KRM’

    See Note.’

    See Note.

    Solver used at the coarsest level: sequential LU from MUMPS, UMFPACK, or SuperLU (plus triangular solve); distributed LU from @@ -1230,7 +1230,7 @@ UMFPACK and SuperLU_Dist are available only in double precision.

    ’COARSE_SUBSOLVE

    character(len=*) =*)

    ’ILU’

    ’AINV’

    See Note.’

    See Note.

    Solver for the diagonal blocks of the coarsest matrix, in case the block Jacobi solver is chosen as coarsest-level solver: ILU(

    Note. Defaults for COARSE_SOLVE and COARSE_SUBSOLVE are chosen in the following order:
    -
    single precision version –
    single precision version – MUMPS if installed, then SLU if installed, ILU otherwise;
    -
    double precision version –
    double precision version – UMF if installed, then MUMPS if installed, then SLU if installed, ILU otherwise.
    -

    what a type e

    val val

    dfault t

    cts

    ’COARSE_SWEEPS’

    integer integer

    Any integer

    number > -0

    10

    10

    Number of sweeps when JACOBI, GS or BJAC is chosen as coarsest-level solver.

    ’COARSE_FILLIN’

    integer integer

    Any integer

    number ≥ -0

    0

    0

    Fill-in level p of the ILU factorizations and first fill-in for the approximate inverses.

    ’COARSE_ILUTHRS

    real(kind_parameter) )

    Any real

    number ≥ -0

    0

    0

    Drop tolerance t in the ILU(p,t) factorization and first drop-tolerance for the approximate inverses.

    Note. Further options for coarse solvers are contained in Table 6.
    -
    For a first use it is suggested to use the default options obtained by simply selecting the solver type.
    -
    For a first use it is suggested to use the default options obtained by simply selecting the solver type.
    +
    @@ -1456,6 +1456,9 @@ class="content">Parameters defining the solver at the coarsest level (continued)

    + + +

    s +class="cmtt-10x-x-109">’ +class="cmtt-10x-x-109">’ +class="cmtt-10x-x-109">integer +class="cmtt-10x-x-109">integer +residual.

    what

    		a type e

    val

    		val

    dfault

    		t

    cments

    ’BJAC_STOP

    character(len=*)

    		=*)

    ’FALSE’

    ’TRUE’

    		’

    ’FALSE’

    Select whether to use a stopping criterion for the -Block-Jacobi method used as a coarse solver.

    Select whether to use a stopping criterion for +the Block-Jacobi method used as a coarse +solver.

    ’BJAC_TRACE

    character(len=*)

    		=*)

    ’FALSE’

    ’TRUE’

    		’

    ’FALSE’

    Select whether to print a trace for the calculated -residual for the Block-Jacobi method used as a -coarse solver.

    Select whether to print a trace for the +calculated residual for the Block-Jacobi +method used as a coarse solver.

    ’BJAC_ITRACE’

    integer

    Any -integer > -0

    -1

    Number of iterations after which a trace is to be -printed.

    Any integer +> 0

    -1

    Number of iterations after which a trace is to +be printed.

    ’BJAC_RESCHECK’

    integer

    Any -integer > -0

    -1

    Number of iterations after which a residual is to -be calculated.

    Any integer +> 0

    -1

    Number of iterations after which a residual is +to be calculated.

    ’BJAC_STOPTOL

    real(kind_parameter)

    Any real -< 1

    0

    		)

    Any real < +1

    0

    Tolerance for the stopping criterion on the -residual.

    + style="vertical-align:baseline;" id="TBL-8-7-">

    ’KRM_METHOD’

    character(len=*)

    ’CG’ +

    ’FCG’ +

    ’CGS’ +

    ’CGR’ +

    ’BICG’ +

    ’BICGSTAB’ +

    ’BICGSTABL’ +

    ’RGMRES’

    ’FCG’

    A string that defines the iterative method to +be used. CG the Conjugate Gradient method; +CGS the Conjugate Gradient Stabilized +method; GCR the Generalized Conjugate +Residual method; FCG the Flexible Conjugate +Gradient method; BICG the Bi-Conjugate +Gradient method; BICGSTAB the Bi-Conjugate +Gradient Stabilized method; BICGSTABL the +Bi-Conjugate Gradient Stabilized method +with restarting; RGMRES the Generalized +Minimal Residual method with restarting. +Refer to the PSBLAS guide [18] for further +information. +

    ’KRM_KPREC’

    character(len=*)

    Table 1

    ’BJAC’

    The one-level +preconditioners from the Table 1 can be used +for the coarse Krylov solver. +

    ’KRM_SUB_SOLVE’

    character(len=*)

    Table 5

    ’ILU’

    Solver for the diagonal blocks of the coarsest +matrix preconditioner, in case the block Jacobi +solver is chosen +as ’KRM_KPREC’: ILU(p), ILU(p,t), MILU(p), +LU from MUMPS, SuperLU or UMFPACK +(plus triangular solve), Approximate Inverses +INVK(p,q), INVT(p1,p2,t1,t2) and AINV(t); +The same caveat from Table 5 applies here. +

    ’KRM_GLOBAL’

    character(len=*)

    ’TRUE’, +’FALSE’

    ’FALSE’

    Choose between a global Krylov solver, all +unknowns on a single node, or a distributed +one. The default choice is the distributed +solver. +

    ’KRM_EPS’

    real(kind_parameter)

    Real < 1

    10-6

    The stopping tolerance. +

    ’KRM_IRST’

    integer

    Integer +

    ≥ 1

    30

    An integer specifying the restart parameter. +This is employed for the BiCGSTABL or RGMRES +methods, otherwise it is ignored. +

    ’KRM_ISTOPC’

    integer

    Integers +1,2,3

    2

    If 1 then the method uses the normwise +backward error in the infinity norm; if 2, the +it uses the relative residual in the 2-norm; if 3 +the relative residual reduction in the 2-norm is +used instead; refer to the PSBLAS [18] guide +for the details. +

    ’KRM_ITMAX’

    integer

    Integer +

    ≥ 1

    40

    The maximum number of iterations to +perform. +

    ’KRM_ITRACE’

    integer

    Integer +

    ≥ 0

    -1

    If > 0 print out +an informational message about convergence +every ’KRM_ITRACE’ iterations. If = 0 print a +message in case of convergence failure. +

    ’KRM_FILLIN’

    integer

    Integer +

    ≥ 0

    0

    Fill-in level p of the ILU factorizations and +first fill-in for the approximate inverses. +

    + + +

    Table 6: Additional parameters defining the solver at the coarsest level.
    @@ -1618,7 +1894,7 @@ class="content">Additional parameters defining the solver at the coarsest level. -

    @@ -1626,7 +1902,7 @@ class="content">Additional parameters defining the solver at the coarsest level.
    -

    +

    what

    		a type

    val

    e

    val

    default

    t

    conts

    ’SMOOTHER_TYPE’

    character(len=*)

    =*)

    ’JACOBI’ -

    ’GS’ -

    ’BGS’ -

    ’BJAC’ -

    ’AS’ -

    ’L1-JACOBI’ -

    ’L1-BJAC’ -

    ’L1-FBGS’

    ’

    ’FBGS’

    ’

    Type of smoother used in the multilevel preconditioner: point-Jacobi, hybrid @@ -1742,21 +2018,21 @@ class="cmr-10">–hybrid (forward) Gauss-Seidel, class="cmmi-10">ℓ1-point-Jacobi and Additive Schwarz. -

    It is ignored by one-level preconditioners.

    ’SUB_SOLVE’

    character(len=*)

    =*)

    ’JACOBI’ @@ -1764,47 +2040,47 @@ class="cmtt-10">’ class="cmtt-10">’GS’ -

    ’BGS’ -

    ’ILU’ -

    ’ILUT’ -

    ’MILU’ -

    ’MUMPS’ -

    ’SLU’ -

    ’UMF’ -

    ’INVT’ -

    ’INVK’ -

    ’AINV’

    ’

    GS and BGS multilevel class="cmr-10">preconditioners, respectively -

    ILU for block-Jacobi and Additive Schwarz one-level preconditioners

    preconditioners

    The local solver to be used with the smoother or one-level preconditioner (see @@ -1881,23 +2157,23 @@ class="cmr-10">. See class="cmr-10">Note for details on hybrid Gauss-Seidel.

    ’SMOOTHER_SWEEPS’

    integer

    integer

    Any integer -

    number ≥ 0

    1

    0

    1

    Number of sweeps of the smoother or one-level preconditioner. In the multilevel @@ -1923,29 +2199,29 @@ class="cmr-10">, class="cmr-10">respectively.

    ’SUB_OVR’

    integer

    integer

    Any integer -

    number ≥ 0

    1

    0

    1

    Number of overlap layers, for Additive Schwarz only.


    Table 7:
    -

    @@ -1968,7 +2244,7 @@ preconditioner.
    -

    +

    what

    		a type

    val

    e

    val

    default

    t

    conts

    ’SUB_RESTR’

    character(len=*)

    =*)

    ’HALO’ -

    ’NONE’

    ’

    ’HALO’

    ’

    Type of restriction operator, for Additive Schwarz only: ’NONE’ for neglecting it. -

    Note that HALO must be chosen for the @@ -2057,29 +2333,29 @@ class="cmr-10">classical Addditive Schwarz smoother and class="cmr-10">its RAS variant.

    ’SUB_PROL’

    character(len=*)

    =*)

    ’SUM’ -

    ’NONE’

    ’

    ’NONE’

    ’

    Type of prolongation operator, for Additive Schwarz only: ’ for neglecting them. -

    Note that ’SUM’ for its RAS variant.

    ’SUB_FILLIN’

    integer

    integer

    Any integer -

    number ≥ 0

    0

    0

    0

    Fill-in level p of the incomplete LU @@ -2134,26 +2410,26 @@ class="cmr-10">of the incomplete LU class="cmr-10">factorizations.

    ’SUB_ILUTHRS’

    real(kind_parameter)

    )

    Any real number ≥ 0

    0

    0

    0

    Drop tolerance t in the ILU() class="cmr-10">factorization.

    ’MUMPS_LOC_GLOB’

    character(len=*)

    =*)

    ’LOCAL_SOLVER’ -

    ’GLOBAL_SOLVER’

    ’

    ’GLOBAL_SOLVER’

    ’

    Whether MUMPS should be used as a distributed solver, or as a serial solver acting @@ -2195,20 +2471,20 @@ class="cmr-10">only on the part of the matrix local to each class="cmr-10">process.

    ’MUMPS_IPAR_ENTRY’

    integer

    integer

    Any integer number

    0

    number

    0

    Set an entry in the MUMPS integer control array, as chosen via the optional class="cmr-10">argument.

    ’MUMPS_RPAR_ENTRY’

    real

    Any real number

    0

    real

    Any real number

    0

    Set an entry in the MUMPS real control array, as chosen via the optional class="cmr-10">argument.


    Table 8: Parameters defining the smoother or the details of the one-level -

    [next] [up]

    -

    diff --git a/docs/html/userhtmlsu9.html b/docs/html/userhtmlsu9.html index 9b315634..d018414b 100644 --- a/docs/html/userhtmlsu9.html +++ b/docs/html/userhtmlsu9.html @@ -10,7 +10,7 @@ -

    [nextMethod hierarchy_build

    -

    -

    +

    call p,info)

    -

    This method builds the hierarchy of matrices and restriction/prolongation operators for the multilevel preconditioner init and set. -

    Arguments

    a

    a

    type(psb_in).

    The sparse matrix structure containing the local part of the matrix to be preconditioned. Note that 18].

    desc_a

    desc_a

    type(psb_desc_typein).

    The communication descriptor of a. See the PSBLAS User’s Guide @@ -135,10 +135,10 @@ class="cmr-12">18].

    info

    info

    integer, out).

    Error code. If no error, 0 is returned. See Section 7 for details.

    @@ -165,7 +165,7 @@ class="td11">
    -

    [next] [up]

    -

    diff --git a/docs/src/userguide.pdf b/docs/src/userguide.pdf deleted file mode 120000 index 7b032aa3..00000000 --- a/docs/src/userguide.pdf +++ /dev/null @@ -1 +0,0 @@ -tmp/userguide.pdf \ No newline at end of file diff --git a/docs/src/userinterface.tex b/docs/src/userinterface.tex index fb9e0051..6d840c71 100644 --- a/docs/src/userinterface.tex +++ b/docs/src/userinterface.tex @@ -492,7 +492,7 @@ level (continued).\label{tab:p_coarse_1}} \bsideways \begin{center} - \begin{tabular}{|p{3.9cm}|l|p{1.7cm}|p{1.7cm}|p{8cm}|} + \begin{tabular}{|p{3.9cm}|l|p{2cm}|p{1.7cm}|p{7.7cm}|} \hline \fortinline|what| & \textsc{data type} & \fortinline|val| & \textsc{default} & \textsc{comments} \\ \hline @@ -501,8 +501,48 @@ level (continued).\label{tab:p_coarse_1}} \fortinline|'BJAC_ITRACE'| & \fortinline|integer| & Any integer $>0$ & -1 & Number of iterations after which a trace is to be printed. \\ \hline \fortinline|'BJAC_RESCHECK'|& \fortinline|integer| & Any integer $>0$ & -1 & Number of iterations after which a residual is to be calculated. \\ \hline \fortinline|'BJAC_STOPTOL'| & \fortinline|real(kind_parameter)| & Any real $<1$ & 0 & Tolerance for the stopping criterion on the residual. \\ \hline - - \hline + \fortinline|'KRM_METHOD'| & \fortinline|character(len=*)| & \fortinline|'CG'| \par \fortinline|'FCG'| \par \fortinline|'CGS'| \par \fortinline|'CGR'| \par \fortinline|'BICG'| \par \fortinline|'BICGSTAB'| \par \fortinline|'BICGSTABL'| \par \fortinline|'RGMRES'| & \fortinline|'FCG'| & A string that defines the iterative method to be + used. \texttt{CG} the Conjugate Gradient method; + \texttt{CGS} the Conjugate Gradient Stabilized method; + \texttt{GCR} the Generalized Conjugate Residual method; + \texttt{FCG} the Flexible Conjugate Gradient method; + \texttt{BICG} the Bi-Conjugate Gradient method; + \texttt{BICGSTAB} the Bi-Conjugate Gradient Stabilized method; + \texttt{BICGSTABL} the Bi-Conjugate Gradient Stabilized method with restarting; + \texttt{RGMRES} the Generalized Minimal Residual method with restarting. Refer to the PSBLAS guide~\cite{PSBLASGUIDE} for further information. \\ \hline + \fortinline|'KRM_KPREC'| & \fortinline|character(len=*)| & Table~\ref{tab:precinit} & \fortinline|'BJAC'| & The one-level preconditioners from the Table~\ref{tab:precinit} can be used for the coarse Krylov solver. \\ \hline +\ifpdf +\phantomcaption +\end{tabular} +\end{center} +\esideways +\bsideways +\ContinuedFloat +\begin{center} +\begin{tabular}{|p{3.9cm}|l|p{1.7cm}|p{1.7cm}|p{8.6cm}|} +\hline +\fi + \fortinline|'KRM_SUB_SOLVE'| & \fortinline|character(len=*)| & Table~\ref{tab:p_coarse_1} & \fortinline|'ILU'| & Solver for the diagonal blocks of the coarsest matrix preconditioner, + in case the block Jacobi solver + is chosen as \fortinline|'KRM_KPREC'|: ILU($p$), ILU($p,t$), + MILU($p$), LU from MUMPS, SuperLU or UMFPACK + (plus triangular solve), Approximate + Inverses INVK($p,q$), INVT($p_1,p2,t_1,t_2$) and + AINV($t$); The same caveat from Table~\ref{tab:p_coarse_1} applies here. \\ \hline + \fortinline|'KRM_GLOBAL'| & \fortinline|character(len=*)| & \fortinline|'TRUE'|, \fortinline|'FALSE'| & \fortinline|'FALSE'| & Choose between a global Krylov solver, all unknowns on a single node, or a distributed one. The default choice is the distributed solver. \\ \hline + \fortinline|'KRM_EPS'| & \fortinline|real(kind_parameter)| & Real $< 1$ & $10^{-6}$ & The stopping tolerance. \\ \hline + \fortinline|'KRM_IRST'| & \fortinline|integer| & Integer \par $\ge 1$ & 30 & An integer specifying the restart parameter. This is employed for the \texttt{BiCGSTABL} or \texttt{RGMRES} methods, otherwise it is ignored. \\ \hline + \fortinline|'KRM_ISTOPC'| & \fortinline|integer| & Integers 1,2,3 & 2 & If \texttt{1} then the method uses the normwise backward error in the infinity + norm; if \texttt{2}, the it uses the relative residual in the 2-norm; if \texttt{3} the relative residual reduction in the 2-norm is used instead; refer to the PSBLAS~\cite{PSBLASGUIDE} guide for the details. \\ \hline + \fortinline|'KRM_ITMAX'| & \fortinline|integer| & Integer \par $\ge 1$ & 40 & The maximum number of iterations to perform. \\ \hline + \fortinline|'KRM_ITRACE'| & \fortinline|integer| & Integer \par $\ge 0$ & -1 & If $>0$ print out an informational message about + convergence every \fortinline|'KRM_ITRACE'| iterations. If $=0$ print a message in + case of convergence failure. \\ \hline +% \fortinline|'KRM_SUB_SOLVE'| & \fortinline|integer| & Integer \par $\ge 1$ & -1 & If $>0$ the number of iteration made by the solver for the diagonal blocks. \\ \hline + \fortinline|'KRM_FILLIN'| & \fortinline|integer| & Integer \par $\ge 0$ + & 0 + & Fill-in level $p$ of the ILU factorizations + and first fill-in for the approximate inverses. \\ \hline \end{tabular} \end{center} \caption{Additional parameters defining the solver at the coarsest