diff --git a/docs/amg4psblas_1.0-guide.pdf b/docs/amg4psblas_1.0-guide.pdf index 83f08e0a..99f4db57 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 add1eb7b..03cbeae9 100644 --- a/docs/html/userhtml.css +++ b/docs/html/userhtml.css @@ -194,9 +194,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-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;} -td#TBL-5-13-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;} diff --git a/docs/html/userhtmlsu10.html b/docs/html/userhtmlsu10.html index 040c8097..d135883c 100644 --- a/docs/html/userhtmlsu10.html +++ b/docs/html/userhtmlsu10.html @@ -10,7 +10,7 @@ -

[nextMethod smoothers_build

-

-

+

call p,imold])

-

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

Arguments

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

a

type(psb_).

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

desc_a

type(psb_desc_type).

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

info

integer, ).

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

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 @@ -205,9 +205,9 @@ class="cmr-12">].

vmold

class(psb_optional.

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

imold

class(psb_i_base_vect_typeoptional.

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

-

[next] [up]

-

diff --git a/docs/html/userhtmlsu11.html b/docs/html/userhtmlsu11.html index 6c600111..0c96228b 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,7 +83,7 @@ class="cmtt-12">smoothers_build, whose nomenclature would however be somewhat unnatural when dealing with simple one-level preconditioners. -

Arguments

a

type(psb_).

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

desc_a

type(psb_desc_type).

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

info

integer, ).

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

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 @@ -213,9 +213,9 @@ class="cmr-12">].

vmold

class(psb_optional.

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

imold

class(psb_i_base_vect_typeoptional.

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 ec2c0cd5..0f3e74f0 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

type(kind).

The local part of the vector x. Note that , single/double class="cmr-12">precision version of AMG4PSBLAS under use.

y

type(kind).

The local part of the vector y. Note that , single/double class="cmr-12">precision version of AMG4PSBLAS under use.

desc_a

type(psb_desc_type).

The communication descriptor associated to the matrix to be preconditioned.

info

integer, ).

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

trans

character(lenin).

If trans = 1).

work

type(kindtarget.

Workspace. Its size should be at least 4 

-

[next] [up]

-

diff --git a/docs/html/userhtmlsu13.html b/docs/html/userhtmlsu13.html index 13fea9f5..db27df94 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

integer, ).

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

-

[next] [up]

-

diff --git a/docs/html/userhtmlsu14.html b/docs/html/userhtmlsu14.html index efe3a793..adbbbbd9 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,7 +68,7 @@ class="cmtt-12">build, have been called. -

Arguments

info

integer, ).

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

iout

integer, optional.

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

root

integer, optional.

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

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 @@ -174,7 +174,7 @@ class="td11">

-

[next] [up]

-

diff --git a/docs/html/userhtmlsu15.html b/docs/html/userhtmlsu15.html index 7b3a4787..8b9ca9aa 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

integer, ).

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

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 @@ -134,15 +134,15 @@ class="cmr-12">.

-

+

5.9.2 Method: clone
-

-

+

call p)
-

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

Arguments

pout

type(amg_).

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

info

integer, ).

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

-

+

5.9.3 Method: sizeof
-

-

+

sz =

global

logical, optional.

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

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,7 +326,7 @@ class="cmr-12">argument to the apply method. -

Arguments

info

integer, ).

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

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

+multiplied by the number of processes +(see Note). - +prolongators. Used only with ’COUPLED’ +and ’MATCHBOXP’
Note. The aggregation algorithm stops when at least one of the following criteria is met: the coarse size threshold,
the coarse size threshold per process, 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.

info

integer, ).

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

Coarse size threshold per pro aggregation stops if the global number of variables of the computed coarsest matrix is lower than or equal to this threshold -multiplied by the number of processes. -

’MIN_COARSE_SIZE’

integer

Any number -

Any number +

> 0

-1

Coarse size threshold. The aggregation +class="td11">

-1

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

’MIN_CR_RATIO’

real

Any number -

Any number +

> 1

1.5

Minimum coarsening +class="td11">

1.5

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

’MAX_LEVS’

integer

Any integer -

number

Any integer +

number > 1

20

Maximum number of levels. The +class="td11">

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’

’DEC’

Parallel aggregation algorithm. -

the

Parallel aggregation algorithm. +

the SYMDEC option applies decoupled aggregation to the sparsity pattern of T .

what

data type

val

default

comments

’AGGR_TYPE’

’

character(len=*)

=*)

’SOC1’

’

’SOC1’, ’MATCHBOXP’

’

Type of aggregation algorithm: currently, for the decoupled aggregation we implement two @@ -884,40 +848,43 @@ package [8].

’AGGR_SIZE’

’

integer

integer

Any integer -

number -power of 2 -and > 2

4

power of 2, +with +aggr_size ≥ +2

4

Maximum size of aggregates when the coupled aggregation based on matching is applied. For aggressive coarsening with size of aggregate larger than 8 we recommend the use of smoothed -prolongators. MODIFICARE -CODICE

’AGGR_PROL’

’

character(len=*)

=*)

’SMOOTHED’, ’UNSMOOTHED’

’

’SMOOTHED’

’

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

+ style="vertical-align:baseline;" id="TBL-5-13-"> +
@@ -1273,53 +1241,53 @@ double precision.

’COARSE_SUBSOLVE’

character(len=*)

’ILU’ -

’ILUT’ -

’MILU’ -

’MUMPS’ -

’SLU’ -

’UMF’ -

’INVT’ -

’INVK’ -

’AINV’

See Note.

Solver for the diagonal blocks of the coarse matrix, +class="td11">

See Note.

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

what type

val

deault

cos

’COARSE_SWEEPS’

integer

Any +class="td11">

Any integer -

number

number > 0

10

Number of sweeps when

10

Number of sweeps when JACOBI, GS or BJAC @@ -1425,39 +1393,39 @@ class="cmbx-10x-x-109">criterio di arresto del PCG? <

’COARSE_FILLIN’

integer

Any +class="td11">

Any integer -

number

number ≥ 0

0

Fill-in level

0

Fill-in level p of the ILU factorizations.

’COARSE_ILUTHRS’

real( kind_parameter

_parameter

)

Any real -

number

Any real +

number ≥ 0

0

Drop tolerance

0

Drop tolerance t in the ILU(p,t) factorization. Parameters defining the coarse-space correction at the co -

@@ -1489,7 +1457,7 @@ class="content">Parameters defining the coarse-space correction at the co
-

+

@@ -1759,7 +1727,7 @@ preconditioner. -

@@ -1767,7 +1735,7 @@ preconditioner.
-

+

what

type

val

deault

cots

’SMOOTHER_TYPE’

character(len=*)

’JACOBI’ -

’GS’ -

’BGS’ -

’BJAC’ -

’AS’

’FBGS’

Type of smoother used in the multilevel preconditioner: point-Jacobi, hybrid @@ -1581,55 +1549,55 @@ class="cmr-7">1-versions? and Additive Schwarz. -

It is ignored by one-level preconditioners.

’SUB_SOLVE’

character(len=*)

’JACOBI’ -

’GS’ -

’BGS’ -

’ILU’ -

’ILUT’ -

’MILU’ -

’MUMPS’ -

’SLU’ -

’UMF’

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

ILU for block-Jacobi preconditioners class="cmmi-10">ℓ1-versions?

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

’SMOOTHER_SWEEPS’

integer

Any integer -

number ≥ 0

1

1

Number of sweeps of the smoother or one-level preconditioner. In the multilevel @@ -1723,22 +1691,22 @@ class="cmr-10">respectively.

’SUB_OVR’

integer

Any integer -

number ≥ 0

1

1

Number of overlap layers, for Additive Schwarz only.

what

type

val

deault

cots

’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 @@ -1857,28 +1825,28 @@ 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 ’SUMfor its RAS variant.

’SUB_FILLIN’

integer

Any integer -

number ≥ 0

0

0

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

’SUB_ILUTHRS’

real( kind_parameter

_parameter

)

Any real number ≥ 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 @@ -1994,19 +1962,19 @@ class="cmr-10">only on the part of the matrix local to each class="cmr-10">process.

’MUMPS_IPAR_ENTRY’

integer

Any integer number

0

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

Any real number

0

Set an entry in the MUMPS real control array, as chosen via the 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 40c62231..39ea9358 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

type(psb_).

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

desc_a

type(psb_desc_type).

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

info

integer, ).

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

-

[next] [up]

-

diff --git a/docs/src/userinterface.tex b/docs/src/userinterface.tex index 51f34461..986c3ddc 100644 --- a/docs/src/userinterface.tex +++ b/docs/src/userinterface.tex @@ -249,8 +249,7 @@ be applied. if the global number of variables of the computed coarsest matrix is lower than or equal to this threshold - multiplied by the number of processes. - + multiplied by the number of processes (see Note). \\ \hline \fortinline|'MIN_COARSE_SIZE'| & \fortinline|integer| & Any number \par $> 0$ @@ -311,12 +310,12 @@ aggregation is based on a parallel version of the half-approximate matching implemented in the MatchBox-P software package~\cite{MatchBoxP}.\\ \hline \fortinline|'AGGR_SIZE'| & \fortinline|integer| \hspace*{-3mm} -& Any integer \par number power of $2$ and $> 2$ +& Any integer \par power of $2$, with $\texttt{aggr\_size} \ge 2$ & 4 & Maximum size of aggregates when the coupled aggregation based on matching is applied. For aggressive coarsening with size of aggregate larger than $8$ we recommend the use of smoothed prolongators. -{\bf MODIFICARE CODICE}\\ \hline + Used only with \texttt{'COUPLED'} and \texttt{'MATCHBOXP'}\\ \hline \fortinline|'AGGR_PROL'| & \fortinline|character(len=*)| \hspace*{-3mm} & \fortinline|'SMOOTHED'|, \fortinline|'UNSMOOTHED'| & \fortinline|'SMOOTHED'|