% *======================================================================* % Cactus Thorn template for ThornGuide documentation % Author: Ian Kelley % Date: Sun Jun 02, 2002 % $Header$ % % Thorn documentation in the latex file doc/documentation.tex % will be included in ThornGuides built with the Cactus make system. % The scripts employed by the make system automatically include % pages about variables, parameters and scheduling parsed from the % relevent thorn CCL files. % % This template contains guidelines which help to assure that your % documentation will be correctly added to ThornGuides. More % information is available in the Cactus UsersGuide. % % Guidelines: % - Do not change anything before the line % % BEGIN CACTUS THORNGUIDE", % except for filling in the title, author, date etc. fields. % - You can define your own macros are OK, but they must appear after % the BEGIN CACTUS THORNGUIDE line, and do not redefine standard % latex commands. % - To avoid name clashes with other thorns, 'labels', 'citations', % 'references', and 'image' names should conform to the following % convention: % ARRANGEMENT_THORN_LABEL % For example, an image wave.eps in the arrangement CactusWave and % thorn WaveToyC should be renamed to CactusWave_WaveToyC_wave.eps % - Graphics should only be included using the graphix package. % More specifically, with the "includegraphics" command. Do % not specify any graphic file extensions in your .tex file. This % will allow us (later) to create a PDF version of the ThornGuide % via pdflatex. | % - References should be included with the latex "bibitem" command. % - For the benefit of our Perl scripts, and for future extensions, % please use simple latex. % % *======================================================================* % % Example of including a graphic image: % \begin{figure}[ht] % \begin{center} % \includegraphics[width=6cm]{MyArrangement_MyThorn_MyFigure} % \end{center} % \caption{Illustration of this and that} % \label{MyArrangement_MyThorn_MyLabel} % \end{figure} % % Example of using a label: % \label{MyArrangement_MyThorn_MyLabel} % % Example of a citation: % \cite{MyArrangement_MyThorn_Author99} % % Example of including a reference % \bibitem{MyArrangement_MyThorn_Author99} % {J. Author, {\em The Title of the Book, Journal, or periodical}, 1 (1999), % 1--16. {\tt http://www.nowhere.com/}} % % *======================================================================* % If you are using CVS use this line to give version information % $Header$ \documentclass{article} \bibliographystyle{alpha} % Use the Cactus ThornGuide style file % (Automatically used from Cactus distribution, if you have a % thorn without the Cactus Flesh download this from the Cactus % homepage at www.cactuscode.org) \usepackage{../../../../doc/ThornGuide/cactus} \begin{document} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % The author of the documentation \author{Jonathan Thornburg \quad {\tt }} % The title of the document (not necessarily the name of the Thorn) \title{Thorn Guide for the {\bf AHFinderDirect} Thorn} % the date your document was last changed, if your document is in CVS, % please us: % \date{$ $Date$ $} \date{$ $Date$ $} \maketitle % Do not delete next line % START CACTUS THORNGUIDE % Add all definitions used in this documentation here % \def\mydef etc %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % misc text stuff \def\text#1{{\rm #1}} % FIXME: standard latex defines this % correctly to give text in math mode, % but cactus.sty breaks it :( :( % ==> redefine it here \def\code#1{\text{\tt #1}} % for formatting code \def\defn#1{``#1''} % definition of a term \def\arrangement#1{{\bf #1}} % name of an arrangement \def\thorn#1{{\bf #1}} % name of a thorn \def\eg{\hbox{eg.\hbox{}}} \def\ie{\hbox{i.e.\hbox{}}} \def\eqref#1{$(\ref{#1})$} % get size/spacing of "++" right, cf online C++ FAQ question 35.1 \def\Cplusplus{\hbox{C\raise.25ex\hbox{\footnotesize ++}}} % misc math mode stuff \def\ltsim{\lesssim} \def\gtsim{\gtrsim} %%\def\tfrac#1#2{{\textstyle \frac{#1}{#2}}} %%\def\dfrac#1#2{{\displaystyle \frac{#1}{#2}}} \def\tfrac#1#2{{\textstyle #1 \over #2}} \def\dfrac#1#2{{\displaystyle #1 \over #2}} \def\thalf{\tfrac{1}{2}} \def\const{{\rm const}} \def\ij{{ij}} \def\uv{{uv}} \def\del{\nabla} \def\I{{\text{\scriptsize I}}} % grid-point index \def\J{{\text{\scriptsize J}}} % grid-point index \def\K{{\text{\scriptsize K}}} % grid-point index \def\M{{\text{\scriptsize M}}} % molecule index \def\Jac[#1]{{\bf J} \bigl[ #1 \bigr]} % discrete Jacobian for fn #1 % Add an abstract for this thorn's documentation \begin{abstract} The \thorn{AHFinderDirect} thorn locates apparent horizons in a numerically computed slice using a direct method, posing the apparent horizon equation as an elliptic PDE on angular-coordinate space. This is very fast and accurate, but requires a ``reasonable'' initial guess. This thorn guide describes how to use the thorn. \end{abstract} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{Introduction} An apparent horizon (also known as a marginally trapped surface), is a closed 2-surface in a slice whose congruence of future-pointing outgoing null geodesics has zero expansion. In terms of the usual $3+1$ variables, an apparent horizon satisfies the equation \begin{equation} H \equiv \del_i n^i + K_\ij n^i n^j - K = 0 \label{AHFinderDirect/eqn-horizon} \end{equation} where $n^i$ is the outward-pointing unit normal to the apparent horizon, and $\del_i$ is the covariant derivative operator associated with the 3-metric $g_\ij$ in the slice. (See \cite{AEIDevelopment_AHFinderDirect_York-1989-in-Frontiers} for a derivation of equation~\eqref{AHFinderDirect/eqn-horizon}.) Thorn~\thorn{AHFinderDirect} finds an apparent horizon by numerically solving equation~\eqref{AHFinderDirect/eqn-horizon}. It requires as input the usual Cactus 3-metric $g_\ij$ and extrinsic curvature $K_\ij$, (and optionally the conformal factor $\psi$ if the \thorn{StaticConformal} metric semantics are used), and produces as output the Cactus $(x,y,z)$ coordinates of a large number of points on the apparent horizon, together with some auxiliary information like the apparent horizon area and centroid position, and the irreducable mass associated with the area. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{What \thorn{AHFinderDirect} Needs} \label{AHFinderDirect/sect-what-AHFinderDirect-needs} There are some restrictions on the spacetime, or more precisely on each slice where you want to find apparent horizons, which are necessary in order for \thorn{AHFinderDirect} to work: \begin{itemize} \item \thorn{AHFinderDirect} requires that the Cactus geometry ($g_{ij}$, $K_{ij}$, and optionally $\psi$) be nonsingular in a neighborhood of the apparent horizon. In particular, this means that it quite certainly will {\em not\/} work for spacetimes/slicings which have a singular geometry on the horizon, such as Schwarzschild/Schwarzschild and Kerr/Boyer-Lindquist.%%% \footnote{%%% Nonsingular slicings of those same spacetimes, such as Schwarzschild/Eddington-Finkelstein, Kerr/Kerr, and Kerr/Kerr-Schild, are fine, and are in fact nice test cases. }%%% \item Less obviously, this also means that if there is a singularity in the geometry somewhere near the apparent horizon, then you need to have a high enough Cactus 3-D grid resolution that the geometry interpolation doesn't ``see'' the singularity. For example, the initial data parameters \begin{verbatim} ADMBase::initial_data = "misner_bh" IDAnalyticBH::mu = 2.0 ADMBase::initial_lapse = "Cadez" \end{verbatim} specify Misner data with $\mu=2$, using the \v{C}ade\v{z} slicing. This geometry has a singularity at $z = \pm 1$ on the $z$~axis. With \verb|grid::dxyz = 0.040| or smaller, \thorn{AHFinderDirect} has no problems finding the apparent horizons (which have centroid $z = \pm 1.03077$ and radia roughtly 0.28), but with \verb|grid::dxyz = 0.050| or larger, \thorn{AHFinderDirect} fails to find the horizon after finding \verb|NaN| and infinity values in the interpolated geometry close to the pole. Another failure mode which \thorn{AHFinderDirect} may report in such a situation (where the Cactus 3-D grid resolution is too low) is that the interpolated $g_{ij}$ fails to be positive definite. \item At the moment \thorn{AHFinderDirect} and the Cactus interpolators don't know how to avoid an excised region, so if the apparent horizon (or any trial horizon surface as the algorithm is iterating towards the apparent horizon) gets too close to an excised region, you'll get garbage results as the interpolator tries to interpolate data from the excised region. I plan to fix this sometime soon. \item \thorn{AHFinderDirect} requires that any apparent horizon it's going to (try to) find must be a \defn{Strahlk\"{o}rper} (literally ``ray body'', or more commonly ``star-shaped region'') relative to some local coordinate origin (which you must specify). A Strahlk\"{o}rper is defined by Minkowski (\cite[p.~108]{AEIDevelopment_AHFinderDirect_Schroeder-1986-number-theory}) as \begin{quote} a region in $n$-dimensional Euclidean space containing the origin and whose surface, as seen from the origin, exhibits only one point in any direction. \end{quote} In other words, using polar spherical coordinates relative to the local coordinate origin, the apparent horizon's shape must be parameterizable as $r = h(\text{angle})$ for some single-value function $h: S^2 \to \Re^+$. (\thorn{AHFinderDirect} uses precisely this parameterization.) \end{itemize} There are also some restrictions on your Cactus configuration and run; here's what works and what doesn't: \begin{itemize} \item I {\em strongly\/} recommend using a current-CVS checkout of the Cactus flesh and of all relevant thorns. I haven't tested \thorn{AHFinderDirect} at all with older versions of the flesh or other thorns. \item Obviously, your Cactus configuration must include \thorn{AHFinderDirect}, and your \code{ActiveThorns} parameter(s) must activate it. \thorn{AHFinderDirect} inherits from \thorn{Grid}, \thorn{ADMBase}, \thorn{SpaceMask}, and \thorn{StaticConformal}, so you'll need those (or more precisely some thorns providing them), too. \item \verb|Grid::domain = "full"|, \verb|"bitant"|, \verb|"quadrant"|, and \verb|"octant"| are supported. Alas, at present rotating (or more precisely nonlocal) symmetry boundary conditions aren't supported. \item The \verb|ADMBase::metric_type| values \verb|"physical"| and \verb|"static conformal"| are supported; for the latter you must have storage turned on for at least the conformal factor \verb|StaticConformal::psi|. (The Cactus 3-D grid functions for 1st and 2nd derivatives of \verb|psi| aren't used.) \item By default \thorn{AHFinderDirect} uses the new \verb|CCTK_InterpGridArrays()| global interpolator API, which in turn uses the new \verb|CCTK_InterpLocalUniform()| local interpolator API. At present these interpolators are only provided by the thorns \thorn{PUGHInterp} and \thorn{LocalInterp} respectively, so you need to have these thorns compiled into your configuration and activated. \item \thorn{AHFinderDirect} works fine in single- or multi-processor Cactus runs. \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} (or even both simultaneously). \end{itemize} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{Obtaining and Compiling \thorn{AHFinderDirect}} You should be able to obtain the source code for this thorn via the usual procedures (\eg{}~cvs checkout); at present it lives in the \arrangement{AEIDevelopment} arrangement. This thorn is written primarily in \Cplusplus{}, calling C and Fortran~77 numerical libraries.%%% \footnote{%%% The (C) code for the relativity computations (\ie{}~the apparent horizon equation itself) is mainly machine-generated from Maple code, which in turn uses a Perl preprocessor. But the machine-generated C code is already in CVS along with the rest of this thorn's source code, so you don't need to have Maple installed unless you want to modify the relativity computations.%%% }%%% {} In theory the code should be quite portable to modern \Cplusplus{} compilers, but in practice I've had a number of portability problems with various compilers. See the ``Code Notes'' and ``Compiler Notes'' sections in the top-level \code{README} file for details and lists of compilers currently known to be ok or not. By default \thorn{AHFinderDirect} doesn't use any external libraries. However, if \code{HAVE\_DENSE\_JACOBIAN\_\_LAPACK} is defined in \code{src/include/config.h}, then \thorn{AHFinderDirect} uses the LAPACK library for solving linear equations. In this case you need to configure Cactus with \code{LAPACK=yes}. See the top-level \code{README} and \code{README.library} files for details on this. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{\thorn{AHFinderDirect} Parameters} This thorn has lots of parameters, but most of them have reasonable default values which you probably won't need to change. Here I describe the parameters which you are likely to want to at least look at, and possibly set explicitly. Note that all of the ``\code{[}$n$\code{]}'' parameters are Cactus array parameters, which you need to specify separately in your parameter file for each apparent horizon. {\bf IMPORTANT: Apparent horizons are numbered starting at 1, not 0!} The example in section~\ref{AHFinderDirect/sect-examples} should make this clear. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \subsection{Overall Parameters} \begin{description} \item[%%% \begin{tabular}{@{}l@{}} \code{find\_AHs\_at\_postinitial} \\ \code{find\_AHs\_at\_poststep} %%%\\ \end{tabular} ] \mbox{}\\ These are Boolean parameters specifying whether \thorn{AHFinderDirect} should try to find apparent horizons in the initial data (at the \code{CCTK\_POSTINITIAL} Cactus schedule bin), at each time step of a time evolution (at the \code{CCTK\_POSTSTEP} Cactus schedule bin), or both (the default). \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 4, but it would be very easy to raise this if desired -- see the comments in \code{param.ccl} for details. }%%% {} {\bf This thorn numbers the apparent horizons from 1 to\ \code{N\_horizons} inclusive.} There are a number of other parameters (described below) which you need to set for of these each apparent horizons. Note that \code{N\_horizons} sets the number of apparent horizons you want to find {\em in the Cactus 3-D numerical grid\/}, not in the whole spacetime. For example, if you are simulating (say) Misner data with \verb|Grid::domain = "bitant"|, with the two throats at (say) roughly $z = \pm 1$, then you should set \verb|N_horizons = 1| to find those two apparent horizons, since you're only finding one apparent horizon within the numerical grid. If you also want to search for a common apparent horizon surrounding both black holes, then you should set \verb|N_horizons = 2|, since you're finding at most 2 apparent horizons within the numerical grid. \item[\code{verbose\_level}] \mbox{}\\ This controls how verbose this thorn is in printing informational (non-error) messages describing what it's doing. In order from tersest to most verbose, the allowable values are \begin{description} \item[\code{"physics highlights"}] \mbox{}\\ Print only a line or two each time \thorn{AHFinderDirect} runs, giving the number of horizons found and their irreducible masses. (This doesn't work yet.) \item[\code{"physics details"}] \mbox{}\\ Give more detailed description of each horizon found, including area, centroid position, and irreducible mass. \item[\code{"algorithm highlights"}] \mbox{}\\ Also print a single line for each Newton iteration giving the 2-norm and $\infty$-norm of the $H(h)$ function defined by equation~\eqref{AHFinderDirect/eqn-horizon}. This is the default. \item[\code{"algorithm details"}] \mbox{}\\ Print lots of detailed messages tracing what the code is doing. \item[\code{"algorithm debug"}] \mbox{}\\ Print even more detailed messages tracing what the code is doing, mainly useful for debugging purposes. \end{description} \end{description} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \subsection{Choosing the Local Coordinate Origin for each Apparent Horizon} \label{AHFinderDirect/sect-parameters/local-coordinate-origin} For each apparent horizon you want to find, you need to specify the Cactus $(x,y,z)$ coordinates of a local coordinate system origin. As described in section~\ref{AHFinderDirect/sect-what-AHFinderDirect-needs}, each apparent horizon must be a Strahlk\"{o}rper with respect to its local coordinate system origin. You specify the local coordinate system origin for each horizon with the (Cactus array) parameters \begin{description} \item[%%% \begin{tabular}{@{}l@{}} \code{origin\_x[}$n$\code{]} \\ \code{origin\_y[}$n$\code{]} \\ \code{origin\_z[}$n$\code{]} %%%\\ \end{tabular} ] \mbox{}\\ These all default to 0.0. In practice, you should set these parameters to be somewhere reasonably close to your best guess for the center of each apparent horizon. These aren't {\em too\/} critical: being off by 1/4 of the horizon radius is no problem, and -- assuming the algorithm still converges -- even 1/2 of the horizon radius only slows the convergence by an extra iteration or two. But poor values of these parameters do make the algorithm more likely to fail to converge. \end{description} At present the local coordinate origin is fixed once you set it; there's no provision for it to move to track a moving black hole. I hope to add such a provision soon.%%% \footnote{%%% This would be along the lines of the \thorn{AHFinder} apparent horizon finder's \code{AHFinder::ahf\_wander = "true"} option. }%%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \subsection{Specifying the Initial Guess} \thorn{AHFinderDirect} requires an initial guess for the apparent horizon's coordinate position and shape (that is, for the $h(\text{angle})$ function defined in section~\ref{AHFinderDirect/sect-what-AHFinderDirect-needs}), for each apparent horizon you want to find. Unlike some other apparent horizon finders (\eg{}~the curvature flow method in \thorn{AHFinder}), for \thorn{AHFinderDirect} there's no restriction on whether the initial guess is inside, outside, or crossing the actual apparent horizon: the only important thing is that it should be ``close''. Just how close the initial guess needs to be for \thorn{AHFinderDirect} to find the (a) apparent horizon depends on the slice and the coordinates, but as a general rule of thumb any initial guess that's within 1/3 to 1/2 of the mean horizon radius will probably work. The ``initial guess'' specification is used the first time we try to find any given apparent horizon, and also any succeeding time when the most recent attempt to find this apparent horizon failed. If we succeed in finding a given apparent horizon, than that apparent horizon position is automatically reused as the initial guess the next time we try to find the same apparent horizon; in this case the explicit ``initial guess'' specification is ignored.%%% \footnote{%%% This is similar to the \thorn{AHFinder} apparent horizon finder's behavior with the \code{AHFinder::ahf\_guessold = "true"} option. }%%% There are a number of parameters for specifying the initial guess: \begin{description} \item[\code{initial\_guess\_method[}$n$\code{]}] \mbox{}\\ This sets what type of the initial guess is used for each apparent horizon position. There are several possibilities, most with their own sets of subparameters:%%% \footnote{%%% The naming scheme for these is similar to that used in the \thorn{Exact} thorn. }%%% $^,$%%% \footnote{%%% For the Kerr parameters, note that this thorn always uses the convention that the spin parameter $a \equiv J/m^2$ is dimensionless. }%%% \begin{description} \item[\code{"read from file"}] \mbox{}\\ This reads the initial-guess $h(\text{angle})$ function from a data file. The file format is currently hard-wired to be that written with \verb|file_format = "ASCII (gnuplot)"| (see below). \item[\code{"Kerr/Kerr"}] \mbox{}\\ This sets the initial guess to the analytically-known apparent horizon position in a Kerr spacetime in Kerr coordinates; there are subparameters \begin{description} \item[%%% \begin{tabular}{@{}l@{}} \code{initial\_guess\_\_Kerr\_Kerr\_\_x\_posn[}$n$\code{]} \\ \code{initial\_guess\_\_Kerr\_Kerr\_\_y\_posn[}$n$\code{]} \\ \code{initial\_guess\_\_Kerr\_Kerr\_\_z\_posn[}$n$\code{]} %%%\\ \end{tabular}%%% ] \mbox{}\\ to set the position of the Kerr black hole (note this position is in {\em global\/} Cactus coordinates, not relative to the local coordinate origin), and \item[%%% \begin{tabular}{@{}l@{}} \code{initial\_guess\_\_Kerr\_Kerr\_\_mass[}$n$\code{]} \\ \code{initial\_guess\_\_Kerr\_Kerr\_\_spin[}$n$\code{]} %%%\\ \end{tabular}%%% ] \mbox{}\\ to set its mass and spin. \end{description} \item[\code{"Kerr/Kerr-Schild"}] \mbox{}\\ This sets the initial guess to the analytically-known apparent horizon position in a Kerr spacetime in Kerr-Schild coordinates; there are subparameters \begin{description} \item[%%% \begin{tabular}{@{}l@{}} \code{initial\_guess\_\_Kerr\_KerrSchild\_\_x\_posn[}$n$\code{]} \\ \code{initial\_guess\_\_Kerr\_KerrSchild\_\_y\_posn[}$n$\code{]} \\ \code{initial\_guess\_\_Kerr\_KerrSchild\_\_z\_posn[}$n$\code{]} %%%\\ \end{tabular}%%% ] \mbox{}\\ (note this position is in {\em global\/} Cactus coordinates, not relative to the local coordinate origin), and \item[%%% \begin{tabular}{@{}l@{}} \code{initial\_guess\_\_Kerr\_KerrSchild\_\_mass[}$n$\code{]} \\ \code{initial\_guess\_\_Kerr\_KerrSchild\_\_spin[}$n$\code{]} %%%\\ \end{tabular}%%% ] \mbox{}\\ to set its mass and spin. \end{description} \item[\code{"coordinate sphere"}] \mbox{}\\ This sets the initial guess to a coordinate sphere; there are subparameters \begin{description} \item[%%% \begin{tabular}{@{}l@{}} \code{initial\_guess\_\_coord\_sphere\_\_x\_center[}$n$\code{]} \\ \code{initial\_guess\_\_coord\_sphere\_\_y\_center[}$n$\code{]} \\ \code{initial\_guess\_\_coord\_sphere\_\_z\_center[}$n$\code{]} %%%\\ \end{tabular}%%% ] \mbox{}\\ (note this position is in {\em global\/} Cactus coordinates, not relative to the local coordinate origin), and \item[\code{initial\_guess\_\_coord\_sphere\_\_radius[}$n$\code{]}] \mbox{}\\ to set the radius. \end{description} \item[\code{"coordinate ellipsoid"}] \mbox{}\\ This sets the initial guess to a coordinate ellipsoid; there are subparameters \begin{description} \item[%%% \begin{tabular}{@{}l@{}} \code{initial\_guess\_\_coord\_ellipsoid\_\_x\_center[}$n$\code{]} \\ \code{initial\_guess\_\_coord\_ellipsoid\_\_y\_center[}$n$\code{]} \\ \code{initial\_guess\_\_coord\_ellipsoid\_\_z\_center[}$n$\code{]} %%%\\ \end{tabular}%%% ] \mbox{}\\ (note this position is in {\em global\/} Cactus coordinates, not relative to the local coordinate origin), and \item[%%% \begin{tabular}{@{}l@{}} \code{initial\_guess\_\_coord\_ellipsoid\_\_x\_radius[}$n$\code{]} \\ \code{initial\_guess\_\_coord\_ellipsoid\_\_y\_radius[}$n$\code{]} \\ \code{initial\_guess\_\_coord\_ellipsoid\_\_z\_radius[}$n$\code{]} %%%\\ \end{tabular}%%% ] \mbox{}\\ to set the radia (semimajor axes). \end{description} \end{description} \end{description} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \subsection{I/O Parameters for the Apparent Horizon Shape(s)} The main output of this thorn is the computed horizon shape function $h({\rm angle})$, and correspondingly the $(x,y,z)$ coordinate positions of the apparent-horizon-surface (angular) grid points. There are several parameters controlling if, how often, and how these should be written to data files: \begin{description} \item[\code{how\_often\_to\_output\_h}] \mbox{}\\ If \verb|find_AHs_at_poststep| is set to true, \thorn{AHFinderDirect} will try to find the apparent horizon(s) at every time step. However, you can control how often (if at all) the apparent horizon shape(s) are written to data files: this is only done if \verb|how_often_to_output_h| is nonzero, and the Cactus time step number \verb|cctk_iteration| is an integral multiple of this parameter. \item[\code{file\_format}] \mbox{}\\ This specifies the file format for $h$ (and other angular-grid-function) data files. Unfortunately, at the moment only a single format is implemented, \begin{description} \item[\code{"ASCII (gnuplot)"}] \mbox{}\\ This is a simple ASCII format designed for easy plotting with gnuplot: \begin{itemize} \item \thorn{AHFinderDirect} writes a separate data file for each Cactus time step and for each apparent horizon found. By default these are all written in the starting directory of the Cactus run. (I plan to change this at some point to use the \verb|IOUtil::out_dir| directory.) \item The time step number and the apparent horizon number are both encoded in the file name; the actual file name is given by a \verb|printf()| format \verb|"%s.t%d.ah%d.%s"|, where \begin{itemize} \item the first \verb|%s| is the base file name set by the \verb|h_base_file_name| parameter (see below) \item the first \verb|%d| is the Cactus time step number \item the second \verb|%d| is the apparent horizon number \item the second \verb|%s| is the file name extension, set by the \verb|ASCII_gnuplot_file_name_extension| parameter; this defaults to \verb|"gp"| \end{itemize} \item Comment lines begin with \verb|#|. \item Patches are separated by 2 blank lines; rows of apparent-horizon points within a patch are separated by single blank lines. \item Each apparent-horizon-surface point is described by a single line, containing the whitespace-separated fields \begin{itemize} \item Two ``unwrapped'' angular coordinates in degrees, representing a point on $S^2$. \item The $h$ value, giving the radius of the apparent horizon surface at that angle. \item The corresponding Cactus $(x,y,z)$ coordinates. \end{itemize} \end{itemize} Given such a data file \verb|"h.dat"|, the gnuplot command \begin{verbatim} splot 'h.dat' \end{verbatim} will plot the $h(\text{angle})$ function, with the $x$ and $y$ axes of the plot being the two ``unwrapped'' angular coordinates on $S^2$, in degrees, and the $z$ axis being $h(\text{angle})$. The gnuplot command \begin{verbatim} splot 'h.dat' using 4:5:6 \end{verbatim} will plot the apparent horizon surface in 3-D. \end{description} \item[\code{h\_base\_file\_name}] \mbox{}\\ This specifies the base file name for $h$ data files, as described above. This defaults to "h". \item[\code{ASCII\_gnuplot\_file\_name\_extension}] \mbox{}\\ This specifies the file name extension for $h$ data files, as described above. This defaults to "gp". \end{description} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \subsection{Other I/O Parameters} As well as the apparent horizon shape files, this thorn can also write files giving time series of various diagnostics. These are controlled by the following parameters: \begin{description} \item[\code{output\_BH\_diagnostics}] \mbox{}\\ If this Boolean parameter is set to true, \thorn{AHFinderDirect} will write a ``black hole diagnostics'' file for each distinct apparent horizon found (up to \verb|N_horizons| files in all). Each such file contains a time series of various diagnostics for all time steps when the corresponding apparent horizon was found. The file format is again a simple ASCII format designed for easy plotting with gnuplot: \begin{itemize} \item The apparent horizon number is encoded in the file name; the actual file name is given by a \verb|printf()| format \verb|"%s.ah%d.%s"|, where \begin{itemize} \item the first \verb|%s| is the base file name set by the \verb|BH_diagnostics_base_file_name| parameter (see below); this defaults to \verb|"BH_diagnostics"| \item the \verb|%d| is the apparent horizon number \item the second \verb|%s| is the file name extension, set by the \verb|BH_diagnostics_file_name_extension| parameter; this defaults to \verb|"gp"| \end{itemize} \item The file begins with a block of header comments (lines begining with \verb|#|) describing the data fields. \item Each time this apparent horizon is found, a single line is appended to the data file, containing various whitespace-separated fields. The the precise list of fields, see the header comments, or see the function \verb|output()| in \verb|src/driver/BH_diagnostics.cc|. As of this writing the fields are: \begin{itemize} \item the Cactus iteration number \verb|cctk_iteration| \item the Cactus time coordinate \verb|cctk_time| \item the Cactus $(x,y,z)$ coordinates of the apparent horizon centroid \item the minimum, maximum, and mean radia of the apparent horizon about the local coordinate origin \item the minimum and maximum Cactus $x$, $y$, and $z$ coordinates of the apparent horizon surface \item the $xy$, $xz$, and $yz$-plane circumferences of the apparent horizon%%% \footnote{%%% Alas, these are computed using the $xy$, $xz$, and $yz$-planes passing through the local coordinate origin, so they may be considerably different (smaller) than the actual circumferences if the apparent horizon is displaced significantly from the local coordinate origin. }%%% \item the area of the apparent horizon, $A$ \item the irreducible mass of the apparent horizon, $\sqrt{A/16\pi}$ \end{itemize} \end{itemize} \item[\code{BH\_diagnostics\_base\_file\_name}] \mbox{}\\ This specifies the base file name for black hole diagnostics data files, as described above. This defaults to \verb|"BH_diagnostics"|. \item[\code{BH\_diagnostics\_file\_name\_extension}] \mbox{}\\ This specifies the file name extension for black hole diagnostics data files, as described above. This defaults to \verb|"gp"|. \end{description} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \subsection{(Excision) Mask Parameters} 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}] \mbox{}\\ If this Boolean parameter is set to true, \thorn{AHFinderDirect} will set a mask grid function. This parameter defaults to false (don't set a mask). \item[%%% \begin{tabular}{@{}l@{}} \code{mask\_radius\_multiplier[}$n$\code{]} \\ \code{mask\_radius\_offset[}$n$\code{]} %%%\\ \end{tabular} ] \mbox{}\\ If we set a mask, we do so based on a \defn{mask volume} for each horizon. This is defined by \begin{equation} r(\rho,\sigma) = \verb|mask_radius_multiplier| \times h(\rho,\sigma) \,\,+\,\, \verb|mask_radius_offset| \times \Delta x \end{equation} where $(\rho,\sigma)$ are generic angular coordinates on the horizon surface, $h(\rho,\sigma)$ gives the horizon radius, $\Delta x$ is the Cactus grid spacing%%% \footnote{%%% More precisely, $\Delta x$ is the geometric mean of the $x$, $y$, and $z$ Cactus grid spacings.%%% }%%% , and $r(\rho,\sigma)$ gives the radius of the mask volume. The default values are $\verb|mask_radius_multiplier| = 0.9$ and $\verb|mask_radius_offset| = -5.0$ for each $n$, giving a ``buffer zone'' (between the mask volume and the horizon) of 20\% of the horizon radius, plus an extra 5~Cactus grid spacings. Note that the sign convention here is that \verb|mask_radius_multiplier| is {\em multiplied\/} by the horizon radius, then \verb|mask_radius_offset| (scaled by the Cactus grid spacing) is {\em added\/}. Thus for use with excision (where the mask region should be somewhat {\em inside\/} the horizon), you should choose \verb|mask_radius_multiplier| to be a positive real number slightly less than 1.0, and \verb|mask_radius_offset| a negative real number.%%% \footnote{%%% As another example, if you were to choose $\code{mask\_radius\_multiplier} = 1.0$ and $\code{mask\_radius\_offset} = 0.0$ then the mask volume would be precisely the horizon's interior (\ie{} there would be no buffer zone), so all Cactus grid points inside/outside the horizon would be set to the ``inside''/``outside'' states respectively. }%%% \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; these Boolean parameters choose which of them you want to set: \begin{description} \item[\code{set\_old\_style\_mask}] \mbox{}\\ 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 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. Note that \thorn{AHFinderDirect} doesn't itself set up any bit fields -- you must arrange for some other thorn(s) to do this. \end{description} \item[%%% \begin{tabular}{@{}l@{}} \code{old\_style\_mask\_gridfn\_name} \\ \code{old\_style\_mask\_inside\_value} \\ \code{old\_style\_mask\_outside\_value} %%%\\ \end{tabular} ] \mbox{}\\ If \verb|mask_type| is set to \verb|"old-style (CCTK_REAL)"|, these parameters specify the mask grid function's name and the (\verb|CCTK_REAL|) ``inside'' and ``outside'' values respectively. \item[%%% \begin{tabular}{@{}l@{}} \code{new\_style\_mask\_gridfn\_name} \\ \code{new\_style\_mask\_inside\_state\_name} \\ \code{new\_style\_mask\_outside\_state\_name} %%%\\ \end{tabular} ] \mbox{}\\ If \verb|mask_type| is set to \verb|"new-style (CCTK_INT)"|, these parameters specify the mask grid function's name, and the ``state'' names for ``inside'' and ``outside'' values as registered with the \thorn{SpaceMask} thorn. Note that at present \thorn{AHFinderDirect} only converts these character strings into integer bit masks once, in its startup routine. This may change at some point to (re-)doing the conversion at each horizon finding; this would work better if the string names aren't registered until after \thorn{AHFinderDirect}'s startup routine runs. \end{description} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \subsection{Other Parameters} \begin{description} \item[\code{N\_zones\_per\_right\_angle[}$n$\code{]}] \mbox{}\\ This parameter sets the angular resolution used to compute each patch. The units are the number of angular grid zones per right angle. The default is 18, \ie{} a 5~degree angular resolution. There's no problem with this parameter varying from one horizon to another, but for simplicity it should be even.%%% \footnote{%%% More precisely, it {\em must\/} be even for any horizon whose patch system type is anything other than {\tt "full sphere"}. See the comments in {\tt param.ccl} for further information.%%% }%%% {} For any horizon which is close to spherical about its local coordinate origin, you can lower this parameter to make \thorn{AHFinderDirect} run faster (typical run-times scale roughly as the cube of this parameter); 6~is about the minimum reasonable value. For any horizon which is highly non-spherical about its local coordinate origin, you can raise this parameter to get better resolution; 30~should be enough for even a highly non-spherical horizon. \end{description} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{Accuracy} The apparent horizon positions are typically computed very accurately; tests on Kerr spacetimes give typical errors of $10^{-4}m$ to $10^{-5}m$. The various diagnostics printed to standard output and written to the black hole diagnostics file(s), are typically computed to accuracies on the order of a part per million or so. Note, however, that the irreducible mass $m_\text{irreducible}$ may differ considerably from the black hole's local mass or its contribution to the slice's ADM mass. For example, for Kerr spacetime in Kerr-Schild coordinates, $m_\text{irreducible}/m_\text{ADM} = 0.949$, $0.894$, and $0.723$ for spin parameters $a \equiv J/m^2 = 0.6$, $0.8$, and $0.999$, respectively. It would be better to (also) use the ``isolated horizons'' formalism of \cite{AEIDevelopment_AHFinderDirect_Dreyer-etal-2002-isolated-horizons}; at some point this thorn may be enhanced to do this. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{Examples} \label{AHFinderDirect/sect-examples} There are a few example parameter files in the \code{par/} directory, including Kerr initial data, Misner initial data, and Misner time-evolution tests. The \verb|Kerr-tiny.par| parameter file is close to a minimal \thorn{AHFinderDirect} example: \begin{verbatim} # This parameter file sets up Kerr/Kerr-Schild initial data, then # finds the apparent horizon in it. The local coordinate system origin # and the initial guess are both deliberately de-centered with respect # to the black hole, to make this a non-trivial test for the apparent # horizon finder. # # This parameter file is "tiny" in the sense that it sets only a # small number of AHFinderDirect parameters. # next two lines is actually one long line # (Cactus doesn't seem to grok \-newline continuation here :( :( ) ActiveThorns = "CartGrid3D LocalInterp PUGH ADMBase ADMCoupling \ StaticConformal CoordGauge Exact AHFinderDirect" # flesh cactus::cctk_itlast = 0 # PUGH driver::ghost_size = 2 driver::global_nx = 31 driver::global_ny = 31 driver::global_nz = 17 # CartGrid3D grid::domain = "bitant" grid::avoid_origin = "false" grid::type = "byspacing" grid::dxyz = 0.2 # ADMBase ADMBase::initial_lapse = "exact" ADMBase::initial_shift = "exact" ADMBase::initial_data = "exact" ADMBase::lapse_evolution_method = "static" ADMBase::shift_evolution_method = "static" ADMBase::metric_type = "physical" # Exact Exact::exact_model = "Kerr/Kerr-Schild" Exact::Kerr_KerrSchild__mass = 1.0 Exact::Kerr_KerrSchild__spin = 0.6 ######################################## AHFinderDirect::find_AHs_at_poststep = "false" # no time evolution AHFinderDirect::h_base_file_name = "Kerr-tiny.h" AHFinderDirect::N_horizons = 1 AHFinderDirect::origin_x[1] = 0.5 AHFinderDirect::origin_y[1] = 0.7 AHFinderDirect::origin_z[1] = 0.0 AHFinderDirect::initial_guess_method[1] = "coordinate sphere" AHFinderDirect::initial_guess__coord_sphere__x_center[1] = -0.2 AHFinderDirect::initial_guess__coord_sphere__y_center[1] = 0.3 AHFinderDirect::initial_guess__coord_sphere__z_center[1] = 0.0 AHFinderDirect::initial_guess__coord_sphere__radius[1] = 2.0 \end{verbatim} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{How \thorn{AHFinderDirect} Works} \label{AHFinderDirect/sect-how-ahfinderdirect-works} \thorn{AHFinderDirect} uses the apparent horizon (henceforth \defn{horizon}) finding algorithm of \cite{AEIDevelopment_AHFinderDirect_Thornburg-1996-apparent-horizon-finding}, modified slightly to work with $g_\ij$ and $K_\ij$ on a Cartesian ($xyz$) grid: %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \subsection{General Description of the Algorithm} As described above, I parameterizes the horizon shape by $r = h(\text{angle})$ for some single-value function $h: S^2 \to \Re^+$. The apparent horizon equation~\eqref{AHFinderDirect/eqn-horizon} then becomes a 2-D elliptic PDE on $S^2$ for the function $h$. I finite difference this in angle to obtain a system of simultaneous nonlinear algebraic equations for $h$ at the angular grid points, and solve this system of equations by a global Newton's method (or a variant with improved convergence). Computationally, this algorithm has 3 main parts: \begin{itemize} \item Computation of the ``horizon function'' $H(h)$ given a trial surface defined by a trial horizon shape function $h$. This is done by interpolating%%% \footnote{%%% It's this interpolation that causes the multiprocessor slowdown with the present implementation -- each processor asks for the same set of interpolation points, so for $N$ processors the interpolator has to do $N$ times as much work. Unfortunately, the (global) interpolator must be called synchronously on all processors, so fixing this inefficiency requires a nontrivial interprocessor synchronization at each iteration of the Newton iteration (to ensure that all processors make the same number of Newton iterations).%%% }%%% {} the Cactus geometry fields $g_\ij$ and $K_\ij$ (and optionally $\psi$) from the 3-D $xyz$ grid to the (2-D set of) trial-horizon-surface grid points (also computing $\partial_k g_\ij$ in the interpolation process), then doing all further computations with angular grid functions defined solely on $S^2$ (\ie{} at the horizon-surface grid points). \item Computation of the Jacobian matrix $\Jac[H(h)]$ of $H(h)$. This thorn incorporates the \defn{symbolic differentiation} technique described in \cite{AEIDevelopment_AHFinderDirect_Thornburg-1996-apparent-horizon-finding}, so this computation is quite fast. The Jacobian is a highly sparse matrix; \thorn{AHFinderDirect} has code to store it as either a dense matrix (for debugging purposes), or a sparse matrix (the default). Which option is used is determined by a compile-time configuration in \verb|src/include/config.h|. \item Solving the nonlinear equations $H(h) = 0$ by a global Newton's method or a variant. How this is done depends on how the Jacobian is stored. At present, \begin{itemize} \item If \thorn{AHFinderDirect} is configured to store the Jacobian as a dense matrix, then LAPACK is used to solve the linear equations. \item If \thorn{AHFinderDirect} is configured to store the Jacobian as a sparse matrix, then an incomplete-$\sf LU$-decomposition--conjugate-gradient solver is used. \end{itemize} By default only the sparse-matrix code is configured, so LAPACK isn't used and there's no need to link with the LAPACK library. \end{itemize} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \subsection{The Multipatch System} \label{AHFinderDirect/sect-multipatch-system} Perhaps the most unusual feature of \thorn{AHFinderDirect} is the ``multipatch'' system used to cover $S^2$ without coordinate singularities. In general there are 6~patches, one each covering a neighborhood of the $\pm z$, $\pm x$, and $\pm y$ axes, but this may be reduced in the presence of suitable symmetries. For example, figure~\ref{AHFinderDirect/fig-3patch} on page~\pageref{AHFinderDirect/fig-3patch} shows a system of 3~patches covering the $+xyz$~octant of $S^2$. This would be suitable for finding an apparent horizon with mirror symmetry about the (local) $z=0$~plane, and either 90~degree periodic rotation symmetry about the (local) $z$~axis, or mirror symmetry about each of the (local) $x$~and $y$~axes. \begin{figure}[htbp] \begin{center} \includegraphics{AEIDevelopment_AHFinderDirect_3patch.eps} \end{center} \caption[Illustration of the Multipatch System] { This figure shows a multipatch system covering the $(+,+,+)$~octant of the unit sphere~$S^2$ with 3~patches. The angular resolution is 5~degrees. Notice that the patches overlap by several ``ghost zone'' grid points. } \label{AHFinderDirect/fig-3patch} \end{figure} To allow easy angular finite differencing within the patch system, each patch is extended beyond its nominal extent by a ``ghost zone''%%% \footnote{%%% Note that this terminology differs somewhat from that used by Cactus in general; Cactus would call these ``patch zones'' or ``symmetry zones''. }%%% {} (2~grid points wide in figure~\ref{AHFinderDirect/fig-3patch}). Angular grid function values in the ghost zone can be obtained by interpatch interpolation%%% \footnote{%%% Due to the way the patch coordinates are defined, adjacent patches always share a common ``perpendicular'' angular coordinate, so only 1-D interpolation is needed here. }%%% {} or by applying symmetry operations. Once this is done, then angular finite differencing within the nominal extent of each patch can proceed normally, ignoring the patch boundaries. \thorn{AHFinderDirect} can be configured at compile time to use either 2nd~order or 4th~order angular finite differencing (3~point or 5~point angular molecules); the default is 4th~order (5~point). This is configured at compile time in \verb|src/include/config.h|. By default \thorn{AHFinderDirect} will automagically choose a patch system type for each apparent horizon searched for, based on the local coordinate origin and the symmetries implicit in the Cactus grid type. This generally works well, but if desired you can instead manually specify the patch system type, the angular resolution, the width of the ghost zones, etc. See the \verb|param.ccl| file for details. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{Other Related Thorns} If you're interested in \thorn{AHFinderDirect}, you might also be interested in some other related thorns: \begin{description} \item[\thorn{EHFinder}] (in the \arrangement{AEIDevelopment} arrangement) was written by Peter Diener, and finds the {\em event\/} horizon(s) in a numerically computed spacetime. \item[\thorn{AHFinder}] (in the \arrangement{CactusEinstein} arrangement) was written by Miguel Alcubierre, and includes two different algorithms for finding apparent horizons, a minimization method and a ``fast flow'' method based on \cite{AEIDevelopment_AHFinderDirect_Gundlach-1998-apparent-horizon-finding}. Unfortunately, both methods are very slow in practice. \item[\thorn{TGRapparentHorizon2D}] (in the \arrangement{TAT} arrangement) was written by Erik Schnetter, and is another apparent horizon finder. It uses methods very similar to this thorn, and (like this thorn) is very fast and accurate. \end{description} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{Acknowledgments} I thank Ian Hawke, Peter Diener, and Erik Schnetter for many valuable conversations, to Thomas Radke for his work on the new interpolators, and the whole Cactus crew for a great infrastructure! I thank the Alexander von Humboldt foundation and the AEI visitors' and postdoctoral fellowships programs for financial support. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % make LaTeX read in ahfinderdirect.bbl produced by bibtex % run 'make bib' in this directory to update this \bibliography{ahfinderdirect} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % Do not delete next line % END CACTUS THORNGUIDE \end{document}