Introduce parameters to control whether this thorn does everything

in CCTK_ANALYSIS (which has historically been the case, and remains
the default after this commit) or CCTK_POSTSTEP (which sometimes
comes in handy).

There should be no user-visible change in behavior from this commit.


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

1 files changed, 34 insertions, 17 deletions

diff --git a/param.ccl b/param.ccl
index 0397ba6..83d726a 100644
--- a/param.ccl
+++ b/param.ccl
@@ -51,6 +51,23 @@ int find_every "how often should we try to find apparent horizons?"
 1:* :: "any integer >= 1"
 } 1
 
+#
+# These parameters control which schedule bin (or even bins, if you
+# want) AHFinderDirect runs in.  Historically, AHFinderDirect has run
+# at CCTK_ANALYSIS.  However, for some purposes it's more convenient
+# to run at CCTK_POSTSTEP.
+#
+Boolean run_at_CCTK_ANALYSIS "should we run in CCTK_ANALYSIS schedule bin?"
+{
+} "true"
+Boolean run_at_CCTK_POSTSTEP "should we run in CCTK_POSTSTEP schedule bin?"
+{
+} "false"
+
+#
+# unless you're trying to debug AHFinderDirect, you should leave
+# at its default value
+#
 keyword method "what should this thorn do for each apparent horizon?"
 {
 # these options are mostly for testing/debugging
@@ -145,7 +162,7 @@ keyword verbose_level \
 } "algorithm highlights"
 
 # n.b. printing timing stats is independent of  verbose_level
-boolean print_timing_stats \
+Boolean print_timing_stats \
   "should we print timing stats for the whole apparent-horizon-finding process?"
 {
 } "false"
@@ -311,7 +328,7 @@ real initial_guess__coord_ellipsoid__z_radius[101] "z radius of ellipsoid"
 # - each line contains various tab-separated fields, as described by
 #   the header comment
 #
-boolean output_BH_diagnostics \
+Boolean output_BH_diagnostics \
   "should we output BH diagnostics to a data file for each AH found?"
 {
 } "true"
@@ -383,7 +400,7 @@ keyword horizon_file_format \
 
 # n.b. this refers to the patch system (angular) interpatch ghost zones,
 #      *not* the Cactus interprocessor ghost zones
-boolean output_ghost_zones_for_h \
+Boolean output_ghost_zones_for_h \
   "should we include the patch system (angular) interpatch ghost zones \
    in h data files?"
 {
@@ -453,7 +470,7 @@ string Delta_h_base_file_name \
 # - the %d is the apparent horizon number
 # - the third %s is the file name extension OpenDX_control_file_name_extension
 #
-boolean output_OpenDX_control_files \
+Boolean output_OpenDX_control_files \
   "should we output OpenDX control files to allow reading of AHFinderDirect \
    'ASCII (gnuplot)' format data files?"
 {
@@ -471,7 +488,7 @@ string OpenDX_control_file_name_extension \
 #
 
 # this is mainly useful for debugging purposes
-boolean output_initial_guess \
+Boolean output_initial_guess \
   "should we output the initial guess back to the h data file?"
 {
 } "false"
@@ -479,7 +496,7 @@ boolean output_initial_guess \
 # for debugging convergence failures, we can optionally output
 # 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 \
+Boolean debugging_output_at_each_Newton_iteration \
   "should we output {h, Theta, delta_h} at each Newton iteration?"
 {
 } "false"
@@ -496,12 +513,12 @@ string Jacobian_base_file_name "base file name for Jacobian output file(s)"
 # ***** based on each apparent horizon shape *****
 #
 
-boolean set_mask_for_all_horizons \
+Boolean set_mask_for_all_horizons \
   "should we set a mask grid function (or functions) for all horizons?"
 {
 } "false"
 
-boolean set_mask_for_individual_horizon[101] \
+Boolean set_mask_for_individual_horizon[101] \
   "should we set a mask grid function (or functions) for *this* horizon?"
 {
 } "false"
@@ -551,7 +568,7 @@ real mask_buffer_thickness \
 #    values independently at each time step, so all three regions can grow
 #    or shrink depending on the horizon positions/shapes.
 #
-boolean mask_is_noshrink \
+Boolean mask_is_noshrink \
   "should we prevent the inside & buffer regions from ever shrinking?"
 {
 } "true"
@@ -600,11 +617,11 @@ real min_horizon_radius_points_for_mask \
 #	does horizon finding.]
 # You can choose to set either (or even both!) of these.
 #
-boolean set_old_style_mask \
+Boolean set_old_style_mask \
   "if we're setting a mask, should we set an old-style (CCTK_REAL) mask gridfn?"
 {
 } "true"
-boolean set_new_style_mask \
+Boolean set_new_style_mask \
   "if we're setting a mask, should we set an new-style (CCTK_INT) mask gridfn?"
 {
 } "false"
@@ -1005,7 +1022,7 @@ real ILUCG__error_tolerance "error tolerance for conjugate gradient iteration"
 (0.0:*)	:: \
   "positive ==> error tolerance"
 } 1.0e-10
-boolean ILUCG__limit_CG_iterations \
+Boolean ILUCG__limit_CG_iterations \
   "should we limit the maximum number of conjugate gradient iterations allowed?"
 {
 "false"	:: "no limit on CG iterations"
@@ -1047,7 +1064,7 @@ real Jacobian_perturbation_amplitude \
 # if AHFinderDirect::method = "test Jacobian", should we test all
 # known methods for computing the Jacobian, or just the numerical perturbation
 # method (the latter may be useful of some other methods are broken)
-boolean test_all_Jacobian_compute_methods \
+Boolean test_all_Jacobian_compute_methods \
   "should we test all Jacobian computation methods, or just NP?"
 {
 } "true"
@@ -1111,7 +1128,7 @@ string geometry_interpolator_pars \
 # from the Cactus grid, we can instead hardwire it to an Eddington-Finkelstein
 # slice of Schwarzschild spacetime
 #
-boolean hardwire_Schwarzschild_EF_geometry \
+Boolean hardwire_Schwarzschild_EF_geometry \
   "should we hard-wire the geometry to Schwarzschild/EF instead of \
    interpolating from the Cactus grid?"
 {
@@ -1172,11 +1189,11 @@ real geometry__Schwarzschild_EF__Delta_xyz \
 # useful in catching assorted wierdness, so it's probably worth leaving
 # them enabled unless you're trying to squeeze every last nanosecond...
 #
-boolean check_that_h_is_finite \
+Boolean check_that_h_is_finite \
   "should we check that horizon shape function h is finite?"
 {
 } "true"
-boolean check_that_geometry_is_finite \
+Boolean check_that_geometry_is_finite \
   "should we check the interpolated geometry variables are finite?"
 {
 } "true"
@@ -1302,7 +1319,7 @@ keyword integral_method "how do we compute integrals over the horizon?"
 ### true ==> gives a more thorough test of the Jacobian,
 ###          but makes the test run much slower
 ### false ==> gives a slightly less thorough test, but runs faster
-##boolean NP_Jacobian__perturb_all_y_patch_points \
+##Boolean NP_Jacobian__perturb_all_y_patch_points \
 ##  "should we perturb at *all* points in the y patch, or just those with the \
 ##   iperp which is (supposedly) involved in the interpatch interpolation?"
 ##{