|
Packit Service |
c5cf8c |
%
|
|
Packit Service |
c5cf8c |
% This is a latex file that generates a reference manual for the
|
|
Packit Service |
c5cf8c |
% Model MPI implementation
|
|
Packit Service |
c5cf8c |
%
|
|
Packit Service |
c5cf8c |
\documentclass{article}
|
|
Packit Service |
c5cf8c |
% The plainpages=false and pdfpagelabels allow the PDF reader to understand the
|
|
Packit Service |
c5cf8c |
% page numbers that are printed on the pages (thus, "going to page 47" will
|
|
Packit Service |
c5cf8c |
% take you to the page numbered 47, rather than the 47th page from the
|
|
Packit Service |
c5cf8c |
% start of the document).
|
|
Packit Service |
c5cf8c |
\usepackage[dvipdfm,plainpages=false,pdfpagelabels]{hyperref}
|
|
Packit Service |
c5cf8c |
\usepackage{refman}
|
|
Packit Service |
c5cf8c |
\usepackage{tpage}
|
|
Packit Service |
c5cf8c |
\textheight=9in
|
|
Packit Service |
c5cf8c |
\textwidth=6.1in
|
|
Packit Service |
c5cf8c |
\oddsidemargin=.2in
|
|
Packit Service |
c5cf8c |
\topmargin=-.50in
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
% Include each routine in the contents page
|
|
Packit Service |
c5cf8c |
\mancontentstrue
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
\begin{document}
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
\markright{MPICH Reference Manual}
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
\def\nopound{\catcode`\#=13}
|
|
Packit Service |
c5cf8c |
{\nopound\gdef#{{\tt \char`\#}}}
|
|
Packit Service |
c5cf8c |
%\catcode`\_=13
|
|
Packit Service |
c5cf8c |
%\def_{{\tt \char`\_}}
|
|
Packit Service |
c5cf8c |
\catcode`\_=11
|
|
Packit Service |
c5cf8c |
\def\code#1{{\tt #1}}
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
\ANLTitle{MPICH Model MPI Implementation\\Reference Manual\\\ \\Draft}{\em
|
|
Packit Service |
c5cf8c |
William Gropp\\
|
|
Packit Service |
c5cf8c |
Ewing Lusk
|
|
Packit Service |
c5cf8c |
Mathematics and Computer Science Division\\
|
|
Packit Service |
c5cf8c |
Argonne National Laboratory}{00}{\today}
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
\clearpage
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
\pagenumbering{roman}
|
|
Packit Service |
c5cf8c |
\tableofcontents
|
|
Packit Service |
c5cf8c |
\clearpage
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
\pagenumbering{arabic}
|
|
Packit Service |
c5cf8c |
\pagestyle{headings}
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
\section{Introduction}
|
|
Packit Service |
c5cf8c |
This document contains detailed documentation on the routines that are part of
|
|
Packit Service |
c5cf8c |
the MPICH model MPI implementation.
|
|
Packit Service |
c5cf8c |
As an alternative to this manual, the reader should consider using either the
|
|
Packit Service |
c5cf8c |
man pages (often installed in \file{/usr/local/mpi/man}) or the web pages
|
|
Packit Service |
c5cf8c |
(often installed in \file{/usr/local/mpi/www}).
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
%As an alternate to this manual, the reader should consider using the
|
|
Packit Service |
c5cf8c |
%script \code{mpiman}; this is a script that uses \code{xman} to provide
|
|
Packit Service |
c5cf8c |
%a X11 Window System interface to the data in this manual.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
\section{MPI Commands}
|
|
Packit Service |
c5cf8c |
\input refcmd.tex
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
\section{MPI routines}
|
|
Packit Service |
c5cf8c |
This section contains descriptions of each of the routines in the MPI
|
|
Packit Service |
c5cf8c |
standard.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
In the description of the routine parameters, the following terms are
|
|
Packit Service |
c5cf8c |
used:
|
|
Packit Service |
c5cf8c |
\begin{description}
|
|
Packit Service |
c5cf8c |
\item[handle]An MPI object handle. This is simply an object of the
|
|
Packit Service |
c5cf8c |
specified type.
|
|
Packit Service |
c5cf8c |
\item[choice]Any type. For example, this may be an 'int', 'double',
|
|
Packit Service |
c5cf8c |
or structure type. These are always passed with a pointer and in
|
|
Packit Service |
c5cf8c |
the C and C++ bindings, a \code{void*} pointer is used.
|
|
Packit Service |
c5cf8c |
\end{description}
|
|
Packit Service |
c5cf8c |
Other terms, such as ``nonnegative integer,'' are self explanatory.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
\input refmpi.tex
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
%\section{ADI routines}
|
|
Packit Service |
c5cf8c |
%\input ref5/ref.tex
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
\end{document}
|