+@article{DDF2021, - author = {D’Ambra, Pasqua and Durastante, Fabio and Filippone, Salvatore}, - title = {{{AMG Preconditioners for Linear Solvers towards Extreme Scale}}, - journal = {arXiv e-preprints}, - eprint = {2006.16147v3}, - archivePrefix = {arXiv}, - year={2021} - } -@Misc{psctoolkit-web-page, - author = {D’Ambra, Pasqua and Durastante, Fabio and Filippone, Salvatore}, - title = {{PSCToolkit} {W}eb page}, - url = {https://psctoolkit.github.io/}, - howpublished = {\url{https://psctoolkit.github.io/}}, - year = {2021} - } - +
author = {D’Ambra, Pasqua and Durastante, Fabio and Filippone, Salvatore}, +
title = {{{AMG Preconditioners for Linear Solvers towards Extreme Scale}}, +
journal = {arXiv e-preprints}, +
eprint = {2006.16147v3}, +
archivePrefix = {arXiv}, +
year={2021} +
} +
+
@Misc{psctoolkit-web-page, +
author = {D’Ambra, Pasqua and Durastante, Fabio and Filippone, Salvatore}, +
title = {{PSCToolkit} {W}eb page}, +
url = {https://psctoolkit.github.io/}, +
howpublished = {\url{https://psctoolkit.github.io/}}, +
year = {2021} +
} +diff --git a/docs/html/userhtmlli5.html b/docs/html/userhtmlli5.html index b9362d17..a6336dcb 100644 --- a/docs/html/userhtmlli5.html +++ b/docs/html/userhtmlli5.html @@ -3,8 +3,8 @@
References - - + + diff --git a/docs/html/userhtmlse1.html b/docs/html/userhtmlse1.html index f7af8224..2d0fbf00 100644 --- a/docs/html/userhtmlse1.html +++ b/docs/html/userhtmlse1.html @@ -3,8 +3,8 @@General Overview - - + + diff --git a/docs/html/userhtmlse2.html b/docs/html/userhtmlse2.html index 8c0e20d1..474befde 100644 --- a/docs/html/userhtmlse2.html +++ b/docs/html/userhtmlse2.html @@ -3,8 +3,8 @@Code Distribution - - + + diff --git a/docs/html/userhtmlse3.html b/docs/html/userhtmlse3.html index 3184abfd..c806825f 100644 --- a/docs/html/userhtmlse3.html +++ b/docs/html/userhtmlse3.html @@ -3,8 +3,8 @@Configuring and Building AMG4PSBLAS - - + + diff --git a/docs/html/userhtmlse4.html b/docs/html/userhtmlse4.html index 6e7558c6..b932dc14 100644 --- a/docs/html/userhtmlse4.html +++ b/docs/html/userhtmlse4.html @@ -3,8 +3,8 @@Getting Started - - + + diff --git a/docs/html/userhtmlse5.html b/docs/html/userhtmlse5.html index 8f6ba4e7..b4a1075b 100644 --- a/docs/html/userhtmlse5.html +++ b/docs/html/userhtmlse5.html @@ -3,8 +3,8 @@User Interface - - + + diff --git a/docs/html/userhtmlse6.html b/docs/html/userhtmlse6.html index 5cbf8ab8..15f0ee45 100644 --- a/docs/html/userhtmlse6.html +++ b/docs/html/userhtmlse6.html @@ -3,8 +3,8 @@Adding new smoother and solver objects to AMG4PSBLAS - - + + @@ -215,22 +215,24 @@ class="cmr-12">pass it as follows: -- ! sparse matrix and preconditioner - type(psb_dspmat_type) :: a - type(amg_dprec_type) :: prec - type(amg_d_tlu_solver_type) :: tlusv -...... - ! - ! prepare the preconditioner: an ML with defaults, but with TLU solver at - ! intermediate levels. All other parameters are at default values. - ! - call prec%init(’ML’, info) - call prec%hierarchy_build(a,desc_a,info) - nlv = prec%get_nlevs() - call prec%set(tlusv, info,ilev=1,ilmax=max(1,nlv-1)) - call prec%smoothers_build(a,desc_a,info) -++
! sparse matrix and preconditioner +
type(psb_dspmat_type) :: a +
type(amg_dprec_type) :: prec +
type(amg_d_tlu_solver_type) :: tlusv +
+
...... +
! +
! prepare the preconditioner: an ML with defaults, but with TLU solver at +
! intermediate levels. All other parameters are at default values. +
! +
call prec%init(’ML’, info) +
call prec%hierarchy_build(a,desc_a,info) +
nlv = prec%get_nlevs() +
call prec%set(tlusv, info,ilev=1,ilmax=max(1,nlv-1)) +
call prec%smoothers_build(a,desc_a,info) +
+diff --git a/docs/html/userhtmlse7.html b/docs/html/userhtmlse7.html index 20a74c45..be3f3a40 100644 --- a/docs/html/userhtmlse7.html +++ b/docs/html/userhtmlse7.html @@ -3,8 +3,8 @@
Error Handling - - + + diff --git a/docs/html/userhtmlse8.html b/docs/html/userhtmlse8.html index 01bbaa41..bab484f0 100644 --- a/docs/html/userhtmlse8.html +++ b/docs/html/userhtmlse8.html @@ -3,8 +3,8 @@License - - + + @@ -36,37 +36,42 @@ class="cmr-12">AMG4PSBLAS is freely distributable under the following copyright -- AMG4PSBLAS version 1.0 - Algebraic MultiGrid Preconditioners Package - based on PSBLAS (Parallel Sparse BLAS version 3.7) - (C) Copyright 2021 - Pasqua D’Ambra IAC-CNR, IT - Fabio Durastante University of Pisa and IAC-CNR, IT - Salvatore Filippone University of Rome Tor-Vergata and IAC-CNR, IT - Redistribution and use in source and binary forms, with or without - modification, are permitted provided that the following conditions - are met: - 1. Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - 2. Redistributions in binary form must reproduce the above copyright - notice, this list of conditions, and the following disclaimer in the - documentation and/or other materials provided with the distribution. - 3. The name of the MLD2P4 group or the names of its contributors may - not be used to endorse or promote products derived from this - software without specific written permission. - THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - ‘‘AS IS’’ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED - TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR - PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE MLD2P4 GROUP OR ITS CONTRIBUTORS - BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - POSSIBILITY OF SUCH DAMAGE. -++
AMG4PSBLAS version 1.0 +
Algebraic MultiGrid Preconditioners Package +
based on PSBLAS (Parallel Sparse BLAS version 3.7) +
+
(C) Copyright 2021 +
+
Pasqua D’Ambra IAC-CNR, IT +
Fabio Durastante University of Pisa and IAC-CNR, IT +
Salvatore Filippone University of Rome Tor-Vergata and IAC-CNR, IT +
+
Redistribution and use in source and binary forms, with or without +
modification, are permitted provided that the following conditions +
are met: +
1. Redistributions of source code must retain the above copyright +
notice, this list of conditions and the following disclaimer. +
2. Redistributions in binary form must reproduce the above copyright +
notice, this list of conditions, and the following disclaimer in the +
documentation and/or other materials provided with the distribution. +
3. The name of the MLD2P4 group or the names of its contributors may +
not be used to endorse or promote products derived from this +
software without specific written permission. +
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +
‘‘AS IS’’ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE MLD2P4 GROUP OR ITS CONTRIBUTORS +
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +
POSSIBILITY OF SUCH DAMAGE. +
+@@ -78,37 +83,44 @@ class="cmr-12">abide by its terms: -
- MLD2P4 version 2.2 - MultiLevel Domain Decomposition Parallel Preconditioners Package - based on PSBLAS (Parallel Sparse BLAS version 3.5) - (C) Copyright 2008-2018 - Salvatore Filippone - Pasqua D’Ambra - Daniela di Serafino - Redistribution and use in source and binary forms, with or without - modification, are permitted provided that the following conditions - are met: - 1. Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - 2. Redistributions in binary form must reproduce the above copyright - notice, this list of conditions, and the following disclaimer in the - documentation and/or other materials provided with the distribution. - 3. The name of the MLD2P4 group or the names of its contributors may - not be used to endorse or promote products derived from this - software without specific written permission. - THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - ‘‘AS IS’’ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED - TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR - PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE MLD2P4 GROUP OR ITS CONTRIBUTORS - BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - POSSIBILITY OF SUCH DAMAGE. -++
+
MLD2P4 version 2.2 +
MultiLevel Domain Decomposition Parallel Preconditioners Package +
based on PSBLAS (Parallel Sparse BLAS version 3.5) +
+
(C) Copyright 2008-2018 +
+
Salvatore Filippone +
Pasqua D’Ambra +
Daniela di Serafino +
+
+
Redistribution and use in source and binary forms, with or without +
modification, are permitted provided that the following conditions +
are met: +
1. Redistributions of source code must retain the above copyright +
notice, this list of conditions and the following disclaimer. +
2. Redistributions in binary form must reproduce the above copyright +
notice, this list of conditions, and the following disclaimer in the +
documentation and/or other materials provided with the distribution. +
3. The name of the MLD2P4 group or the names of its contributors may +
not be used to endorse or promote products derived from this +
software without specific written permission. +
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +
‘‘AS IS’’ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE MLD2P4 GROUP OR ITS CONTRIBUTORS +
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +
POSSIBILITY OF SUCH DAMAGE. +
+diff --git a/docs/html/userhtmlse9.html b/docs/html/userhtmlse9.html index 5a1864d1..21676acb 100644 --- a/docs/html/userhtmlse9.html +++ b/docs/html/userhtmlse9.html @@ -3,8 +3,8 @@
Contributor Covenant Code of Conduct - - + + diff --git a/docs/html/userhtmlsu1.html b/docs/html/userhtmlsu1.html index d3d37856..8498220a 100644 --- a/docs/html/userhtmlsu1.html +++ b/docs/html/userhtmlsu1.html @@ -3,8 +3,8 @@Prerequisites - - + + diff --git a/docs/html/userhtmlsu10.html b/docs/html/userhtmlsu10.html index c8ffd9e1..0340d20e 100644 --- a/docs/html/userhtmlsu10.html +++ b/docs/html/userhtmlsu10.html @@ -3,14 +3,14 @@Method smoothers_build - - + + -
[nextMethod smoothers_build
---
+
call p,imold])
This method builds the smoothers and the coarsest-level solvers for the multilevel preconditioner 5.3). -
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 @@ -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.
@@ -262,7 +262,7 @@ class="td11"> The desired dynamic type for internal integer vector components; this allows e.g. running on GPUs.
-
diff --git a/docs/html/userhtmlsu11.html b/docs/html/userhtmlsu11.html index e00f2580..d4117714 100644 --- a/docs/html/userhtmlsu11.html +++ b/docs/html/userhtmlsu11.html @@ -3,14 +3,14 @@
Method build - - + + -
[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.
-
diff --git a/docs/html/userhtmlsu12.html b/docs/html/userhtmlsu12.html index 9bc621c1..7c8cb956 100644 --- a/docs/html/userhtmlsu12.html +++ b/docs/html/userhtmlsu12.html @@ -3,14 +3,14 @@
Method apply - - + + -
[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_parameter), dimension(:), intent(in)—.
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(out)—.
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
-
diff --git a/docs/html/userhtmlsu13.html b/docs/html/userhtmlsu13.html index b5d808cd..f80e1a19 100644 --- a/docs/html/userhtmlsu13.html +++ b/docs/html/userhtmlsu13.html @@ -3,14 +3,14 @@
Method free - - + + -
[next5.7 Method free
---
+
call p,info)
This method deallocates the preconditioner data structure p. -
Arguments
--
diff --git a/docs/html/userhtmlsu14.html b/docs/html/userhtmlsu14.html index 4e4894be..705fc60f 100644 --- a/docs/html/userhtmlsu14.html +++ b/docs/html/userhtmlsu14.html @@ -3,14 +3,14 @@
Method descr - - + + -
[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">
-
diff --git a/docs/html/userhtmlsu15.html b/docs/html/userhtmlsu15.html index 427962c7..ddbe5fb8 100644 --- a/docs/html/userhtmlsu15.html +++ b/docs/html/userhtmlsu15.html @@ -3,14 +3,14 @@
Auxiliary Methods - - + + -
class="cmr-12">5.9 Auxiliary Methods -[prev]
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
-Return memory footprint in bytes. --
+
sz =
global
logical, optional.
Whether the global or local preconditioner memory occupation is desired. Default: .
+
5.9.4 Method: allocate_wrk
---
+
call p vmold])
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
@@ -1455,7 +1462,7 @@ class="content">Parameters defining the solver at the coarsest level (continued)-+
@@ -1469,7 +1476,7 @@ id="TBL-8-4">
what
type
val
deault
cots
’BJAC_STOP’
character(len=*)
’FALSE’ -
’TRUE’
’FALSE’
Select whether to use a stopping criterion for +class="td11">
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 +class="td11">
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 -
Any integer +
> 0
-1
Number of iterations after which a trace is to +class="td11">
-1
Number of iterations after which a trace is to be printed.
’BJAC_RESCHECK’
integer
Any integer -
Any integer +
> 0
-1
Number of iterations after which a residual is +class="td11">
-1
Number of iterations after which a residual is to be calculated.
’BJAC_STOPTOL’
real(kind_parameter)
Any real -
Any real +
< 1
0
Tolerance for the stopping criterion on the +class="td11">
0
Tolerance for the stopping criterion on the residual.
’KRM_METHOD’
character(len=*)
’CG’ -
’FCG’ -
’CGS’ -
’CGR’ -
’BICG’ -
’BICGSTAB’ -
’BICGSTABL’ -
’RGMRES’
’FCG’
A string that defines the iterative method to +class="td11">
A string that defines the iterative method to be used when employing a Krylov method ’
’KRM_KPREC’
character(len=*)
’BJAC’
The one-level +class="td11">
The one-level preconditioners from the Table 1 can be used for the coarse Krylov solver.
’KRM_SUB_SOLVE’
character(len=*)
’ILU’
Solver for the diagonal blocks of the coarsest +class="td11">
Solver for the diagonal blocks of the coarsest matrix preconditioner, in case the block Jacobi solver is chosen as 5 applies here.
’KRM_GLOBAL’
character(len=*)
’TRUE’, @@ -1762,46 +1769,46 @@ class="cmtt-10x-x-109">’
, class="cmtt-10x-x-109">’FALSE’
’FALSE’
Choose between a global Krylov solver, all +class="td11">
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
Real < 1
10
10-6
+class="td11"> The stopping tolerance.
The stopping tolerance.
’KRM_IRST’
integer
Integer -
Integer +
≥ 1
30
An integer specifying the restart parameter. +class="td11">
30
An integer specifying the restart parameter. This is employed for the BiCGSTABL or RGMRES @@ -1809,16 +1816,16 @@ methods, otherwise it is ignored.
’KRM_ISTOPC’
integer
Integers +class="td11">
Integers 1,2,3
2
If
2
If 1 then the method uses the normwise backward error in the infinity norm; if 2, the @@ -1831,32 +1838,32 @@ for the details.
’KRM_ITMAX’
integer
Integer -
Integer +
≥ 1
40
The maximum number of iterations to +class="td11">
40
The maximum number of iterations to perform.
’KRM_ITRACE’
integer
Integer -
Integer +
≥ 0
-1
If
-1
If > 0 print out an informational message about convergence every
’KRM_FILLIN’
integer
Integer -
Integer +
≥ 0
0
Fill-in level
0
Fill-in level p of the ILU factorizations and first fill-in for the approximate inverses.
Additional parameters defining the solver at the coarsest level. -
@@ -1907,7 +1914,7 @@ class="content">Additional parameters defining the solver at the coarsest level.-+
what
type
val
deault
cots
’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 @@ -2023,21 +2030,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’ @@ -2045,47 +2052,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 class="cmr-10">one-level
preconditioners
The local solver to be used with the smoother or one-level preconditioner (see @@ -2163,22 +2170,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 @@ -2205,22 +2212,22 @@ class="cmr-10">respectively.
’SUB_OVR’
integer
Any integer -
number ≥ 0
1
1
@@ -2241,7 +2248,7 @@ preconditioner. - Number of overlap layers, for Additive Schwarz only.
@@ -2249,7 +2256,7 @@ preconditioner.-+
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 @@ -2339,28 +2346,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 @@ -2416,25 +2423,25 @@ class="cmr-10">factorizations.
’SUB_ILUTHRS’
real(kind_parameter)
Any real number ≥ 0
0
0
Drop tolerance t in the ILU(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 @@ -2477,19 +2484,19 @@ 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 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 -
-
diff --git a/docs/html/userhtmlsu9.html b/docs/html/userhtmlsu9.html index 03afcbcc..83e77773 100644 --- a/docs/html/userhtmlsu9.html +++ b/docs/html/userhtmlsu9.html @@ -3,14 +3,14 @@
Method hierarchy_build - - + + -
[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, ).
-
diff --git a/docs/src/userguide.pdf b/docs/src/userguide.pdf new file mode 120000 index 00000000..7b032aa3 --- /dev/null +++ b/docs/src/userguide.pdf @@ -0,0 +1 @@ +tmp/userguide.pdf \ No newline at end of file diff --git a/docs/src/userinterface.tex b/docs/src/userinterface.tex index 833d1959..683f8056 100644 --- a/docs/src/userinterface.tex +++ b/docs/src/userinterface.tex @@ -137,7 +137,7 @@ logically divided into four groups, i.e., parameters defining \begin{enumerate} \item the type of multilevel cycle and how many cycles must be applied; \item the coarsening algorithm; - \item the coarse-space correction at the coarsest level (for multilevel + \item the solver at the coarsest level (for multilevel preconditioners only); \item the smoother of the multilevel preconditioners, or the one-level preconditioner. @@ -155,8 +155,9 @@ the hybrid Gauss-Seidel smoother (see Note in Table~\ref{tab:p_smoother}) is obtained by combining the block-Jacobi smoother object with a single sweep of the Gauss-Seidel solver object, while the point-Jacobi smoother is the result of combining the block-Jacobi smoother object with a single sweep -of the point-Jacobi solver object. However, for simplicity, shortcuts are -provided to set point-Jacobi, hybrid (forward) Gauss-Seidel, and +of the point-Jacobi solver object. In the same way are obtained the $\ell_1$-versions of +the smoothers. However, for simplicity, shortcuts are +provided to set all versions of point-Jacobi, hybrid (forward) Gauss-Seidel, and hybrid backward Gauss-Seidel, i.e., the previous smoothers can be defined just by setting \fortinline|'SMOOTHER_TYPE'| to certain specific values (see Tables~\ref{tab:p_smoother}), without the need to set @@ -176,12 +177,12 @@ coarsest-level solvers, and shortcuts are available in this case too (see Table~\ref{tab:p_coarse_1}). \\ \textbf{Remark 3.} Many of the coarsest-level solvers cannot be used -with both replicated and distributed coarsest-matrix layouts; +with both replicated and distributed coarsest-matrix layouts; therefore, setting the solver after the layout may change the layout. Similarly, setting the layout after the solver may change the solver. More precisely, UMFPACK and SuperLU require the coarsest-level -matrix to be replicated, while SuperLU\_Dist requires it to be distributed. +matrix to be replicated, while SuperLU\_Dist and KRM requires it to be distributed. In these cases, setting the coarsest-level solver implies that the layout is redefined according to the solver, ovverriding any previous settings. MUMPS, point-Jacobi, @@ -189,7 +190,7 @@ hybrid Gauss-Seidel and block-Jacobi can be applied to replicated and distributed matrices, thus their choice does not modify any previously specified layout. It is worth noting that, when the matrix is replicated, -the point-Jacobi, hybrid Gauss-Seidel and block-Jacobi solvers +the point-Jacobi, hybrid Gauss-Seidel and block-Jacobi solvers and their $\ell_1-$ versions reduce to the corresponding local solver objects (see Remark~2). For the point-Jacobi and Gauss-Seidel solvers, these objects correspond to a \emph{single} point-Jacobi sweep and a \emph{single}