expand/update the description of the main C++ classes

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

1 files changed, 25 insertions, 9 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index 6afae74..21e6185 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -9,7 +9,8 @@
 
 % misc text stuff
 \def\code#1{{\tt #1}}			% for formatting code
-\def\ie{\hbox{i.e.}}
+\def\eg{\hbox{eg.\hbox{}}}
+\def\ie{\hbox{i.e.\hbox{}}}
 \def\ahf{\code{AHFinderDirect}}		% our own name
 
 % get size/spacing of "++" right, cf online C++ FAQ question 35.1
@@ -94,26 +95,41 @@ as follows:
 \item[\code{patch\_system}]
 	is the top-level class representing a multipatch system.
 \item[\code{x\_patch}, \code{y\_patch}, \code{z\_patch}]
-	represent individual patches near the $x-$, $y-$, and $z-$axes
-	respectively.
+	represent individual patches near the $\pm x-$, $\pm y-$,
+	and $\pm z-$axes respectively.
 \item[\code{patch}]
 	is an virtual base class representing a grid patch.
 \item[\code{patch\_edge}]
 	represents the geometry of a single edge of a patch,
 	\ie{} it represents the conversions between (perpendicular,parallel)
 	and (rho,sigma) coordinates.
-\item[\code{ghost\_data}]
-\item[\code{patch\_interp}]
-\item[\code{interpatch\_ghost\_data}]
-\item[\code{symmetry\_ghost\_data}]
+\item[\code{ghost\_zone}]
+	is a virtual base class representing the ghost zone
+	along a single edge of a patch
+\item[\code{interpatch\_ghost\_zone}]
+	represents a ghost zone where we get data by interpolating
+	it from a neighboring patch
+\item[\code{symmetry\_ghost\_zone}]
+	represents a ghost zone where we get data by a discrete
+	symmetry (\eg{} a reflection or periodic boundary condition)
+\item[\code{patch\_frontier}]
+	is our interface to the interpatch interpolation
 \end{description}
 
 Class \code{patch} is in term implemented using the following
 helper classes:
 \begin{description}
-\item[\code{fd\_grid}]
-\item[\code{grid}]
 \item[\code{grid\_arrays}]
+	stores multiple grid functions (gridfns) on a 2-D grid
+	(this class deals only in integer grid coordinates)
+\item[\code{grid}]
+	[derived from \code{grid\_arrays}]				\\
+	this class adds the floating-point grid coordinates
+\item[\code{fd\_grid}]
+	[derived from \code{grid}]					\\
+	this class adds finite differencing operations
+	(both 2nd and 4th order are implemented; at present
+	the choice between them is done at compile time)
 \end{description}
 
 The implementation also uses the following low-level generic helper