document find_every parameter

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

1 files changed, 15 insertions, 7 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index 55e1783..4b49aae 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -366,20 +366,28 @@ section~\ref{AHFinderDirect/sect-examples} should make this clear.
 \label{AHFinderDirect/sect-parameters/overall-parameters}
 
 \begin{description}
-\item[\code{find\_AHs}]
+\item[\code{find\_every}]
 \mbox{}\\
-	These is a Boolean parameters specifying whether or not
-	\thorn{AHFinderDirect} should try to find apparent horizons.
-	at each time step (at the \code{CCTK\_POSTSTEP} Cactus schedule bin).
-	By default it's \verb|true|, \ie{} you just need to activate
-	\thorn{AHFinderDirect} for it to try to find apparent horizons.
+	This is an integer parameter specifying how often
+	\thorn{AHFinderDirect} should try to find apparent horizons:
+	If $\verb|find_every| = 0$, \thorn{AHFinderDirect} is a no-op.
+	If $\verb|find_every| \ne 0$, \thorn{AHFinderDirect} tries to
+	find apparent horizons each \verb|find_every| time steps.%%%
+\footnote{%%%
+	 More precisely, if ${\tt find\_every} \ne 0$,
+	 \thorn{AHFinderDirect} tries to find apparent
+	 horizons at each time step where {\tt cctk\_iteration}
+	 is evenly divisible by {\tt find\_every}.
+	 }%%%
+{}	The default value is~1, \ie{} \thorn{AHFinderDirect} tries
+	to find apparent horizons at every time step.
 \item[\code{N\_horizons}]
 \mbox{}\\
 	How many apparent horizons do you want to find in each slice?
 	Typical values are 1 (the default), 2, or 3.%%%
 \footnote{%%%
 	 Larger values are also possible.  The present upper
-	 limit is 10, but it would be very easy to raise this
+	 limit is 10, but it would be trivial to raise this
 	 further if desired -- see the comments in \code{param.ccl}
 	 for details.
 	 }%%%