From ed15a6d09620c2b1061dbda537cd7f915e3270a4 Mon Sep 17 00:00:00 2001 From: allen Date: Fri, 18 Jul 2003 22:09:45 +0000 Subject: Added very meagre details git-svn-id: http://svn.cactuscode.org/arrangements/CactusWave/WaveToyExtra/trunk@5 479a9caf-478d-4319-8268-cbb0ee841cc9 --- doc/documentation.tex | 112 ++++++-------------------------------------------- 1 file changed, 12 insertions(+), 100 deletions(-) diff --git a/doc/documentation.tex b/doc/documentation.tex index a965521..453deb3 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -1,71 +1,3 @@ -% *======================================================================* -% Cactus Thorn template for ThornGuide documentation -% Author: Ian Kelley -% Date: Sun Jun 02, 2002 -% $Header$ -% -% Thorn documentation in the latex file doc/documentation.tex -% will be included in ThornGuides built with the Cactus make system. -% The scripts employed by the make system automatically include -% pages about variables, parameters and scheduling parsed from the -% relevent thorn CCL files. -% -% This template contains guidelines which help to assure that your -% documentation will be correctly added to ThornGuides. More -% information is available in the Cactus UsersGuide. -% -% Guidelines: -% - Do not change anything before the line -% % START CACTUS THORNGUIDE", -% except for filling in the title, author, date etc. fields. -% - Each of these fields should only be on ONE line. -% - Author names should be sparated with a \\ or a comma -% - You can define your own macros, but they must appear after -% the START CACTUS THORNGUIDE line, and must not redefine standard -% latex commands. -% - To avoid name clashes with other thorns, 'labels', 'citations', -% 'references', and 'image' names should conform to the following -% convention: -% ARRANGEMENT_THORN_LABEL -% For example, an image wave.eps in the arrangement CactusWave and -% thorn WaveToyC should be renamed to CactusWave_WaveToyC_wave.eps -% - Graphics should only be included using the graphix package. -% More specifically, with the "includegraphics" command. Do -% not specify any graphic file extensions in your .tex file. This -% will allow us (later) to create a PDF version of the ThornGuide -% via pdflatex. | -% - References should be included with the latex "bibitem" command. -% - Use \begin{abstract}...\end{abstract} instead of \abstract{...} -% - Do not use \appendix, instead include any appendices you need as -% standard sections. -% - For the benefit of our Perl scripts, and for future extensions, -% please use simple latex. -% -% *======================================================================* -% -% Example of including a graphic image: -% \begin{figure}[ht] -% \begin{center} -% \includegraphics[width=6cm]{MyArrangement_MyThorn_MyFigure} -% \end{center} -% \caption{Illustration of this and that} -% \label{MyArrangement_MyThorn_MyLabel} -% \end{figure} -% -% Example of using a label: -% \label{MyArrangement_MyThorn_MyLabel} -% -% Example of a citation: -% \cite{MyArrangement_MyThorn_Author99} -% -% Example of including a reference -% \bibitem{MyArrangement_MyThorn_Author99} -% {J. Author, {\em The Title of the Book, Journal, or periodical}, 1 (1999), -% 1--16. {\tt http://www.nowhere.com/}} -% -% *======================================================================* - -% If you are using CVS use this line to give version information % $Header$ \documentclass{article} @@ -74,7 +6,7 @@ % (Automatically used from Cactus distribution, if you have a % thorn without the Cactus Flesh download this from the Cactus % homepage at www.cactuscode.org) -\usepackage{../../../../doc/ThornGuide/cactus} +\usepackage{../../../../doc/latex/cactus} \begin{document} @@ -86,8 +18,7 @@ % the date your document was last changed, if your document is in CVS, % please use: -% \date{$ $Date$ $} -\date{July 18 2003} +\date{$ $Date$ $} \maketitle @@ -99,7 +30,7 @@ % Add an abstract for this thorn's documentation \begin{abstract} - +Advanced features for WaveToy \end{abstract} % The following sections are suggestive only. @@ -107,36 +38,17 @@ \section{Introduction} -\section{Physical System} - -\section{Numerical Implementation} - -\section{Using This Thorn} - -\subsection{Obtaining This Thorn} - -\subsection{Basic Usage} - -\subsection{Special Behaviour} - -\subsection{Interaction With Other Thorns} - -\subsection{Examples} - -\subsection{Support and Feedback} - -\section{History} - -\subsection{Thorn Source Code} - -\subsection{Thorn Documentation} - -\subsection{Acknowledgements} - +This thorn contains enhancements to the standard WaveToy thorns for +modelling 3D scalar fields. WaveToy is primarily intended as a +example thorn and for that reason is deliberately kept as simple +as practical, with more advanced features included here instead. +Currently this thorn shows how more flexible boundaries can be +used with WaveToy or other thorns. -\begin{thebibliography}{9} +\section{Boundary Conditions} -\end{thebibliography} +This thorn provides the infrastructure to use any registered +external boundary condition with WaveToy, with any choice of options. % Do not delete next line % END CACTUS THORNGUIDE -- cgit v1.2.3