change to Cactus-standard magic file name documentation.tex

git-svn-id: http://svn.einsteintoolkit.org/cactus/EinsteinAnalysis/AHFinderDirect/trunk@38 f88db872-0e4f-0410-b76b-b9085cfa78c5

4 files changed, 42 insertions, 81 deletions

diff --git a/doc/Makefile b/doc/Makefile
index 0c67705..4ca0d7f 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -1,11 +1,9 @@
 # Makefile for documentation
-# $Id: Makefile,v 1.3 2001-06-14 14:59:48 jthorn Exp $
+# $Id: Makefile,v 1.4 2001-06-16 13:34:25 jthorn Exp $
 
 #
 # Targets:
 # default	latex & dvips everything
-# user		latex & dvips User's Guide
-# prog		latex & dvips Programmer's Guide
 # bib		bibtex everything
 # clean		remove all machine-generated files
 #
@@ -19,28 +17,23 @@
 
 ###############################################################################
 
-.PHONY		: default
-default		: prog user
-
-.PHONY	: user user.dvi user.ps
-user	: user.ps
-user.ps	: user.dvi
-	dvips -f <user.dvi >user.ps
-user.dvi: user.tex
-	latex user
-
-.PHONY	: prog prog.dvi prog.ps
-prog	: prog.ps
-prog.ps	: prog.dvi
-	dvips -f <prog.dvi >prog.ps
-prog.dvi: prog.tex
-	latex prog
-
-.PHONY	: bib
-bib	:
-	bibtex user
-	bibtex prog
-
-.PHONY	: clean
-clean	:
+.PHONY			: default
+default			: ps
+
+.PHONY			: ps
+ps			: documentation.ps
+documentation.ps	: documentation.dvi
+	dvips -f <documentation.dvi >documentation.ps
+
+.PHONY			: dvi
+dvi			: documentation.dvi
+documentation.dvi	: documentation.tex
+	latex documentation
+
+.PHONY			: bib
+bib			:
+	bibtex documentation
+
+.PHONY			: clean
+clean			:
 	-rm *.dvi *.ps *.aux *.bbl *.log *.blg
diff --git a/doc/README b/doc/README
index fe2a2e4..8c28d11 100644
--- a/doc/README
+++ b/doc/README
@@ -1,4 +1 @@
-This directory holds documentation for the AHFinderDirect thorn:
-
-user.*	User's Guide
-prog.*	Programmer's Guide
+This directory holds documentation for the AHFinderDirect thorn.
diff --git a/doc/user.tex b/doc/documentation.tex
index fc1c8d6..e60d593 100644
--- a/doc/user.tex
+++ b/doc/documentation.tex
@@ -1,4 +1,10 @@
 \documentclass{article}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+%
+% ***** macro definitions etc *****
+%
 \bibliographystyle{alpha}
 
 % our own name
@@ -7,11 +13,19 @@
 % get size/spacing of "++" right, cf online C++ FAQ question 35.1
 \def\Cplusplus{\hbox{C\raise.25ex\hbox{\footnotesize ++}}}
 
+% misc math mode stuff
+\def\ij{_{ij}}
+\def\upij{^{ij}}
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
+%
+% ***** title/author/abstract *****
+%
+
 \begin{document}
-\title{The \ahf{} Thorn -- User's Guide}
-\author{Jonathan Thornburg {\tt jthorn@aei.mpg.de}}
+\title{The \ahf{} Thorn}
+\author{Jonathan Thornburg\quad{}{\tt <jthorn@aei.mpg.de>}}
 %
 % We want CVS to expand the Id keyword on the next line, but we don't
 % want TeX to go into math mode to typeset the expansion (because that
@@ -22,27 +36,17 @@
 \maketitle
 
 \abstract{
-This document is a user's guide for the \ahf{} thorn.
-See the programmer's guide in the same directory for implementation
-documentation.
+This document describes the \ahf{} thorn.  This thorn locates
+apparent horizons in a numerically computed slice using a direct
+method, posing the apparent horizon equation as an elliptic PDE
+on angular-coordinate space.  This is very fast, but requires a
+``reasonable'' initial guess.
 }
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{Introduction}
 
-
-The \ahf{} thorn locates apparent horizons using the direct method
-described in \cite{Thornburg-1996-horizon-finding}, modified to work
-with Cartesian $(x,y,z)$-grid input data, and using the multiple-patch
-scheme described in \cite{Thornburg-2000-mpe-mg9}.
-
-In this method we posing the apparent horizon equation as an elliptic
-PDE on angular-coordinate space, and solve this PDE using a global
-Newton (actually Newton-Kantorovich) method, updating all points
-simultaneously at each iteration.  We use a sparse $\sf LU$ decomposition
-for the underlying linear-equation solver.
-
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \bibliography{jt}
diff --git a/doc/prog.tex b/doc/prog.tex
deleted file mode 100644
index a9058ff..0000000
--- a/doc/prog.tex
+++ /dev/null
@@ -1,33 +0,0 @@
-\documentclass{article}
-\bibliographystyle{alpha}
-
-% get size/spacing of "++" right, cf online C++ FAQ question 35.1
-\def\Cplusplus{\hbox{C\raise.25ex\hbox{\footnotesize ++}}}
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-\begin{document}
-\title{The {\tt AHFinderDirect} Thorn -- Programmer's Guide}
-\author{Jonathan Thornburg {\tt jthorn@aei.mpg.de}}
-%
-% We want CVS to expand the Id keyword on the next line, but we don't
-% want TeX to go into math mode to typeset the expansion (because that
-% wouldn't look as nice in the output), so we use the "$ $" construct
-% to get TeX out of math mode again when typesetting the expansion.
-%
-\date{$ $Id$ $}
-\maketitle
-
-\abstract{
-This document describes the implementation of the {\tt AHFinderDirect}
-thorn.  See the user's guide in the same directory for user-level
-documentation.
-}
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-\bibliography{jt}
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-\end{document}