You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
amg4psblas/docs/src/userguide.tex

212 lines
6.1 KiB
TeX

\documentclass[a4paper,twoside,11pt]{article}
\usepackage{pstricks}
\usepackage{fancybox}
\usepackage{amsfonts}
\usepackage{ifpdf}
% \usepackage{minitoc}
% \setcounter{minitocdepth}{2}
\usepackage[bookmarks=true,
bookmarksnumbered=true,
bookmarksopen=false,
plainpages=false,
pdfpagelabels,
colorlinks,
citecolor=red,
linkcolor=blue,
pdfauthor={Pasqua D'Ambra, Fabio Durastante, Salvatore Filippone},
pdftitle={Algebraic MultiGrid Preconditioners Package based on PSBLAS, V. 1.0},
pdfsubject={MultiGrid Parallel Preconditioners Package},
pdfkeywords={Parallel Numerical Software, Algebraic MultiGrid Preconditioners, Sparse Iterative Solvers, PSBLAS, MPI},
]{hyperref}
\usepackage{html}
\usepackage{ifthen}
\usepackage{graphicx}
\usepackage{subfig}
\newtheorem{theorem}{Theorem}
\newtheorem{corollary}{Corollary}
\usepackage{rotating}
\usepackage{microtype}
\usepackage{minted}
\usemintedstyle{friendly}
\definecolor{bg}{rgb}{0.95,0.95,0.95}
\usepackage{breakurl}
\usepackage{mathpazo}
\usepackage[english]{babel}
\ifpdf
\newmintinline[fortinline]{fortran}{}
\else%
\def\fortinline{\lstinline[basicstyle=\ttfamily,language=fortran]}
\fi
%\newboolean{mtc}
%\setboolean{mtc}{true}
\pdfoutput=1
\relax
\pdfcompresslevel=0 %-- 0 = none, 9 = best
\pdfinfo{ %-- Info dictionary of PDF output /Author (PD, DdS, SF)
/Title (Algebraic MultiGrid Preconditioners Package
based on PSBLAS, V. 1.0)
/Subject (MultiGrid Parallel Preconditioners Package)
/Keywords (Parallel Numerical Software, Algebraic MultiGrid Preconditioners, Sparse Iterative Solvers, PSBLAS, MPI)
/Creator (pdfLaTeX)
/Producer ($Id: userguide.tex 2021-04-12 Pasqua D'Ambra, Fabio Durastante,
Salvatore Filippone$)
}
\pdfcatalog{ %-- Catalog dictionary of PDF output.
% /URI (http://ce.uniroma2.it/psblas)
}
\setlength\textwidth{1.15\textwidth}
\setlength\oddsidemargin{0.3in}
\setlength\evensidemargin{0.2in}
% \newlength{\centeroffset}
% \setlength{\centeroffset}{0.5\oddsidemargin}
% \addtolength{\centeroffset}{0.5\evensidemargin}
% \addtolength{\textwidth}{-\centeroffset}
\pagestyle{myheadings}
\newcounter{subroutine}[subsection]
\newcounter{example}[subroutine]
\makeatletter
\def\subroutine{\@ifstar{\@subroutine}{\clearpage\@subroutine}}%
\def\@subroutine#1#2{%
\stepcounter{subroutine}%
\section*{\flushleft #1---#2 \endflushleft}%
\addcontentsline{toc}{subsection}{#1}%
\markright{#1}}%
\newcommand{\subsubroutine}[2]{%
\stepcounter{subroutine}%
\subsection*{\flushleft #1---#2 \endflushleft}%
\addcontentsline{toc}{subsubsection}{#1}%
\markright{#1}}%
\newcommand{\examplename}{Example}
\newcommand{\syntaxname}{Syntax}
\def\syntax{\@ifstar{\@ssyntax}{\@syntax}}%
\def\@syntax{\nobreak\section*{\syntaxname}%
\@ssyntax}%
\def\@ssyntax#1#2{%
\nobreak
\setbox\@tempboxa\hbox{#1\ {\em $($#2$)$}}%
\ifdim \wd\@tempboxa >\hsize
\setbox\@tempboxa\hbox{\em $($#2$)$}
\ifdim\wd\@tempboxa >\hsize
\begin{flushright}#1\ \em$($#2$)$\end{flushright}%
\else
\hbox to\hsize{#1\hfil}%
\hbox to\hsize{\hfil\box\@tempboxa}%
\fi
\else
\hbox to\hsize{\hfil\box\@tempboxa\hfil}%
\fi\par\vskip\baselineskip}
\makeatother
\newcommand{\example}{\stepcounter{example}%
\section*{\examplename~\theexample}}
\def\bsideways{\begin{sidewaystable}}
\def\esideways{\end{sidewaystable}}
\newcommand{\precdata}{\hyperlink{precdata}{{\tt mld\_prec\_type}}}
\newcommand{\descdata}{\hyperlink{descdata}{{\tt psb\_desc\_type}}}
\newcommand{\spdata}{\hyperlink{spdata}{{\tt psb\_spmat\_type}}}
%\newcommand{\Ref}[1]{\mbox{(\ref{#1})}}
\begin{document}
{
\pdfbookmark{AMG4PSBLAS User's and Reference Guide}{title}
\newlength{\centeroffset}
%\setlength{\centeroffset}{-0.5\oddsidemargin}
%\addtolength{\centeroffset}{0.5\evensidemargin}
%\addtolength{\textwidth}{-\centeroffset}
\thispagestyle{empty}
\vspace*{\stretch{1}}
\noindent\hspace*{\centeroffset}\makebox[0pt][l]{\begin{minipage}{\textwidth}
\flushright
{\Huge\bfseries AMG4PSBLAS\\[.8ex] User's and Reference Guide
}
\noindent\rule[-1ex]{\textwidth}{5pt}\\[2.5ex]
\hfill\emph{\Large A guide for the Algebraic MultiGrid \\[.6ex]
Preconditioners Package based on PSBLAS}
\end{minipage}}
\vspace{\stretch{1}}
\flushleft
\begin{figure*}[htb]
\begin{center}
\includegraphics[width=0.6\textwidth]{amg4psblaslibrary.png}
\end{center}
\end{figure*}
\vspace{\stretch{1}}
\noindent\hspace*{\centeroffset}\makebox[0pt][l]{\begin{minipage}{\textwidth}
\flushright
{\large\bfseries Pasqua D'Ambra}\\
\large IAC-CNR, Italy\\[3ex]
{\large\bfseries Fabio Durastante}\\
\large University of Pisa and IAC-CNR\\[3ex]
{\large\bfseries Salvatore Filippone} \\
\large University of Rome Tor-Vergata and IAC-CNR
%\\[10ex]
%\today
\end{minipage}}
\vspace{\stretch{1}}
\noindent\hspace*{\centeroffset}\makebox[0pt][l]{\begin{minipage}{\textwidth}
\flushright
\large Software version: 1.0\\
%\todaym
\large May 11th, 2021
\end{minipage}}
%\addtolength{\textwidth}{\centeroffset}
\vspace{\stretch{2}}
\clearpage
\thispagestyle{empty}
\vspace*{1cm}
\centerline{\emph{\large This page intentionally left blank}}
\clearpage
}
\pagenumbering{roman} % Roman numbering
\setcounter{page}{1} % Abstract starts on page i
\include{abstract}
{
%\cleardoublepage
\clearpage
\thispagestyle{empty}
\vspace*{1cm}
\centerline{\emph{\large This page intentionally left blank}}
\clearpage
\begingroup
\renewcommand*{\thepage}{toc}
\tableofcontents
\endgroup
%\cleardoublepage
\clearpage
\thispagestyle{empty}
\vspace*{1cm}
\centerline{\emph{\large This page intentionally left blank}}
\clearpage
}
\pagenumbering{arabic} % Arabic numbering
\setcounter{page}{1} % Chapters start on page 1
\include{overview}
\include{distribution}
\include{building}
\include{gettingstarted}
\include{userinterface}
\include{newobjects}
\include{errors}
\clearpage
\appendix
\include{license}
\include{covenant}
\clearpage
\include{bibliography}
\end{document}
%%% Local Variables:
%%% mode: latex
%%% TeX-master: 'userguide'
%%% End: