At Ian Hawke's request, make the setting of an excision mask specifyable

on a per-horizon basis:

The old parameter   set_mask   is now replaced by two new parameters:
   set_mask_for_all_horizons
   set_mask_for_individual_horizon[n]
For most purposes, you can just change   set_mask   to
  set_mask_for_all_horizons  in your parameter files.  If you
really want to control the setting of the mask on a per-horizon basis,
read section 4.6 in the thorn guide to find out how the new parameters
work.


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

1 files changed, 16 insertions, 8 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index 4f12788..d04fb72 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -878,18 +878,26 @@ with respect to the apparent horizon(s).  This is usually used for
 excision.
 
 \begin{description}
-\item[\code{set\_mask}]
+\item[%%%
+     \begin{tabular}{@{}l@{}}
+     \code{set\_mask\_for\_all\_horizons}			\\
+     \code{set\_mask\_for\_individual\_horizon[}$n$\code{]}	%%%\\
+     \end{tabular}
+     ]
 \mbox{}\\
-	If this Boolean parameter is set to true,
-	\thorn{AHFinderDirect} will set a mask grid function(s).
-	This parameter defaults to false (don't set a mask).
-
-	If this parameter is set to true, you almost certainly also
-	need to set the Boolean parameter \verb|SpaceMask::use_mask|
+	These Boolean parameters control whether \thorn{AHFinderDirect}
+	should set a mask grid function(s): If the (C) expression
+	\verb:set_mask_for_all_horizons || set_mask_for_individual_horizon[i]:
+	is true, then \thorn{AHFinderDirect} will set a mask grid
+	function(s) for apparent horizon $i$.
+	All these parameters default to false (don't set a mask).
+
+	If any of these parameters is set to true, you almost certainly
+	also need to set the Boolean parameter \verb|SpaceMask::use_mask|
 	to true to to turn on storage for the mask grid function(s)!
 \end{description}
 
-If \verb|set_mask| is set, \thorn{AHFinderDirect} partitions the
+If it's setting a mask(s), \thorn{AHFinderDirect} partitions the
 Cactus grid into 3~regions: an \defn{inside}, a \defn{buffer},
 and an \defn{outside}.  Typically the inner region is excised, but
 \thorn{AHFinderDirect} doesn't itself do this:  It just sets the mask(s);