Included style suggestions from Erik Schnetter (Cactus/1104)

Used a more accurate representation of pi (hence new testsuite files)

Wrote some minimal documentation


git-svn-id: http://svn.cactuscode.org/arrangements/CactusWave/WaveBinarySource/trunk@36 b9286e40-80fe-41ab-903a-d6b447012e1e

2 files changed, 31 insertions, 92 deletions

diff --git a/doc/README b/doc/README
index 666abab..7827791 100644
--- a/doc/README
+++ b/doc/README
@@ -1,7 +1,10 @@
+Cactus Code Thorn WaveBinarySource
+Authors    : Cactus Maintainers (cactusmaint@cactuscode.org)
+CVS info   : $Header$
+--------------------------------------------------------------------------
 
+Purpose of the thorn:
+
+This thorn adds a source term to the 3D scalar wave equation. The 
+source term represents two orbiting scalar sources.
 
-This thorn adds a source term to the evolution equation. It is
-scheduled to run after wavetoy evolution and adds data corresponding
-to two rotating binary charges. It simply overwrites the scalarfield
-grid variable where the binary sources are located. The binary sources 
-are not evolved. they are rotated based on the evolution time.
diff --git a/doc/documentation.tex b/doc/documentation.tex
index b097bbe..db988fc 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -1,65 +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
-%       % BEGIN CACTUS THORNGUIDE",
-%     except for filling in the title, author, date etc. fields.
-%   - You can define your own macros are OK, but they must appear after
-%     the BEGIN CACTUS THORNGUIDE line, and do 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.  
-%   - 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$
 
@@ -74,15 +12,15 @@
 \begin{document}
 
 % The author of the documentation
-\author{} 
+\author{Gabrielle Allen} 
 
 % The title of the document (not necessarily the name of the Thorn)
-\title{}
+\title{Orbiting Scalar Charges}
 
 % the date your document was last changed, if your document is in CVS, 
 % please us:
-%    \date{$ $Date$ $}
-\date{}
+\date{$ $Date$ $}
+
 
 \maketitle
 
@@ -102,34 +40,32 @@
 
 \section{Introduction}
 
-\section{Physical System}
-
-\section{Numerical Implementation}
-
-\section{Using This Thorn}
-
-\subsection{Obtaining This Thorn}
+This thorn provides a source term to the scalar field evolution
+for two rotating binary charges.
 
-\subsection{Basic Usage}
 
-\subsection{Special Behaviour}
-
-\subsection{Interaction With Other Thorns}
-
-\subsection{Support and Feedback}
-
-\section{History}
-
-\subsection{Thorn Source Code}
+\section{Physical System}
 
-\subsection{Thorn Documentation}
+The 3D scalar wave equation with a source term $\rho(t,x,y,z)$ is written
+$$
+\nabla \phi = 4 \pi \rho
+$$
 
-\subsection{Acknowledgements}
+Each scalar source with charge $Q$ and radius $R$ contributes 
+$$
+\rho = \frac{3Q}{4\pi R^3}
+$$
 
+\section{Numerical Implementation}
 
-\begin{thebibliography}{9}
+The only involved part of this thorn arise in working out where the
+sources are located (if at all) on each local grid for a multiprocessor
+run. The source terms are not numerically evolved, but are calculated 
+exactly, based on the physical time and their orbital velocity.
 
-\end{thebibliography}
+A routine is scheduled to run {\it after} the homogeneous equation
+for the scalar field has been evolved, and simply updates the value
+of the scalar field by adding on the source contribution.
 
 % Do not delete next line
 % END CACTUS THORNGUIDE