aboutsummaryrefslogtreecommitdiff
path: root/README
blob: a057383c7411678e3a3a3d450b2884956da9ee4e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
Cactus Code Thorn AHFinderDirect
Authors    : Jonathan Thornburg <jthorn@aei.mpg.de>
Maintainer : Jonathan Thornburg <jthorn@aei.mpg.de>
CVS info   : $Header$
--------------------------------------------------------------------------

Purpose of the thorn
====================

This thorn finds an apparent horizon given the 3D xyz-grid metric and
extrinsic curvature.  It uses a direct method, writing the apparent
horizon equation as an elliptic PDE on angular-coordinate space.  This
is fast, but does require an intitial guess for the apparent horizon
position.


Documentation
=============

The doc/ directory contains detailed documentation for this thorn.
There are also a lot of comments in the param.ccl file on how to set
the (many) parameters.


Distribution
============

This thorn should eventually become part of the CactusEinstein arrangement.


Copyright
=========

This thorn is copyright (C) 2001 by Jonathan Thornburg <jthorn@aei.mpg.de>.

This thorn is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This thorn is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this thorn (see the file COPYING in this directory);
if not, write to the Free Software Foundation, Inc., 59 Temple
Place, Suite 330, Boston, MA  02111-1307  USA


Other Software Required
=======================

* This thorn requires the Einstein thorn.  (More accurately, it requires
  various grid functions which are computed by the Einstein thorn.)
* This thorn uses the new CCTK_InterpLocalUniform() interpolator API, which
  at present is only supplied by the CactusBase/InterpLocal thorn.
* This thorn is written in C++, so you'll need a C++ compiler to compile
  this thorn.  (See the thorn guide for details.)  It calls the LAPACK
  library (which in turn calls the BLAS library) for solving linear equations.
  Before compilation you have to set the environment variable LAPACK_DIR
  to give the directory in which to find the LAPACK and BLAS libraries.
  On the AEI xeons this is
     export LAPACK_DIR=/usr/bin			# bash
     setenv LAPACK_DIR /usr/bin			# csh,tcsh
* Most of this thorn's relativity code is machine-generated using Maple
  (version 7), but you don't need Maple unless you want to modify the
  relativity code.