add a new parameter:

#
# To detect some divergence cases faster, we also deem any horizon where
# the infinity-norm of Theta exceeds this parameter, to be "not found".
# The default is effectively "no limit".
#
real max_allowable_Theta \
  "max ||Theta||_infinity allowed for any trial surface \
   before we give up and say we can't find this horizon"
{
(0.0:* :: "any positive real number"
} 1.0e10


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

1 files changed, 19 insertions, 3 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index d04fb72..335e900 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -1235,20 +1235,36 @@ each time that apparent horizon is found:
 \item[\code{max\_allowable\_horizon\_radius[}$n$\code{]}]
 \mbox{}\\
 	This parameter gives the maximum mean-coordinate-radius
-	which any given apparent horizon may have.%%%
+	which any given trial surface may have in the course of
+	trying to solve the apparent horizon equation.%%%
 \footnote{%%%
 	 Note that this is an unweighted arithmetic
 	 mean over the horizon-surface grid points,
 	 the same value which is printed as \code{r\_grid}
 	 during the horizon-finding iterations.
 	 }%%%
-{}	This defaults to $10^{10}$ (effectively $+\infty$) for
-	each apparent horizon.  You can set it to a smaller value
+{}	In particular, if any trial surface has a mean coordinate radius
+	which exceeds this parameter, \thorn{AHFinderDirect} gives up
+	and deems this apparent horizon to be ``not found''.
+
+	This parameter defaults to $10^{10}$ (effectively $+\infty$)
+	for each apparent horizon.  You can set it to a smaller value
 	to make \thorn{AHFinderDirect} a bit more efficient, or
 	(probably more important in practice) to stop
 	\thorn{AHFinderDirect} from iterating off the edge of the grid
 	if this causes problems with interpolation or boundary conditions.
 
+\item[\code{max\_allowable\_Theta}]
+\mbox{}\\
+	This parameter gives the maximum $\|\Theta\|_\infty$
+	which any given trial surface may have in the course of
+	trying to solve the apparent horizon equation.
+	In particular, if any trial surface has $\|\Theta\|_\infty$
+	exceeding this parameter, \thorn{AHFinderDirect} gives up
+	and deems this apparent horizon to be ``not found''.
+	This parameter defaults to $10^{10}$ (effectively $+\infty$)
+	for each apparent horizon.
+
 \item[\code{surface\_expansion[}$n$\code{]}]
 \mbox{}\\
 	This parameter (which defaults to 0.0) sets the expansion