From fe4e962d3e30527e164e194af8f360c701134e04 Mon Sep 17 00:00:00 2001 From: jthorn Date: Fri, 9 Jun 2006 10:58:42 +0000 Subject: redo the way mask-setting is scheduled: it's now inside two new groups group_for_mask_stuff group_where_mask_is_set so other thorns (like AEIDevelopment/PreviousMask) can schedule stuff in group_for_mask_stuff before/after group_where_mask_is_set git-svn-id: http://svn.einsteintoolkit.org/cactus/EinsteinAnalysis/AHFinderDirect/trunk@1456 f88db872-0e4f-0410-b76b-b9085cfa78c5 --- doc/documentation.tex | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/documentation.tex b/doc/documentation.tex index 21785a9..be8db7c 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -334,7 +334,7 @@ section~\ref{AHFinderDirect/sect-parameters/communicating-with-other-thorns}. \section{Obtaining and Compiling \thorn{AHFinderDirect}} You should be able to obtain the source code for this thorn via the -usual procedures for anonymous cvs checkout; at present it lives inu +usual procedures for anonymous cvs checkout; at present it lives in the \arrangement{AEIThorns} arrangement. This thorn is written primarily in \Cplusplus{}, calling C and @@ -1151,6 +1151,24 @@ Note that \thorn{AHFinderDirect} doesn't itself register any bitfields or states with \thorn{SpaceMask} -- you must arrange for some other thorn(s) to do this before \thorn{AHFinderDirect} tries to find the horizon(s). +If \thorn{AHFinderDirect} sets a mask or masks, this happens in the +same schedule bin(s) as the horizon finding +(see section~\ref{AHFinderDirect/sect-parameters/other-parameters} +for a discussion of the parameters which control this). +More precisely, \thorn{AHFinderDirect} creates two schedule groups +for this purpose: +\begin{itemize} +\item The schedule group \verb|group_for_mask_stuff| is + scheduled to run just after the horizon is found. +\item The schedule group \verb|group_where_mask_is_set| + is scheduled in (the schedule group) \verb|group_for_mask_stuff|. +\item The actual setting of the mask is scheduled in + (the schedule group) \verb|group_where_mask_is_set|. +\end{description} +Thorn \thorn{PreviousMask} uses these schedule groups to keep a +``previous'' as well as a ``current'' mask. See that thorn's thorn +guide for further details. + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \subsection{Communicating with Other Thorns} -- cgit v1.2.3