Update docs. Bump 3.8 version.

This commit is contained in:
Salvatore Filippone
2022-04-15 11:58:31 +02:00
parent 42190f17b7
commit 827934adae
35 changed files with 261 additions and 174 deletions
+1 -1
View File
@@ -139,7 +139,7 @@ PDF = $(join $(BASEFILE),.pdf)
PS = $(join $(BASEFILE),.ps)
GXS = $(join $(BASEFILE),.gxs)
GLX = $(join $(BASEFILE),.glx)
TARGETPDF= ../psblas-3.7.pdf
TARGETPDF= ../psblas-3.8.pdf
BASEHTML = $(patsubst %.tex,%,$(HTMLFILE))
HTML = $(join $(BASEHTML),.html)
HTMLDIR = ../html
+32 -9
View File
@@ -601,7 +601,7 @@ An integer value; 0 means no error has been detected.
the assembled matrix may substantially improve performance in the
matrix build phase, as it will reduce or eliminate the need for
(potentially multiple) data reallocations;
\item Using \verb|psb_matbld_remote_| will cause an overhead at
\item Using \verb|psb_matbld_remote_| is likely to cause a runtime overhead at
assembly time;
\end{enumerate}
@@ -712,8 +712,7 @@ An integer value; 0 means no error has been detected.
\item The input data can be passed in either COO or CSR formats;
\item In COO format the coefficients to be inserted are represented by
the ordered triples $ia(i),ja(i),val(i)$, for $i=1,\dots,nz$;
these triples should belong to the current process, i.e. $ia(i)$
should be one of the local indices, but are otherwise arbitrary;
these triples are arbitrary;
\item In CSR format the coefficients to be inserted for each input row $i=1,nr$
are represented by the ordered triples $(i+irw-1),ja(j),val(j)$, for
$j=irp(i),\dots,irp(i+1)-1$;
@@ -724,8 +723,11 @@ An integer value; 0 means no error has been detected.
may be split into as many calls as desired (even in the CSR format);
\item Coefficients from different rows may also be mixed up freely
in a single call, according to the application needs;
\item Any coefficients from matrix rows not owned by the calling
process are silently ignored;
\item Coefficients from matrix rows not owned by the calling
process are treated according to the value of \verb|buildmode|
specified at allocation time; if
\verb|buildmode| was chosen as \verb|psb_matbld_remote_| the library
will keep track of them, otherwise they are silently ignored;
\item If the descriptor is in the assembled state, then any entries in
the sparse matrix that would generate additional communication
requirements are ignored;
@@ -739,7 +741,7 @@ An integer value; 0 means no error has been detected.
\clearpage\subsection{psb\_spasb --- Sparse matrix assembly routine}
\begin{verbatim}
call psb_spasb(a, desc_a, info, afmt, upd, mold)
call psb_spasb(a, desc_a, info [, afmt, upd, mold])
\end{verbatim}
\begin{description}
@@ -808,8 +810,9 @@ An integer value; 0 means no error has been detected.
at allocation time, contributions defined on the current process but
belonging to a remote process will be handled accordingly. This is
most likely to occur in finite element applications, with
\verb|dupl=psb_dupl_add_|; note that the descriptor will be updated,
and there will be a runtime overhead.
\verb|dupl=psb_dupl_add_|; it is necessary to check for possible
updates needed in the descriptor, hence there will be a runtime
overhead.
\end{enumerate}
@@ -1007,7 +1010,7 @@ Scope: {\bf global}.\\
Type: {\bf optional}.\\
Intent: {\bf in}.\\
Specified as: integer, possible values: \verb|psb_dupl_ovwrt_|,
\verb|psb_dupl_add_|, \verb|psb_dupl_err_|.
\verb|psb_dupl_add_|; \verb|psb_dupl_err_| has no effect.
\item[buildmode] Whether to keep track of matrix entries that do not
belong to the current process.\\
Scope: {\bf global}.\\
@@ -1032,6 +1035,11 @@ Intent: {\bf out}.\\
An integer value; 0 means no error has been detected.
\end{description}
{\par\noindent\large\bfseries Notes}
\begin{enumerate}
\item Using \verb|psb_matbld_remote_| is likely to cause a runtime overhead at
assembly time;
\end{enumerate}
%
%% psb_ins %%
@@ -1140,7 +1148,22 @@ Type: {\bf required} \\
Intent: {\bf out}.\\
An integer value; 0 means no error has been detected.
\end{description}
{\par\noindent\large\bfseries Notes}
\begin{enumerate}
\item On entry to this routine the descriptor must be in the
assembled state, i.e. \verb|psb_cdasb| must already have been called.
\item If the \verb|buildmode=psb_matbld_remote_| value was specified
at allocation time, contributions defined on the current process but
belonging to a remote process will be handled accordingly. This is
most likely to occur in finite element applications, with
\verb|dupl=psb_dupl_add_|.
\end{enumerate}
%
%% psb_free %%
%
\clearpage\subsection{psb\_gefree --- Frees a dense matrix}
+4 -4
View File
@@ -36,7 +36,7 @@
\relax
\pdfcompresslevel=0 %-- 0 = none, 9 = best
\pdfinfo{ %-- Info dictionary of PDF output /Author (Alfredo Buttari)
/Title (Parallel Sparse BLAS V. 3.7.0)
/Title (Parallel Sparse BLAS V. 3.8.0)
/Subject (Parallel Sparse Basic Linear Algebra Subroutines)
/Keywords (Computer Science Linear Algebra Fluid Dynamics Parallel Linux MPI PSBLAS Iterative Solvers Preconditioners)
/Creator (pdfLaTeX)
@@ -99,7 +99,7 @@
\begin{document}
{
\pdfbookmark{PSBLAS-v3.7.0 User's Guide}{title}
\pdfbookmark{PSBLAS-v3.8.0 User's Guide}{title}
\lstset{language=Fortran}
\newlength{\centeroffset}
\setlength{\centeroffset}{-0.5\oddsidemargin}
@@ -109,7 +109,7 @@
\vspace*{\stretch{1}}
\noindent\hspace*{\centeroffset}\makebox[0pt][l]{\begin{minipage}{\textwidth}
\flushright
{\Huge\bfseries PSBLAS 3.7.0.2 User's guide
{\Huge\bfseries PSBLAS 3.8.0 User's guide
}
\noindent\rule[-1ex]{\textwidth}{5pt}\\[2.5ex]
\hfill\emph{\Large A reference guide for the Parallel Sparse BLAS library}
@@ -130,7 +130,7 @@
{\bfseries
by Salvatore Filippone\\
and Alfredo Buttari}\\
Feb 14th, 2022
May 1st, 2022
\end{minipage}}
}
%\addtolength{\textwidth}{\centeroffset}
+2 -2
View File
@@ -94,9 +94,9 @@
Alfredo Buttari } \\
%\\[10ex]
%\today
Software version: 3.7.0.1\\
Software version: 3.8.0\\
%\today
Feb 14th, 2022
May 1st, 2022
\cleardoublepage
\begingroup
\renewcommand*{\thepage}{toc}