demo par files

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

1 files changed, 16 insertions, 0 deletions

diff --git a/par/README b/par/README
new file mode 100644
index 0000000..0f3f353
--- /dev/null
+++ b/par/README
@@ -0,0 +1,16 @@
+This directory contains sample parameter files.
+
+Kerr.par is a good one to start with if you want a simple example
+of AHFinderDirect usage.  It's my standard "sanity-check" test case
+for AHFinderDirect, and runs in a < 10 seconds on a laptop.  It sets
+up Kerr/Kerr-Schild initial data and finds the apparent horizon in
+it, with the coordinate origin and initial guess offset to make this
+a nontrivial test of the apparent horizon finder.
+
+misner-init.par is another fairly simple parameter file, which sets up
+Misner initial data and then finds the apparent horizons in it.
+
+misner-run.par is a more complicated parameter file, which sets up the
+same Misner initial data, but now time-evolves it, finding the apparent
+horizons at each time step.  (It also runs AHFinder every 20 time steps
+for comparison.)  It takes a lot of cpu and memory to run.