describe the main files in this directory

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

1 files changed, 40 insertions, 0 deletions

diff --git a/src/gr/README b/src/gr/README
new file mode 100644
index 0000000..e44caab
--- /dev/null
+++ b/src/gr/README
@@ -0,0 +1,40 @@
+This directory contains all the code for this thorn which "knows" about
+general relativity.
+
+The main source files in this directory are as follows:
+
+driver.cc
+	Top-level driver for the whole thorn.
+
+horizon_function.cc
+	Computes the LHS of the AH equation, $H = H(h)$.
+
+horizon_Jacobian.cc
+	Computes the Jacobian of the $H(h)$ function, $J[H(h)]$.
+
+AHFinderDirect.hh
+	Overall header file for all the external routines in this directory.
+
+gfn.hh
+	Defines the gfns of all the gridfns.
+
+cg.hh
+	This is a "dangerous" header file which defines the "virtual machine"
+	used by the machine-generated code in ../gr.cg/.
+
+doit.maple
+	Top-level driver for all the Maple code.
+
+setup_gr_gfas.maple
+gr_gfas.minc
+	These files define the relativity gridfns for the Maple code,
+	eg the 3-metric, 3-extrinsic curvature, etc.
+
+auxiliary.maple
+curvature.maple
+horizon.maple
+	These files compute the $H(h)$ function and the $J[H(h)]$
+	coefficients in Maple.
+
+maple.log
+	This is a log file (transcript) of the Maple computation.