From a2b52fd60695e5f698313d300190b7f8a23760b1 Mon Sep 17 00:00:00 2001 From: Salvatore Filippone Date: Tue, 22 Jul 2008 16:32:02 +0000 Subject: [PATCH] mld2p4/docs/pdf: building.tex userguide.tex userhtml.tex userinterface.tex Changes for html docs. --- docs/pdf/building.tex | 2 +- docs/pdf/userguide.tex | 1 + docs/pdf/userhtml.tex | 135 +++++++++++++++++++++++++++++++++++++ docs/pdf/userinterface.tex | 23 ++++--- 4 files changed, 150 insertions(+), 11 deletions(-) create mode 100644 docs/pdf/userhtml.tex diff --git a/docs/pdf/building.tex b/docs/pdf/building.tex index 71091b4a..eda217f0 100644 --- a/docs/pdf/building.tex +++ b/docs/pdf/building.tex @@ -42,7 +42,7 @@ The following base libraries are needed: The MLD2P4 software requires PSBLAS version 2.3 (at least), available from \verb|http://www.ce.uniroma2.it/psblas|; indeed, all the -prerequisites listed so fare are also prerequisites of PSBLAS. Please +prerequisites listed so far are also prerequisites of PSBLAS. Please note that to build the MLD2P4 library it is necessary to get access to the source PSBLAS directory used to build the version under use; after the build process completes, only the compiled form of the library is diff --git a/docs/pdf/userguide.tex b/docs/pdf/userguide.tex index ae5d1e03..3f16e574 100644 --- a/docs/pdf/userguide.tex +++ b/docs/pdf/userguide.tex @@ -2,6 +2,7 @@ \usepackage{pstricks} \usepackage{fancybox} \usepackage{amsfonts} +\usepackage{ifpdf} % \usepackage{minitoc} % \setcounter{minitocdepth}{2} \usepackage[bookmarks=true, diff --git a/docs/pdf/userhtml.tex b/docs/pdf/userhtml.tex new file mode 100644 index 00000000..c50d985f --- /dev/null +++ b/docs/pdf/userhtml.tex @@ -0,0 +1,135 @@ +\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, + linkcolor=blue]{hyperref} +\usepackage{ifthen} +\usepackage{graphicx} +\newtheorem{theorem}{Theorem} +\newtheorem{corollary}{Corollary} +\usepackage{rotating} +%\newboolean{mtc} +%\setboolean{mtc}{true} + +\pdfoutput=0 +% \relax +% \pdfcompresslevel=0 %-- 0 = none, 9 = best +% \pdfinfo{ %-- Info dictionary of PDF output /Author (PD, DdS, SF) +% /Title (MultiLevel Domain Decomposition Parallel Preconditioners Package +% based on PSBLAS, V. 1.0) +% /Subject (MultiLevel Domain Decomposition Parallel Preconditioners Package) +% /Keywords (Parallel Numerical Software, Algebraic Multilevel Preconditioners, Sparse Iterative Solvers, PSBLAS, MPI) +% /Creator (pdfLaTeX) +% /Producer ($Id: userguide.tex 2008-04-08 Pasqua D'Ambra, Daniela di Serafino, +% Salvatore Filippone$) +% } +% \pdfcatalog{ %-- Catalog dictionary of PDF output. +% % /URI (http://ce.uniroma2.it/psblas) +% } + +\setlength\textwidth{1.15\textwidth} +% \setlength\evensidemargin{.7in} +% \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}} + +\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} +\include{title} +%\cleardoublepage +\clearpage +\ \\ +\thispagestyle{empty} +\clearpage + +\pagenumbering{roman} % Roman numbering +\setcounter{page}{1} % Abstract start on page i + +\include{abstract} +\cleardoublepage + +\begingroup + \renewcommand*{\thepage}{toc} + %\pagenumbering{roman} % Roman numbering + %\setcounter{page}{1} % Abstract start on page ii + \tableofcontents +\endgroup +\cleardoublepage + +\pagenumbering{arabic} % Arabic numbering +\setcounter{page}{1} % Chapters start on page 1 + +\include{overview} +\include{conventions} +\include{distribution} +\include{building} +\include{background} +\include{gettingstarted} +\include{userinterface} +%\include{advanced} +\include{errors} +%\include{listofroutines} +\cleardoublepage +\appendix +\include{license} +\cleardoublepage +\include{bibliography} + + +\end{document} +%%% Local Variables: +%%% mode: latex +%%% TeX-master: 'userguide' +%%% End: diff --git a/docs/pdf/userinterface.tex b/docs/pdf/userinterface.tex index 19bb820c..c658455d 100644 --- a/docs/pdf/userinterface.tex +++ b/docs/pdf/userinterface.tex @@ -1,6 +1,9 @@ \section{User Interface\label{sec:userinterface}} \markboth{\textsc{MLD2P4 User's and Reference Guide}} {\textsc{\ref{sec:userinterface} User Interface}} +\def\bsideways{\sidewaystable} +\def\esideways{\endsidewaystable} + The basic user interface of MLD2P4 consists of six routines. The four routines \verb|mld_precinit|, \verb|mld_precset|, \verb|mld_precbld| and \verb|mld_precaply| encapsulate all the functionalities @@ -133,8 +136,7 @@ refer to Section~\ref{sec:background}. %multi-level preconditioners. Non-expert users are recommended %to call \verb| mld_precset| without specifying \verb|ilev|. - -\begin{sidewaystable} +\ifcase\pdfoutput\else\bsideways\fi \begin{center} \begin{tabular}{|l|l|p{2cm}|l|p{7cm}|} \hline @@ -161,9 +163,9 @@ refer to Section~\ref{sec:background}. \end{center} \caption{Parameters defining the type of multi-level preconditioner. \label{tab:p_type}} -\end{sidewaystable} +\ifcase\pdfoutput\else\esideways\fi -\begin{sidewaystable} +\ifcase\pdfoutput\else\bsideways\fi \begin{center} \begin{tabular}{|l|l|p{3.2cm}|l|p{7cm}|} \hline @@ -211,9 +213,9 @@ refer to Section~\ref{sec:background}. \end{center} \caption{Parameters defining the one-level preconditioner used as smoother. \label{tab:p_smoother}} -\end{sidewaystable} +\ifcase\pdfoutput\else\esideways\fi -\begin{sidewaystable} +\ifcase\pdfoutput\else\bsideways\fi \begin{center} \begin{tabular}{|l|l|p{2.3cm}|p{2.6cm}|p{7cm}|} \hline @@ -247,9 +249,9 @@ refer to Section~\ref{sec:background}. \end{center} \caption{Parameters defining the aggregation algorithm. \label{tab:p_aggregation}} -\end{sidewaystable} +\ifcase\pdfoutput\else\esideways\fi -\begin{sidewaystable} +\ifcase\pdfoutput\else\bsideways\fi \begin{center} \begin{tabular}{|l|l|p{3.2cm}|l|p{7cm}|} \hline @@ -293,7 +295,7 @@ refer to Section~\ref{sec:background}. \end{center} \caption{Parameters defining the coarse-space correction at the coarsest level.\label{tab:p_coarse}} -\end{sidewaystable} +\ifcase\pdfoutput\else\esideways\fi \clearpage @@ -313,7 +315,8 @@ the user through the routines \verb|mld_precinit| and \verb|mld_precset|. \verb|a| & \verb|type(psb_|\emph{x}\verb|spmat_type), intent(in)|. \\ & The sparse matrix structure containing the local part of the matrix to be preconditioned. Note that \emph{x} must be chosen according - to the real/complex, single/double precision version of MLD2P4 under use. + to the real/complex, +single/double precision version of MLD2P4 under use. See the PSBLAS User's Guide for details \cite{PSBLASGUIDE}.\\ \verb|desc_a| & \verb|type(psb_desc_type), intent(in)|. \\ & The communication descriptor of \verb|a|. See the PSBLAS User's Guide for