diff --git a/docs/amg4psblas_1.2-guide.pdf b/docs/amg4psblas_1.2-guide.pdf index faec7bbe..baf8b921 100644 Binary files a/docs/amg4psblas_1.2-guide.pdf and b/docs/amg4psblas_1.2-guide.pdf differ diff --git a/docs/html/userhtmlse3.html b/docs/html/userhtmlse3.html index 3b2067b3..ef524716 100644 --- a/docs/html/userhtmlse3.html +++ b/docs/html/userhtmlse3.html @@ -61,7 +61,7 @@ class="cmr-12">supported by the GNU Fortran compiler, for which we recommend to class="cmr-12">version 12. The software defines data types and interfaces for real and complex data, in both single and double precision. -

Building AMG4PSBLAS requires some base libraries (see Section “developer” part; in order to build AMG4PSBLAS you ne class="cmr-12">the base and optional software used by AMG4PSBLAS is given in the next sections. -

+

3.1 Prerequisites

-

The following base libraries are needed:

-

+

BLAS

-

[18for including -fPIC compilation option in the make.inc file of th library.

-

+

MPI

-

[25A version of MPI is available on most high-performance computing< systems.

-

+

PSBLAS

-

[21; version class="cmr-12">3.9.0 (or later) is required. Indeed, all the prerequisites listed so far are also prerequisites of PSBLAS.

-

Please note that the four previous libraries must have Fortran interfaces compatible with AMG4PSBLAS; usually this means that they should all be built with the same compiler being used for AMG4PSBLAS. -

If you want to use the PSBLAS support for NVIDIA GPUs, you will also need a working version of the CUDA Toolkit that is compatible with the @@ -214,7 +214,7 @@ class="cmr-12">options:

 ./configure --enable-cuda --with-cudadir=${CUDA_HOME} --with-cudacc=xx,yy,zz
 
-

Previous versions required you to have the auxiliary libraries SPGPU and PSBLAS-EXT compiled, this is no longer necessary because they have been integrated @@ -226,24 +226,24 @@ class="cmr-12"> 4.2. -

+

3.2 Optional third party libraries

-

We provide interfaces to the following third-party software libraries; note that these are optional, but if you enable them some defaults for multilevel preconditioners may change to reflect their presence. -

+

-

+

UMFPACK

-

[16provide the right path to the BLAS and LAPACK libraries class="cmtt-12">SuiteSparse_config/SuiteSparse_config.mk file.

-

+

MUMPS

-

[2solution for single and double precision, real and complex data. versions 4.10.0 and 5.0.1.

-

+

SuperLU

-

[17data. We tested versions 4.3 and 5.0. If you installed BLAS from remember to define the BLASLIB variable in the make.inc file.

-

+

SuperLU_Dist

-

[28parallel graph partitioning and fill-reducing matrix ordering, av href="glaros.dtc.umn.edu/gkhome/metis/parmetis/overview" class="url" >glaros.dtc.umn.edu/gkhome/metis/parmetis/overview.

-

+

3.3 Configuration options

-

In order to build AMG4PSBLAS, the first step is to use the configure script in the main directory to generate the necessary makefile. -

As a minimal example consider the following: @@ -360,7 +360,7 @@ class="cmr-12">As a minimal example consider the following:

 ./configure --with-psblas=PSB-INSTALL-DIR
 
-

which assumes that the various MPI compilers and support libraries are available in the standard directories on the system, and specifies only the PSBLAS install directory @@ -374,7 +374,7 @@ class="cmtt-12">./configure --help, which produces:

produces:  
configure/issues>.
    
-

For instance, if a user has built and installed PSBLAS 3.9 under the /opt directory and is @@ -3925,7 +3925,7 @@ class="cmr-12">might be configured with: ./configure --with-psblas=/opt/psblas-3.9/ \ --with-umfpackincdir=/usr/include/suitesparse/

-

Once the configure script has completed execution, it will have generated the file Make.inc which will then be used by all Makefiles in the directory tree; t class="cmr-12">copied in the install directory under the name Make.inc.AMG4PSBLAS. -

To use the MUMPS solver package, the user has to add the appropriate options to the configure script; by default we are looking for the libraries --with-extra-libs configure option. -

To build the library the user will now enter @@ -3962,7 +3962,7 @@ class="cmr-12">To build the library the user will now enter

 make
 
-

followed (optionally) by @@ -3970,12 +3970,12 @@ class="cmr-12">followed (optionally) by

 make install
 
-

+

3.4 Bug reporting

-

If you find any bugs in our codes, please report them through our issues page on
https://github.com/psctoolkit/psctoolkit/issues
-

To enable us to track the bug, please provide a log from the failing application, the test conditions, and ideally a self-contained test program reproducing the issue. -

+

3.5 Example and test programs

-

The package contains a samples directory, divided in two subdirs subdirectories. Their purpose is as follows:

-

+

simple

-

contains a set of simple example programs with a predefined choice of preconditioners, selectable via integer values. These are intended to get acquainted with the multilevel preconditioners available in AMG4PSBLAS.

-

+

advanced

-

contains a set of more sophisticated examples that will allow the user, via the input files in the runs subdirectories, to experiment with the full range of preconditioners implemented in the package.

-

The fileread directories contain sample programs that read sparse matrices from files, diff --git a/docs/src/building.tex b/docs/src/building.tex index f3a15583..e203f1a2 100644 --- a/docs/src/building.tex +++ b/docs/src/building.tex @@ -12,8 +12,7 @@ interfaces to external libraries in C; the Fortran compiler must support the Fortran~2003 standard plus the extension \verb|MOLD=| feature, which enhances the usability of \verb|ALLOCATE|. Most Fortran compilers provide this feature; in particular, this is -supported by the GNU Fortran compiler, for which we -recommend to use at least version 12. +supported by the GNU Fortran compiler, for which we recommend to use at least version 12. The software defines data types and interfaces for real and complex data, in both single and double precision.