Added pplmanual.sty.
authorMilind Bhandarkar <milind@cs.uiuc.edu>
Fri, 8 Dec 2000 19:15:32 +0000 (19:15 +0000)
committerMilind Bhandarkar <milind@cs.uiuc.edu>
Fri, 8 Dec 2000 19:15:32 +0000 (19:15 +0000)
doc/fem/manual.tex
doc/pplmanual.sty [new file with mode: 0644]

index 1b68cacd11d8644ac0634413a81c48157c3ffc26..cb7327139c8df723504682f25beaad83c2bae231 100644 (file)
@@ -1,92 +1,26 @@
-\documentclass[11pt]{article}
-
-\newif\ifpdf
-\ifx\pdfoutput\undefined
-  \pdffalse
-\else
-  \pdfoutput=1
-  \pdftrue
-\fi
-
-\ifpdf
-  \pdfcompresslevel=9
-  %\usepackage[pdftex,colorlinks=true,plainpages=false]{hyperref}
-\else
-\fi
-
-\usepackage{graphicx,calc}
-\usepackage{makeidx}
-\usepackage{alltt}
-
-\setcounter{topnumber}{2}
-\def\topfraction{1}
-\setcounter{bottomnumber}{1}
-\def\bottomfraction{1}
-\setcounter{totalnumber}{3}
-\def\textfraction{0.2}
-\def\floatpagefraction{0.8}
-
-\setlength{\parindent}{0.0in}
-\setlength{\parskip}{0.1in}
-\setlength{\textwidth}{6.5in}
-\setlength{\itemindent}{1in}
-\setlength{\textheight}{9.5in}
-\addtolength{\oddsidemargin}{0in}
-\addtolength{\topmargin}{-0.4in}
-
-\parskip 0.05in
-
-\newcommand{\internal}[1]{}
-\newcommand{\function}[1]{{\noindent{\textsf{\textbf{#1}}}\\}}
-\newcommand{\args}[1]{\hspace*{2em}{\textsf{#1}}\\}
-\newcommand{\param}[1]{{\textsf{#1}}}
-\newcommand{\kw}[1]{{\textsf{\textbf{#1}}}}
-\newcommand{\note}[1]{\noindent{(Note: {\em {#1}})}}
-
-\newcommand{\basea}{\renewcommand{\baselinestretch}{1.2}}
-\newcommand{\baseb}{\renewcommand{\baselinestretch}{1.0}}
-\newcommand{\mycomment}[1]{}
-
-\textwidth 6.4in
-\textheight 8.9in
-\topmargin -.4in
-\oddsidemargin 0.25in
-\evensidemargin 0.25in
-\parskip 0.1in
+\documentclass[10pt]{article}
+\usepackage{../pplmanual}
 
-\makeindex
+\newcommand{\function}[1]{{\noindent{\textsf{#1}}\\}}
+\newcommand{\args}[1]{\hspace*{2em}{\texttt{#1}}\\}
+\newcommand{\param}[1]{{\texttt{#1}}}
+\newcommand{\kw}[1]{{\textsf{#1}}}
+\newcommand{\uw}[1]{{\textsl{#1}}}
 
-\begin{document}
+\makeindex
 
-\begin{titlepage}
-\begin{flushright}
-{\Large 
-  Parallel Programming Laboratory\\
-  University of Illinois at Urbana-Champaign\\
-}
-\end{flushright}
-\rule{\textwidth}{3pt}
-\vspace{\fill}
-\begin{flushright}
-\textsf{
- {\Huge Charm++\\ Finite Element Framework\\ Manual \\}
-}
-\end{flushright}
-\vspace{\fill}
+\title{Charm++\\ Finite Element Framework\\ Manual}
+\version{1.0}
+\credits{
 Initial version of Charm++ Finite Element Framework was developed
 by Milind Bhandarkar with inputs from Timothy Hinrichs and Kathikeyan
 Mahesh. The current version is almost completely rewritten by
 Orion Lawlor.
+}
 
-\rule{\textwidth}{3pt}
-
-\begin{flushright}
-{\large Version 1.0}
-\end{flushright}
-\end{titlepage}
+\begin{document}
 
-\tableofcontents
-\newpage
+\maketitle
 
 \section{Motivation}
 
@@ -104,13 +38,13 @@ effort.
 
 \section{Introduction/Terminology}
 
-A FEM program manipulates elements and nodes.  An element is a portion of
+A FEM program manipulates elements and nodes. An element is a portion of
 the problem domain, typically in the shape of a triangle, square, or hexagon
 in 2D; or tetrahedron or rectangular solid in 3D.  A node is a point in the
 domain.  An element knows which nodes surround it via the connectivity
 table, which lists adjacent nodes.
 
-\begin{figure}
+\begin{figure}[h]
 \begin{center}
 \includegraphics[width=4in]{simple_mesh}
 \end{center}
@@ -118,7 +52,7 @@ table, which lists adjacent nodes.
 \label{fig:simplemesh}
 \end{figure}
 
-\begin{table}
+\begin{table}[h]
 \begin{center}
 \begin{tabular}{||l||r|r|r||}\hline
 Element & \multicolumn{3}{c||}{Adjacent Nodes} \\\hline
@@ -151,7 +85,7 @@ even more).  During partitioning, we give nodes and elements new,
 chunk-local numbers.  Below, we partition the mesh above into two chunks, A
 and B.
 
-\begin{figure}
+\begin{figure}[h]
 \begin{center}
 \includegraphics[width=4in]{partitioned_mesh}
 \end{center}
@@ -159,7 +93,7 @@ and B.
 \label{fig:partitionedmesh}
 \end{figure}
 
-\begin{table}
+\begin{table}[h]
 \begin{center}
 \begin{tabular}{||l||r|r|r||}\hline
 Element & \multicolumn{3}{c||}{Adjacent Nodes} \\\hline
@@ -172,7 +106,7 @@ e2 & n1 & n2 & n4 \\
 \label{table:chunkA}
 \end{table}
 
-\begin{table}
+\begin{table}[h]
 \begin{center}
 \begin{tabular}{||l||r|r|r||}\hline
 Element & \multicolumn{3}{c||}{Adjacent Nodes}\\\hline
@@ -517,7 +451,7 @@ with shared nodes (for \kw{FEM\_Update\_Field}) and primary nodes (for
      \kw{dist} is the byte offset from the first node's data item to the
      second, a positive integer.
 
-\begin{figure}
+\begin{figure}[h]
 \begin{center}
 \includegraphics[width=4in]{create_field}
 \end{center}
diff --git a/doc/pplmanual.sty b/doc/pplmanual.sty
new file mode 100644 (file)
index 0000000..34cb8ed
--- /dev/null
@@ -0,0 +1,271 @@
+\NeedsTeXFormat{LaTeX2e}
+\typeout{^^J^^J
+Parallel Programming Laboratory^^J
+Manual Style^^J
+Written by Milind A. Bhandarkar, 12/00^^J}
+
+%%% Make it possible for both ps and pdf to be generated
+\newif\ifpdf
+\ifx\pdfoutput\undefined
+  \pdffalse
+\else
+  \pdfoutput=1
+  \pdftrue
+\fi
+
+\ifpdf
+  \pdfcompresslevel=9
+\fi
+
+%%% Imported from fullpage.sty, since it is not always available
+\topmargin 0pt
+\advance \topmargin by -\headheight
+\advance \topmargin by -\headsep
+
+\textheight 8.9in
+
+\oddsidemargin 0pt
+\evensidemargin \oddsidemargin
+\marginparwidth 1.0in
+
+\textwidth 6.5in
+%%% end import from fullpage
+
+%%% Commonly Needed packages
+\usepackage{graphicx,color,calc}
+\usepackage{makeidx}
+\usepackage{alltt}
+
+%%% Commands for uniform looks of C++, Charm++, and Projections
+\newcommand{\CC}{C\kern -0.0em\raise 0.5ex\hbox{\normalsize++}}
+\newcommand{\emCC}{C\kern -0.0em\raise 0.4ex\hbox{\normalsize\em++}}
+\newcommand{\charmpp}{\sc Charm++}
+\newcommand{\projections}{\sc Projections}
+\newcommand{\converse}{\sc Converse}
+\newcommand{\ampi}{\sc AMPI}
+
+%%% Commands to produce margin symbols
+\newcommand{\new}{\marginpar{\fbox{\bf$\mathcal{NEW}$}}}
+\newcommand{\important}{\marginpar{\fbox{\bf\Huge !}}}
+\newcommand{\experimental}{\marginpar{\fbox{\bf\Huge $\beta$}}}
+
+%%% Commands for manual elements
+\newcommand{\zap}[1]{ }
+\newcommand{\function}[1]{{\noindent{\textsf{#1}}\\}}
+\newcommand{\cmd}[1]{{\noindent{\textsf{#1}}\\}}
+\newcommand{\args}[1]{\hspace*{2em}{\texttt{#1}}\\}
+\newcommand{\param}[1]{{\texttt{#1}}}
+\newcommand{\kw}[1]{{\textsf{#1}}}
+\newcommand{\uw}[1]{{\textsl{#1}}}
+\newcommand{\desc}[1]{\indent{#1}}
+
+%%% Commands needed for Maketitle
+\newcommand{\@version}{}
+\newcommand{\@credits}{}
+\newcommand{\version}[1]{\renewcommand{\@version}{#1}}
+\newcommand{\credits}[1]{\renewcommand{\@credits}{#1}}
+
+%%% Print the License Page
+\newcommand{\@license}{%
+ \begin{center}
+   {University of Illinois}\\
+   {\charmpp/\converse\ Parallel Programming System Software}\\
+   {Non-Exclusive, Non-Commercial Use License}\\
+ \end{center}
+ \rule{\textwidth}{1pt}
+{\tiny
+Upon execution of this Agreement by the party identified below (``Licensee''),
+The Board of Trustees of the University of Illinois  (``Illinois''), on behalf
+of The Parallel Programming Laboratory (``PPL'') in the Department of Computer
+Science, will provide the \charmpp/\converse\ Parallel Programming System
+software (``\charmpp'') in Binary Code and/or Source Code form (``Software'')
+to Licensee, subject to the following terms and conditions. For purposes of
+this Agreement, Binary Code is the compiled code, which is ready to run on
+Licensee's computer.  Source code consists of a set of files which contain the
+actual program commands that are compiled to form the Binary Code.
+
+\begin{enumerate}
+  \item
+    The Software is intellectual property owned by Illinois, and all right,
+title and interest, including copyright, remain with Illinois.  Illinois
+grants, and Licensee hereby accepts, a restricted, non-exclusive,
+non-transferable license to use the Software for academic, research and
+internal business purposes only, e.g. not for commercial use (see Clause 7
+below), without a fee.
+
+  \item 
+    Licensee may, at its own expense, create and freely distribute
+complimentary works that interoperate with the Software, directing others to
+the PPL server (\texttt{http://charm.cs.uiuc.edu}) to license and obtain the
+Software itself. Licensee may, at its own expense, modify the Software to make
+derivative works.  Except as explicitly provided below, this License shall
+apply to any derivative work as it does to the original Software distributed by
+Illinois.  Any derivative work should be clearly marked and renamed to notify
+users that it is a modified version and not the original Software distributed
+by Illinois.  Licensee agrees to reproduce the copyright notice and other
+proprietary markings on any derivative work and to include in the documentation
+of such work the acknowledgement:
+
+\begin{quote}
+``This software includes code developed by the Parallel Programming Laboratory
+in the Department of Computer Science at the University of Illinois at
+Urbana-Champaign.''
+\end{quote}
+
+Licensee may redistribute without restriction works with up to 1/2 of their
+non-comment source code derived from at most 1/10 of the non-comment source
+code developed by Illinois and contained in the Software, provided that the
+above directions for notice and acknowledgement are observed.  Any other
+distribution of the Software or any derivative work requires a separate license
+with Illinois.  Licensee may contact Illinois (\texttt{kale@cs.uiuc.edu}) to
+negotiate an appropriate license for such distribution.
+
+  \item
+    Except as expressly set forth in this Agreement, THIS SOFTWARE IS PROVIDED
+``AS IS'' AND ILLINOIS MAKES NO REPRESENTATIONS AND EXTENDS NO WARRANTIES OF
+ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OR
+MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, OR THAT THE USE OF THE
+SOFTWARE WILL NOT INFRINGE ANY PATENT, TRADEMARK, OR OTHER RIGHTS.  LICENSEE
+ASSUMES THE ENTIRE RISK AS TO THE RESULTS AND PERFORMANCE OF THE SOFTWARE
+AND/OR ASSOCIATED MATERIALS.  LICENSEE AGREES THAT UNIVERSITY SHALL NOT BE HELD
+LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, OR INCIDENTAL DAMAGES WITH
+RESPECT TO ANY CLAIM BY LICENSEE OR ANY THIRD PARTY ON ACCOUNT OF OR ARISING
+FROM THIS AGREEMENT OR USE OF THE SOFTWARE AND/OR ASSOCIATED MATERIALS.
+
+  \item 
+    Licensee understands the Software is proprietary to Illinois. Licensee
+agrees to take all reasonable steps to insure that the Software is  protected
+and secured from unauthorized disclosure, use, or release and  will treat it
+with at least the same level of care as Licensee would use to  protect and
+secure its own proprietary computer programs and/or information, but using no
+less than a reasonable standard of care.  Licensee agrees to provide the
+Software only to any other person or entity who has registered with Illinois.
+If licensee is not registering as an individual but as an institution or
+corporation each member of the institution or corporation who has access to or
+uses Software must agree to and abide by the terms of this license. If Licensee
+becomes aware of any unauthorized licensing, copying or use of the Software,
+Licensee shall promptly notify Illinois in writing. Licensee expressly agrees
+to use the Software only in the manner and for the specific uses authorized in
+this Agreement.
+
+  \item
+    By using or copying this Software, Licensee agrees to abide by the
+copyright law and all other applicable laws of the U.S. including, but not
+limited to, export control laws and the terms of this license. Illinois  shall
+have the right to terminate this license immediately by written  notice upon
+Licensee's breach of, or non-compliance with, any terms of the license.
+Licensee may be held legally responsible for any  copyright infringement that
+is caused or encouraged by its failure to  abide by the terms of this license.
+Upon termination, Licensee agrees to  destroy all copies of the Software in its
+possession and to verify such  destruction in writing.
+
+  \item
+  The user agrees that any reports or published results obtained with  the
+Software will acknowledge its use by the appropriate citation as  follows:
+
+\begin{quote}
+``\charmpp/\converse\ was developed by the Parallel Programming Laboratory in
+the Department of Computer Science at the University of  Illinois at
+Urbana-Champaign.''
+\end{quote}
+
+Any published work which utilizes \charmpp\ shall include the following
+reference:
+
+\begin{quote}
+``L. V. Kale and S. Krishnan. \charmpp: Parallel Programming with Message-Driven
+Objects. In 'Parallel Programming using \CC' (Eds. Gregory V. Wilson and Paul
+Lu), pp 175-213, MIT Press, 1996.''
+\end{quote}
+
+Any published work which utilizes \converse\ shall include the following
+reference:
+
+\begin{quote}
+``L. V. Kale, Milind Bhandarkar, Narain Jagathesan, Sanjeev Krishnan and Joshua
+Yelon. \converse: An Interoperable Framework for Parallel Programming.
+Proceedings of the 10th International Parallel Processing Symposium, pp
+212-217, April 1996.''
+\end{quote}
+
+Electronic documents will include a direct link to the official \charmpp\ page
+at \texttt{http://charm.cs.uiuc.edu/}
+
+  \item
+    Commercial use of the Software, or derivative works based thereon,
+REQUIRES A COMMERCIAL LICENSE.  Should Licensee wish to make commercial use of
+the Software, Licensee will contact Illinois (kale@cs.uiuc.edu) to negotiate an
+appropriate license for such use. Commercial use includes: 
+
+    \begin{enumerate}
+      \item
+       integration of all or part of the Software into a product for sale,
+lease or license by or on behalf of Licensee to third parties, or 
+
+      \item
+       distribution of the Software to third parties that need it to
+commercialize product sold or licensed by or on behalf of Licensee.
+    \end{enumerate}
+
+  \item
+    Government Rights. Because substantial governmental funds have been  used
+in the development of \charmpp/\converse, any possession, use or sublicense of
+the Software by or to the United States government shall be subject to such
+required restrictions.
+
+  \item
+    \charmpp/\converse\ is being distributed as a research and teaching tool
+and as such, PPL encourages contributions from users of the code that might, at
+Illinois' sole discretion, be used or incorporated to make the basic  operating
+framework of the Software a more stable, flexible, and/or useful  product.
+Licensees who contribute their code to become an internal  portion of the
+Software agree that such code may be distributed by  Illinois under the terms
+of this License and may be required to sign an  ``Agreement Regarding
+Contributory Code for \charmpp/\converse\ Software'' before Illinois  can
+accept it (contact \texttt{kale@cs.uiuc.edu} for a copy).
+\end{enumerate}
+
+UNDERSTOOD AND AGREED.
+
+Contact Information:
+
+The best contact path for licensing issues is by e-mail to
+\texttt{kale@cs.uiuc.edu} or send correspondence to:
+
+\begin{quote}
+Prof. L. V. Kale\\
+Dept. of Computer Science\\
+University of Illinois\\
+1304 W. Springfield Ave\\
+Urbana, Illinois 61801 USA\\
+FAX: (217) 333-3501
+\end{quote}
+}%tiny
+ \newpage
+}% end of license
+
+\renewcommand{\maketitle}{\begin{titlepage}%
+ \begin{flushright}
+   {\Large
+     Parallel Programming Laboratory\\
+     University of Illinois at Urbana-Champaign\\
+   }
+ \end{flushright}
+ \rule{\textwidth}{3pt}
+ \vspace{\fill}
+ \begin{flushright}
+   \textsf{\Huge \@title \\}
+ \end{flushright}
+ \vspace{\fill}
+ \@credits \\
+ \rule{\textwidth}{3pt}
+ \begin{flushright}
+   {\large Version \@version}
+ \end{flushright}
+ \end{titlepage}
+ \@license
+
+ \tableofcontents
+ \newpage
+}% maketitle
+