describe files in this directory

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

1 files changed, 35 insertions, 0 deletions

diff --git a/src/driver/README b/src/driver/README
new file mode 100644
index 0000000..afb8154
--- /dev/null
+++ b/src/driver/README
@@ -0,0 +1,35 @@
+This directory contains top-level routines to find the apparent horizon
+and interface with the rest of Cactus.
+
+The main source files in this directory are as follows:
+
+AHFinderDirect.hh
+	overall header file for routines in this directory
+
+state.cc
+	state information (data structures) kept across Cactus scheduler calls
+
+setup.cc
+	this is called from the scheduler to setup our data structures
+
+initial_guess.cc
+	this is called from the scheduler to set the initial guess(es) for
+	the horizon position(s)
+
+find_horizons.cc
+	this is called from the scheduler to find the apparent horizon(s)
+	in a slice
+
+ellipsoid.maple
+	this is a Maple script to compute the intersection of a given
+	ray with an ellipsoid; this is used in setting up the initial guess
+ellipsoid.c
+	this is the Maple-generated code from "ellipsoid.maple"
+ellipsoid.log
+	this is the standard output from running "ellipsoid.maple"
+
+Newton.cc
+	this solves the H(h) = 0 equations by Newton's method
+
+io.cc
+	I/O routines