document new semantics for min_horizon_radius_points_for_mask parameter

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

1 files changed, 13 insertions, 16 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index eb5d1aa..4f12788 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -1035,16 +1035,13 @@ and $z$ Cactus grid spacings)%%%
 	For each apparent horizon that it finds, \thorn{AHFinderDirect}
 	only sets the mask on a given grid if
 	\begin{equation}
-	r_{\min} \ge \verb|min_horizon_radius_points_for_mask|
+	r_{\text{inner},\min} \ge \verb|min_horizon_radius_points_for_mask|
 		     * {\Delta x}_{\text{current},\max}
 	\end{equation}
-	where $r_{\min}$ is the minimum coordinate radius of
-	the apparent horizon (about the local coordinate origin),%%%
-\footnote{%%%
-	 This may change soon to $r_\text{inner}$
-	 or $r_\text{outer}$.
-	 }%%%
-{}	and ${\Delta x}_{\text{current},\max}$ is the maximum of the
+	where $r_{\text{inner},\min}$ is the minimum over all angles
+	of $r_\text{inner}$ as defined by
+	equation~\eqref{AHFinderDirect/eqn-r-inside-outside},
+	and ${\Delta x}_{\text{current},\max}$ is the maximum of the
 	Cactus $x$, $y$, and~$z$ grid spacings on the current Cactus
 	grid.%%%
 \footnote{%%%
@@ -1054,14 +1051,14 @@ and $z$ Cactus grid spacings)%%%
 	 $r_\text{outer}$ and $r_\text{inner}$ by
 	 equation~\eqref{AHFinderDirect/eqn-r-inside-outside}.
 	 }%%%
-{}  If this condition
-	isn't satisfied, then \thorn{AHFinderDirect} skips setting the
-	mask for this apparent horizon, just as if this apparent
-	horizon wasn't found.  (Note that the various output files
-	are still written, and the apparent horizon shape is still
-	used as the initial guess for the next time step's apparent-horizon
-	finding, all as usual; it's only the mask processing for
-	this horizon that's skipped (for this time step).)
+{}	If this condition isn't satisfied, then \thorn{AHFinderDirect}
+	skips setting the mask for this apparent horizon, just as if
+	this apparent horizon wasn't found.  (Note that all other
+	processing for an apparent horizon being found is still done,
+	including writing output files, using the apparent horizon shape
+	as the initial guess for the next time step's apparent-horizon
+	finding, etc.; it's only the mask processing for this horizon
+	(at this time step) that's skipped.)
 \end{description}
 
 \thorn{AHFinderDirect} supports two types of mask grid functions;