change in terminology/notation:

LHS of apparent horizon equation was formerly called $H$,
changed to $\Theta$ because it is in fact precisely the expansion
of the surface r = h(angle).

This implies renaming a lot of variables & functions & a few parameters
(which aren't specified in most par files outside my own for testing this thorn)


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

1 files changed, 22 insertions, 20 deletions

diff --git a/param.ccl b/param.ccl
index eb6c87c..9b8ebe5 100644
--- a/param.ccl
+++ b/param.ccl
@@ -50,11 +50,13 @@ boolean find_AHs_at_poststep \
 keyword method "what should this thorn do for each apparent horizon?"
 {
 # these options are mostly for testing/debugging
-"horizon function"	:: "evaluate the LHS function H(h)"
-"test Jacobian"		:: "compute/print the J[H(h)] Jacobian matrix"
+"evaluate expansion"	  :: "evaluate the LHS function Theta(h)"
+"test expansion Jacobian" :: "compute/print the J[Theta(h)] Jacobian matrix \
+			      (possibly in several ways, depending on \
+			      the  test_all_Jacobian_methods  parameter"
 
 # this is for normal apparent horizon finding
-"find horizon"		:: "find the apparent horizon"
+"find horizon"		  :: "find the apparent horizon"
 } "find horizon"
 
 #
@@ -92,7 +94,7 @@ keyword verbose_level \
 # 1 line for each horizon giving position/mass/area, + a summary line or two
 "physics details"      :: "more detailed physics messages"
 
-# 1 line giving H(h) norms at each Newton iteration
+# 1 line giving Theta(h) norms at each Newton iteration
 "algorithm highlights" :: \
   "physics details + a few messages about the AH-finding algorithm"
 
@@ -169,7 +171,7 @@ boolean test_all_Jacobian_methods \
 ################################################################################
 
 #
-# ***** parameters for the Newton's-method solution of H(h) = 0 *****
+# ***** parameters for the Newton's-method solution of Theta(h) = 0 *****
 #
 
 #
@@ -207,7 +209,7 @@ real max_Delta_h_over_h \
 #
 # we declare convergence if *either* of the following two criteria are met
 #
-real H_norm_for_convergence "declare convergence if ||H||_inf <= this"
+real Theta_norm_for_convergence "declare convergence if ||Theta||_inf <= this"
 {
 (0.0:* :: "any positive real number"
 } 1.0e-8
@@ -222,9 +224,9 @@ real Delta_h_norm_for_convergence \
 # etc.  On the other hand, setting it to true probably only slows down
 # the apparent horizon finder by a few percent.
 #
-boolean final_H_update_if_exit_x_H_small \
-  "should we do a final H(h) update after a h += Delta_h update which is\
-   so small it meets the Delta_h_norm_for_convergence convergence criterion?"
+boolean final_Theta_update_if_Delta_h_converged \
+  "should we do a final Theta(h) update if we terminate the \
+   Newton iteration by the small-||Delta_h|| convergence criterion?"
 {
 } "false"
 
@@ -254,15 +256,15 @@ int how_often_to_output_h \
 
 # setting this > 0 is probably only of interest if the Newton iteration
 # fails to converge, or if you're debugging AHFinderDirect internals
-int how_often_to_output_H_of_h \
-  "how often (in Cactus time steps) should we output the H(h) functions?"
+int how_often_to_output_Theta \
+  "how often (in Cactus time steps) should we output the Theta(h) functions?"
 {
-0   :: "don't output H(h) at all"
+0   :: "don't output Theta(h) at all"
 1:* :: "any integer >= 1"
 } 0
 
 keyword horizon_file_format \
-  "what file format should we use for h and H(h) data files?"
+  "what file format should we use for h and Theta(h) data files?"
 {
 "ASCII (gnuplot)"	:: "simple ASCII format, directly readable by gnuplot"
 "HDF5"			:: "HDF5 surface format (alas not implemented yet)"
@@ -303,10 +305,10 @@ string h_base_file_name \
 .+ :: "any nonempty string"
 } "h"
 
-string H_of_h_base_file_name "base file name for H(h) output file(s)"
+string Theta_base_file_name "base file name for Theta(h) output file(s)"
 {
 .+ :: "any nonempty string"
-} "H"
+} "Theta"
 
 string Delta_h_base_file_name \
   "base file name for horizon-shape-update Delta_h output file(s)"
@@ -368,10 +370,10 @@ boolean output_initial_guess \
 } "false"
 
 # for debugging convergence failures, we can optionally output
-# h, H, and delta_h at each Newton iteration
+# h, Theta, and delta_h at each Newton iteration
 # (the file names are the usual ones with ".it%d" appended)
 boolean debugging_output_at_each_Newton_iteration \
-  "should we output {h, H, delta_h} at each Newton iteration?"
+  "should we output {h, Theta, delta_h} at each Newton iteration?"
 {
 } "false"
 
@@ -419,7 +421,7 @@ real origin_z[5] "global z coordinate of patch system origin"
 } 0.0
 
 #
-# The "(rotating)" patch system types are ok for evaluating H(h),
+# The "(rotating)" patch system types are ok for evaluating Theta(h),
 # but don't work yet for apparent horizon finding
 # (the Jacobian computation doesn't yet grok the nonlocal rotation BCs).
 #
@@ -567,7 +569,7 @@ keyword geometry_method "how do we compute the slice's geometry?"
 # - It must support taking at least 1st derivatives as part of the
 #   interpolation.
 # - It should give at least $C^1$ interpolants for smooth data, otherwise
-#   the H(h) function will have "spikes" and the Newton iteration may
+#   the Theta(h) function will have "spikes" and the Newton iteration may
 #   fail to converge all the way down to tight error tolerances.  $C^2$
 #   would be even better, but in practice a ($C^1$) Hermite interpolant
 #   works well.
@@ -645,7 +647,7 @@ real geometry__Schwarzschild_EF__Delta_xyz \
 #
 # These tests control whether we check that various angular gridfns
 # are finite (neither NaN nor infinity) at various points in evaluating
-# the H(h) function.  These are pretty cheap tests, and they're quite
+# the Theta(h) function.  These are pretty cheap tests, and they're quite
 # useful in catching assorted wierdness, so it's probably worth leaving
 # them enabled unless you're trying to squeeze every last nanosecond...
 #