misc. minor fixes.

git-svn-id: http://svn.cactuscode.org/arrangements/CactusElliptic/EllBase/trunk@67 57bc7290-fb3d-4efd-a9b1-28e84cce6043

1 files changed, 20 insertions, 17 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index e36383a..7d8055d 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -45,7 +45,7 @@ given metric and a conformal factor: $\nabla_{cg} \phi + M \phi
 + N = 0 $
 \item{\bf generic:} solves a linear elliptic equation by passing the 
 	stencil functions. There is support for a maximum of 27 stencil 
-	functions ($3^3$). {\em This is not implemented, yet}
+	functions ($3^3$). {\em This is not implemented, yet.}
 \end{enumerate}
 
 \section{Technical Specification}
@@ -62,7 +62,7 @@ given metric and a conformal factor: $\nabla_{cg} \phi + M \phi
 
 \section{ToDo}
 \begin{itemize}
-\item{}Add more standard equation classes
+\item{}Add more standard equation classes.
 \item{}The method for passing  boundary conditions  into the 
 elliptic solvers has not fully consolidated. We have some good ideas
 on what the interface should look like, but the implementation will
@@ -70,10 +70,10 @@ take some time. If you are worried about BCs, please contact me.
 \end{itemize}
 
 \section{Solving an elliptic equation}
-EllBase provides a calling interfaces for each of the elliptic classes 
+EllBase provides a calling interface for each of the elliptic classes 
 implemented.
-As a user you need to provide all information needed for a
-particular elliptic class, in general this will include
+As a user you must provide all information needed for a
+particular elliptic class.  In general this will include
 \begin{itemize}
 \item{} the gridfunction(s) to solve for
 \item{} the coefficient matrix or source terms
@@ -86,7 +86,7 @@ solver for this elliptic class: just change the name of the solver in your
 elliptic interface call. If somebody improves a solver you have been using,
 there is no need for you to change any code on your side: the interface 
 will hide all of that. Another advantage is that your code will compile 
-and run, even though certain solvers are not compiled in. In these case, you 
+and run, even though certain solvers are not compiled in. In this case, you 
 will have to do some return value checking to offer alternatives.
 
 \subsection{{\tt Ell\_LinFlat}}
@@ -103,34 +103,34 @@ To call this interface from {\bf C}:
 \end{verbatim}
 {\bf Argument List:}
 \begin{itemize}
-\item{\tt ierr}: return value: ``0'' success
+\item{\tt ierr}: return value: ``0'' for success.
 \item{\tt cctkGH}: the Fortran ``pointer'' to the grid function
 hierachy.
-\item{\tt GH}: the C pointer to the grid hierarchy, type: {\tt pGH *GH}
-\item{\tt phi\_gif}: the integer {\em index} of the grid function so solver
+\item{\tt GH}: the C pointer to the grid hierarchy, type: {\tt pGH *GH}.
+\item{\tt phi\_gif}: the integer {\em index} of the grid function to solve
 for.
 \item{\tt M\_gfi}:  the integer {\em index} of the grid function which holds
 $M$.
-\item{\tt N\_gif}: the integer {\em index} of the grid function which holds $N$
+\item{\tt N\_gif}: the integer {\em index} of the grid function which holds $N$.
 \item{\tt AbsTol}: array of size $3$: holding {\em absolute} tolerance values for the 
-$L_1$, $L_2$, $L_\infty$ Norm.  Check, if the solver side supports
-these norms.The interface side does not guarantee that these norms are 
-actually implemenented by a solver. See the section on Norms: \ref{sec:ellnorms}.
+$L_1$, $L_2$, $L_\infty$ norm.  Check if the solver side supports
+these norms.  The interface side does not guarantee that these norms are 
+actually implemenented by a solver. See the section on norms: \ref{sec:ellnorms}.
 \item{\tt RelTol}: array of size $3$: holding {\em relative}
-tolerance factors for the $L_1$, $L_2$, $L_\infty$. Check, if the 
+tolerance factors for the $L_1$, $L_2$, $L_\infty$. Check if the 
 solver side supports these norms. The interface side does not
 guarantee that these norms are actually implemenented by a solver. 
 See the section on Norms: \ref{sec:ellnorms}.
 \item{\tt  "solvername"}: the name of a solver, which is registered
-for a particular equation class. How to find out the names ? Either
+for a particular equation class. How does one find out the names?  Either
 check the documentation of the elliptic solvers or check for
 registration infomation outputted by a cactus at runtime.
 \end{itemize}
 {\bf Example use in Fortran}, as used in the WaveToy arrangement: {\tt
-./WavToy/IDScalarWave}:
+CactusWave/IDScalarWave}:
 \begin{verbatim}
 
-c     We derive the grid function indeces from the names of the 
+c     We derive the grid function indicies from the names of the 
 c     grid functions:
       call CCTK_VarIndex (Mcoeff_gfi, "idscalarwaveelliptic::Mcoeff")
       call CCTK_VarIndex (Ncoeff_gfi, "idscalarwaveelliptic::Ncoeff")
@@ -504,4 +504,7 @@ schedule FastSOR_register at CCTK_INITIAL
 
 \end{itemize}
 
+\section{Norms}
+\label{sec:ellnorms}
+
 \end{document}