revise semantics of min_horizon_radius_points_for_mask

so it now tests against the angular minimum of r_inner,
not r_min (= the angular minimum of r_horizon) like it did before

... docs update will follow shortly


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

1 files changed, 15 insertions, 7 deletions

diff --git a/param.ccl b/param.ccl
index ffb3d3f..aa31186 100644
--- a/param.ccl
+++ b/param.ccl
@@ -536,16 +536,24 @@ boolean mask_is_noshrink \
 #
 # So...  This parameter may be used to specify that the mask not be set
 # for a given horizon (just as if that horizon wasn't found) on any grid
-# where the ratio
-#	BH_diagnostics.min_radius / max(Delta_x,Delta_y,Delta_z)
-# (where  Delta_[xyz]  are the *LOCAL* grid spacings on the current grid)
-# is too small (in particular, < this parameter).  
+# where the inner mask radius  r_inner  is < this many grid spacings.
+# More precisely, we skip masking for any horizon where
+#	r_inner,min < min_horizon_radius_points_for_mask * Delta_x_current,max
+# where
+#	r_inner,min = the minimum over all angles of the inner mask radius
+#		      r_inner
+#	Delta_x_current,max = the maximum of the x,y,and z grid spacings
+#			      in the *current* Cactus grid
+#
+# Note that since r_inner can be negative (if  mask_radius_offset < 0 ),
+# the default setting for this parameter is effectively -infinity, to
+# excise any horizon.
 #
 real min_horizon_radius_points_for_mask \
-  "only set mask if min horizon radius >= this number of local grid spacings"
+  "only set mask if min r_inner >= this number of local grid spacings"
 {
-0.0:* :: "any real number >= 0.0"
-} 0.0
+*:* :: "any real number"
+} -1.0e10
 
 #
 # This thorn supports two types of mask grid functions: