document the new feature that we can simultaneously set old- and

new-style excision masks


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

1 files changed, 29 insertions, 22 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index 6b74f2f..7df19cc 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -274,7 +274,8 @@ here's what works and what doesn't:
 \item	\thorn{AHFinderDirect} can set an excision mask based on
 	each horizon's shape, using either the old-style (\verb|CCTK_REAL|)
 	mask (compatible with \thorn{AHFinder}) or the new-style
-	(\verb|CCTK_INT|) mask bit-fields defined by \thorn{SpaceMask}.
+	(\verb|CCTK_INT|) mask bit-fields defined by \thorn{SpaceMask}
+	(or even both simultaneously).
 \end{itemize}
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -791,10 +792,10 @@ controlled by the following parameters:
 
 \subsection{(Excision) Mask Parameters}
 
-This thorn can optionally set a mask grid function at each point
-of the Cactus grid, to indicate where that point is with respect to
-the apparent horizon(s).  This is usually used for excision.
-This feature is controlled by the following parameteters:
+This thorn can optionally set a mask grid function (or functions)
+at each point of the Cactus grid, to indicate where that point is
+with respect to the apparent horizon(s).  This is usually used for
+excision.  This feature is controlled by the following parameteters:
 
 \begin{description}
 \item[\code{set\_horizon\_mask}]
@@ -849,28 +850,34 @@ This feature is controlled by the following parameteters:
 	 respectively.
 	 }%%%
 
-\item[\code{mask\_type}]
+\item[%%%
+     \begin{tabular}{@{}l@{}}
+     \code{set\_old\_style\_mask}	\\
+     \code{set\_new\_style\_mask}	%%%\\
+     \end{tabular}
+     ]
 \mbox{}\\
 	\thorn{AHFinderDirect} supports two types of mask grid functions;
-	this parameter chooses between them:
+	these Boolean parameters choose which of them you want to set:
 	\begin{description}
-	\item[\code{"old-style (CCTK\_REAL)"}]
+	\item[\code{set\_old\_style\_mask}]
 	\mbox{}\\
-		This specifies an old-style excision mask, where a
-		\verb|CCTK_REAL| Cactus grid function is set to one
-		value inside the mask volume, and another value outside.
-		(This is how the \thorn{AHFinder} apparent horizon finder
-		works.)
-	\item[\code{"new-style (CCTK\_INT)"}]
+		This parameter (default \verb|"true"|) specifies an
+		old-style excision mask, where a \verb|CCTK_REAL|
+		Cactus grid function is set to one value inside the
+		mask volume, and another value outside.  (This is how
+		the \thorn{AHFinder} apparent horizon finder works.)
+	\item[\code{set\_new\_style\_mask}]
 	\mbox{}\\
-		This specifies a new-style excision mask, where a
-		specified bit field in a \verb|CCTK_INT| Cactus
-		grid function is set to one value inside the mask
-		volume, and another value outside.  The bit field
-		is specified by its name, as registered with the
-		\thorn{SpaceMask} thorn.  We plan to convert all
-		Cactus excision (and other uses of mask grid functions)
-		to this scheme, but at the moment not much code supports it.
+		This parameter (default \verb|"false"|) specifies a
+		new-style excision mask, where a specified bit field
+		in a \verb|CCTK_INT| Cactus grid function is set to
+		one value inside the mask volume, and another value
+		outside.  The bit field is specified by its name,
+		as registered with the \thorn{SpaceMask} thorn.
+		We plan to eventually convert all Cactus excision
+		(and other uses of mask grid functions) to this scheme,
+		but at the moment not much code supports it.
 	\end{description}
 
 \item[%%%