diff --git a/docs/amg4psblas_1.0-guide.pdf b/docs/amg4psblas_1.0-guide.pdf index 99f4db57..890cce79 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 03cbeae9..1256d779 100644 --- a/docs/html/userhtml.css +++ b/docs/html/userhtml.css @@ -9,7 +9,6 @@ .cmbx-12x-x-144{ font-weight: bold;} .cmbx-12x-x-144{ font-weight: bold;} .cmbx-12x-x-144{ font-weight: bold;} -.cmti-10x-x-109{ font-style: italic;} .cmti-12{font-size:109%; font-style: italic;} .cmr-12{font-size:109%;} .cmbx-12{font-size:109%; font-weight: bold;} @@ -43,7 +42,6 @@ .cmbx-10{ font-weight: bold;} .cmbx-10{ font-weight: bold;} .cmbx-10{ font-weight: bold;} -.cmti-10{font-size:90%; font-style: italic;} .small-caps{font-variant: small-caps; } p{margin-top:0;margin-bottom:0} p.indent{text-indent:0;} diff --git a/docs/html/userhtmlse7.html b/docs/html/userhtmlse7.html index 6e7d596e..70fa244e 100644 --- a/docs/html/userhtmlse7.html +++ b/docs/html/userhtmlse7.html @@ -61,10 +61,6 @@ class="cmr-12">. -

- - - diff --git a/docs/html/userhtmlsu10.html b/docs/html/userhtmlsu10.html index d135883c..7b7acdfd 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 0c96228b..04739441 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 0f3e74f0..08338081 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

+class="cmr-12">, dimension(:), intent(in)—. +class="cmr-12">, dimension(:), intent(out)—. +class="cmtt-12">kind_parameter), dimension(:), optional, target—.

x

type(kind_parameter), dimension(:), intent(inkind_parameter).

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

y

type(kind_parameter), dimension(:), intent(outkind_parameter).

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(kind_parameter), dimension(:), optional, target.

Workspace. Its size should be at least 4 

-

[next] [up]

-

diff --git a/docs/html/userhtmlsu13.html b/docs/html/userhtmlsu13.html index db27df94..a8692817 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 adbbbbd9..1db27eff 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 8b9ca9aa..4fae0f3d 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

+class="td11">

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

+class="td11">

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

Parameters defining the coarse-space correction at the co -

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

+

info

integer, ).

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

e

val

AGGR_THRESH’

real( kind_parameter

)

(kind_parameter)

Any real

number ∈ [0,1]

0.01

The threshold θ in the decoupled -aggregation algorithm, see (??) in -Section ??. See also the note at the -bottom of this table.

’FILTER’ class="cmtt-10x-x-109">’NOFILTER’

’NOFILTER’

Matrix used in computing the smoothed -prolongator: filtered or unfiltered -(see (??) in Section ??).

Parameters defining the aggregation algorithm (continued).

@@ -1090,7 +1083,7 @@ class="content">Parameters defining the aggregation algorithm (continued). -

+

@@ -1104,7 +1097,7 @@ id="TBL-7-4">

what

a type

e

val

deault

cots

’COARSE_MAT’

character(len=*)

’DIST’ -

’REPL’

’REPL’

Coarsest matrix layout: distributed among the +class="td11">

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

’COARSE_SOLVE’

character(len=*)

’MUMPS’ -

’UMF’ -

’SLU’ -

’SLUDIST’ -

’JACOBI’ -

’GS’ -

’BJAC’ -

’RKR’

See Note.

Solver used at the coarsest level: sequential LU +class="td11">

See Note.

Solver used at the coarsest level: sequential LU from MUMPS, UMFPACK, or SuperLU (plus triangular solve); distributed LU from MUMPS or SuperLU_Dist (plus triangular solve); point-Jacobi, @@ -1241,53 +1234,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

a type

e

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 @@ -1393,39 +1386,38 @@ 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

)

Any real -

number (kind_parameter)

Any real +

number ≥ 0

0

Drop tolerance

0

Drop tolerance t in the ILU(p,t) factorization.

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

@@ -1735,7 +1727,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 @@ -1549,55 +1541,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 @@ -1650,22 +1642,22 @@ class="cmr-10">Note for details on hybrid Gauss-Seidel.

’SMOOTHER_SWEEPS’

integer

Any integer -

number ≥ 0

1

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

’SUB_OVR’

integer

Any integer -

number ≥ 0

1

Number of overlap layers, for Additive Schwarz only.

- - -

what

a type

e

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 @@ -1825,28 +1817,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

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

’SUB_ILUTHRS’

real( kind_parameter

)

(kind_parameter)

Any real number ≥ 0

0

Drop tolerance t in the ILU(p,t) 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 @@ -1960,21 +1952,22 @@ class="cmr-10">distributed solver, or as a serial solver acting class="cmr-10">only on the part of the matrix local to each process.

’MUMPS_IPAR_ENTRY’

integer

Any integer number

0

Set an entry in the MUMPS integer control array, as chosen via the idx optional argument.

’MUMPS_RPAR_ENTRY’

real

Any real number

0

Set an entry in the MUMPS real control +class="td11">

Set an entry in the MUMPS real control array, as chosen via the idx 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 39ea9358..c7bd6767 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 986c3ddc..2a4adfe9 100644 --- a/docs/src/userinterface.tex +++ b/docs/src/userinterface.tex @@ -354,17 +354,19 @@ aggregate larger than $8$ we recommend the use of smoothed prolongators. %Since aggregation is %heuristic, results will be different. -\fortinline|'AGGR_THRESH'| & \fortinline|real(|\emph{kind\_parameter}\fortinline|)| +\fortinline|'AGGR_THRESH'| & \fortinline|real(kind_parameter)| & Any~real \par number~$\in [0, 1]$ & 0.01 - & The threshold $\theta$ in the decoupled aggregation algorithm, - see (\ref{eq:strongly_coup}) in Section~\ref{sec:aggregation}. + & The threshold $\theta$ in the strength of + connection algorithm. See also the note at the bottom of this table. \\ \hline \fortinline|'AGGR_FILTER'| & \fortinline|character(len=*)| & \texttt{'FILTER'} \par \texttt{'NOFILTER'} - & \texttt{'NOFILTER'} & Matrix used in computing the smoothed - prolongator: filtered or unfiltered (see~(\ref{eq:filtered}) in Section~\ref{sec:aggregation}). \\ + & \texttt{'NOFILTER'} & + Matrix used in computing the smoothed + prolongator: filtered or unfiltered. % (see~(\ref{eq:filtered}) in Section~\ref{sec:aggregation}) + \\ \hline \multicolumn{5}{|l|}{{\bfseries Note.} Different thresholds at different levels, such as those used in \cite[Section~5.1]{VANEK_MANDEL_BREZINA}, can be easily set by @@ -468,7 +470,7 @@ the parameter \texttt{ilev}.} \\ & 0 & Fill-in level $p$ of the ILU factorizations. \\ \hline \fortinline|'COARSE_ILUTHRS'| - & \fortinline|real(|\emph{kind\_parameter}\fortinline|)| + & \fortinline|real(kind_parameter)| & Any real \par number $\ge 0$ & 0 & Drop tolerance $t$ in the ILU($p,t$) factorization. \\ @@ -559,22 +561,22 @@ level (continued).\label{tab:p_coarse_1}} & Any integer \par number~$\ge 0$ & 0 & Fill-in level $p$ of the incomplete LU factorizations. \\ \hline -\fortinline|'SUB_ILUTHRS'| & \fortinline|real(|\emph{kind\_parameter}\fortinline|)| +\fortinline|'SUB_ILUTHRS'| & \fortinline|real(kind_parameter)| & Any real number~$\ge 0$ & 0 - & Drop tolerance $t$ in the ILU($p,t$) factorization. \\ %\hline + & Drop tolerance $t$ in the ILU($p,t$) factorization. \\ \hline \fortinline|'MUMPS_LOC_GLOB'| & \fortinline|character(len=*)| & \fortinline|'LOCAL_SOLVER'| \par \fortinline|'GLOBAL_SOLVER'| & \fortinline|'GLOBAL_SOLVER'| & Whether MUMPS should be used as a distributed solver, or as a serial solver acting only on the part of the matrix local - to each process. \\ %\hline + to each process. \\ \hline \fortinline|'MUMPS_IPAR_ENTRY'| & \fortinline|integer| & Any integer number & 0 & Set an entry in the MUMPS integer control array, as - chosen via the \fortinline|idx| optional argument. \\ %\hline + chosen via the \fortinline|idx| optional argument. \\ \hline \fortinline|'MUMPS_RPAR_ENTRY'| & \fortinline|real| & Any real number & 0 @@ -728,11 +730,11 @@ and hence it is completely transparent to the user. {\vskip1.5\baselineskip\noindent\large\bfseries Arguments} \smallskip \begin{tabular}{p{1.2cm}p{12cm}} -\fortinline|x| & \emph{type}\fortinline|(|\emph{kind\_parameter}\fortinline|), dimension(:), intent(in)|.\\ +\fortinline|x| & \emph{type}\fortinline|(kind_parameter)|, dimension(:), intent(in)|.\\ & The local part of the vector $x$. Note that \emph{type} and \emph{kind\_parameter} must be chosen according to the \fortinline|real|/\fortinline|complex|, single/double precision version of AMG4PSBLAS under use.\\ -\fortinline|y| & \emph{type}\fortinline|(|\emph{kind\_parameter}\fortinline|), dimension(:), intent(out)|.\\ +\fortinline|y| & \emph{type}\fortinline|(kind_parameter)|, dimension(:), intent(out)|.\\ & The local part of the vector $y$. Note that \emph{type} and \emph{kind\_parameter} must be chosen according to the \fortinline|real|/\fortinline|complex|, single/double precision version of AMG4PSBLAS under use.\\ @@ -746,7 +748,7 @@ and hence it is completely transparent to the user. if \fortinline|trans| = \fortinline|'T','t'| then $op(B^{-1}) = B^{-T}$ (transpose of $B^{-1})$; if \fortinline|trans| = \fortinline|'C','c'| then $op(B^{-1}) = B^{-C}$ (conjugate transpose of $B^{-1})$.\\ -\fortinline|work| & \emph{type}\fortinline|(|\emph{kind\_parameter}\fortinline|), dimension(:), optional, target|.\\ +\fortinline|work| & \emph{type}\fortinline|(kind_parameter)|, dimension(:), optional, target|.\\ & Workspace. Its size should be at least \fortinline|4 * psb_cd_get_local_| \fortinline|cols(desc_a)| (see the PSBLAS User's Guide). Note that \emph{type} and \emph{kind\_parameter} must be chosen according