Adding a cartoon flag plus cleaning up a bit.

git-svn-id: http://svn.einsteintoolkit.org/cactus/EinsteinAnalysis/AHFinder/trunk@149 89daf98e-ef62-4674-b946-b8ff9de2216c

1 files changed, 127 insertions, 88 deletions

diff --git a/param.ccl b/param.ccl
index 7019a0e..137d5fa 100644
--- a/param.ccl
+++ b/param.ccl
@@ -118,6 +118,11 @@ REAL dhole3_zmax "Upper z bound of excised region 2"
 
 private:
 
+
+############################
+### General parameters   ###
+############################
+
 BOOLEAN ahf_find3 "Searching for 3 surfaces?"
 {
 } "no"
@@ -133,22 +138,25 @@ INT ahf_findevery "How often to look for horizons" STEERABLE = ALWAYS
 
 INT ahf_findafter "After how many iterations look for horizons" STEERABLE = ALWAYS
 {
- : :: "By default set to 0, Any positive integer if start later in an evolution"
+ : :: "By default set to 0, any positive integer if start later in an evolution"
 } 0
 
 REAL ahf_findaftertime "After how much time look for horizons."
 {
- : :: "Any positive real number. Default is 0.0. Overides ahf_findafter"
+ : :: "Any positive real number. If non-zero overides ahf_findafter"
 } 0.0
 
 REAL trapped_surface_delta "find (expansion = delta) surface"
 {
- : :: "Just a real number. Range ??"
+ : :: "Just a real number"
 } 0.0
 
-# Parameters for surface expansion.
 
-BOOLEAN ahf_phi "Expand also in phi? I.e seach for non-axisymmetric surface" STEERABLE = ALWAYS
+########################################
+### Parameters for surface expansion ###
+########################################
+
+BOOLEAN ahf_phi "Expand also in phi? (seach for non-axisymmetric surface)" STEERABLE = ALWAYS
 {
 } "no"
 
@@ -162,23 +170,90 @@ BOOLEAN ahf_wander "Allow the center to wander?"
 
 INT ahf_lmax "Maximum number of terms in theta expansion" STEERABLE = ALWAYS
 {
-0:20 :: "Range from 0 to 20. 8 is the default"
+0:20 :: "Range from 0 to 20"
 } 8
 
-# Parameters for surface integrals.
+REAL ahf_xc "x-coordinate of center of expansion"
+{
+ : ::
+} 0.0
+
+REAL ahf_yc "y-coordinate of center of expansion"
+{
+ : ::
+} 0.0
+
+REAL ahf_zc "z-coordinate of center of expansion"
+{
+ : ::
+} 0.0
+
+REAL ahf_xc_0 "x-coordinate of center of expansion for first surface with find3"
+{
+ : ::
+} 0.0
+
+REAL ahf_yc_0 "y-coordinate of center of expansion for first surface with find3"
+{
+ : ::
+} 0.0
+
+REAL ahf_zc_0 "z-coordinate of center of expansion for first surface with find3"
+{
+ : ::
+} 0.0
+
+REAL ahf_xc_1 "x-coordinate of center of expansion for second surface with find3"
+{
+ : ::
+} 0.0
+
+REAL ahf_yc_1 "y-coordinate of center of expansion for second surface with find3"
+{
+ : ::
+} 0.0
+
+REAL ahf_zc_1 "z-coordinate of center of expansion for second surface with find3"
+{
+ : ::
+} 0.0
+
+REAL ahf_xc_2 "x-coordinate of center of expansion for third surface with find3"
+{
+ : ::
+} 0.0
+
+REAL ahf_yc_2 "y-coordinate of center of expansion for third surface with find3"
+{
+ : ::
+} 0.0
+
+REAL ahf_zc_2 "z-coordinate of center of expansion for third surface with find3"
+{
+ : ::
+} 0.0
+
+
+########################################
+### Parameters for surface integrals ###
+########################################
 
 INT ahf_ntheta "Number of subdivisions in theta"
 {
- : :: "Any sensible integer. The default of 100 is useful"
+ 1: :: "Any sensible integer"
 } 100
 
 INT ahf_nphi "Number of subdivisions in phi"
 {
- : :: "Any sensible integer. The default of 100 is useful"
+ 1: :: "Any sensible integer"
 } 100
 
-# Parameters to indicate symmetries.  This symmetries refer to the
-# surface itself, and NOT the grid.
+
+#########################################
+### Parameters to indicate symmetries ###
+#########################################
+
+# IMPORTANT: This symmetries refer to the surface itself, and NOT the grid.
 
 # Notice that octant = "yes"  enforces reflection symmetries on all
 # three coordinate planes, while  octant = "high"  enforces also the
@@ -196,6 +271,10 @@ BOOLEAN ahf_refz "Reflection symmetry z->-z?" STEERABLE = ALWAYS
 {
 } "no"
 
+BOOLEAN ahf_cartoon "Cartoon mode?" STEERABLE = ALWAYS
+{
+} "no"
+
 KEYWORD ahf_octant "Octant symmetry?" STEERABLE = ALWAYS
 {
   "no"   :: "No octant symmetry"
@@ -203,7 +282,10 @@ KEYWORD ahf_octant "Octant symmetry?" STEERABLE = ALWAYS
   "high" :: "Octant symmetry + symmetry of rotation of pi/2 around z axis"
 } "no"
 
-# Parameters for minimization algorithm.
+
+#############################################
+### Parameters for minimization algorithm ###
+#############################################
 
 BOOLEAN ahf_minarea "Minimize area instead of expansion?"
 {
@@ -211,15 +293,18 @@ BOOLEAN ahf_minarea "Minimize area instead of expansion?"
 
 INT ahf_maxiter "Maximum number of iterations of POWELL"
 {
- : :: "Any sensible integer value. Default is 10"
+ : :: "Any sensible integer value"
 } 10
 
 REAL ahf_tol "Tolerance for minimization routines"
 {
- : :: "A sensible real number."
+0: :: "A sensible positive number"
 } 0.1
 
-#Parameters for initial guess.
+
+####################################
+### Parameters for initial guess ###
+####################################
 
 BOOLEAN ahf_sloppyguess "Use sphere as initial guess?"
 {
@@ -301,87 +386,31 @@ REAL  ahf_l18_guess "Manual guess for l=18 component"
  : ::
 } 0.0
 
-REAL ahf_r0 "Radius of initial sphere (0. forces largest sphere)"
-{
- : ::
-} 0.0
-
-REAL ahf_r0_0 "Radius of first initial sphere for find3 (largest for 0.)"
-{
- : ::
-} 0.0
-
-REAL ahf_r0_1 "Radius of second initial sphere for find3 (largest for 0.)"
-{
- : ::
-} 0.0
-
-REAL ahf_r0_2 "Radius of third initial sphere for find3 (largest for 0.)"
-{
- : ::
-} 0.0
-
-REAL ahf_xc "x-coordinate of center of expansion"
-{
- : ::
-} 0.0
-
-REAL ahf_yc "y-coordinate of center of expansion"
-{
- : ::
-} 0.0
-
-REAL ahf_zc "z-coordinate of center of expansion"
-{
- : ::
-} 0.0
-
-REAL ahf_xc_0 "x-coordinate of center of expansion for first surface with find3"
-{
- : ::
-} 0.0
-
-REAL ahf_yc_0 "y-coordinate of center of expansion for first surface with find3"
-{
- : ::
-} 0.0
-
-REAL ahf_zc_0 "z-coordinate of center of expansion for first surface with find3"
-{
- : ::
-} 0.0
-
-REAL ahf_xc_1 "x-coordinate of center of expansion for second surface with find3"
+REAL ahf_r0 "Radius of initial sphere (0 forces largest sphere)"
 {
  : ::
 } 0.0
 
-REAL ahf_yc_1 "y-coordinate of center of expansion for second surface with find3"
+REAL ahf_r0_0 "Radius of first initial sphere for find3 (0 forces largest sphere)"
 {
  : ::
 } 0.0
 
-REAL ahf_zc_1 "z-coordinate of center of expansion for second surface with find3"
+REAL ahf_r0_1 "Radius of second initial sphere for find3 (0 forces largest sphere)"
 {
  : ::
 } 0.0
 
-REAL ahf_xc_2 "x-coordinate of center of expansion for third surface with find3"
+REAL ahf_r0_2 "Radius of third initial sphere for find3 (0 forces largest sphere)"
 {
  : ::
 } 0.0
 
-REAL ahf_yc_2 "y-coordinate of center of expansion for third surface with find3"
-{
- : ::
-} 0.0
 
-REAL ahf_zc_2 "z-coordinate of center of expansion for third surface with find3"
-{
- : ::
-} 0.0
 
-# Parameters for flow algorithm.
+#####################################
+### Parameters for flow algorithm ###
+#####################################
 
 BOOLEAN ahf_flow "Use flow instead of minimization?"  STEERABLE = ALWAYS
 {
@@ -432,7 +461,10 @@ REAL ahf_minchange "Minimum relative difference between 1 big and 2 small steps"
  : ::
 } 0.01
 
-# Parameters for output.
+
+#############################
+### Parameters for output ###
+#############################
 
 # IMPORTANT:  3D output for grid functions is still not implemented!
 
@@ -473,7 +505,10 @@ BOOLEAN ahf_gaussout "Output gaussian curvature of horizon?"  STEERABLE = ALWAYS
 } "yes"
 
 
-# Parameters for mask.
+
+###########################
+### Parameters for mask ###
+###########################
 
 KEYWORD ahf_mask "Use mask?"
 {
@@ -491,8 +526,6 @@ REAL ahf_maskshrink "Shrink factor for mask"
 0.0:1.0 :: "Must be positive and not larger than 1"
 } 0.9
 
-# Parameters for shift.
-
 REAL ahf_shiftcoeff "Coefficient for shift"
 {
 : :: "Anything goes"
@@ -500,12 +533,14 @@ REAL ahf_shiftcoeff "Coefficient for shift"
 
 
 
-####################################
-### PARAMETERS FROM OTHER THORNS ###
-####################################
+###############################################
+###   PARAMETERS SHARED FROM OTHER THORNS   ###
+###############################################
 
 
-###  FROM IO  ###
+###############
+### FROM IO ###
+###############
 
 shares: IO
 
@@ -514,7 +549,9 @@ STRING outdir ""
 }
 
 
-###  FROM GRID  ###
+#################
+### FROM GRID ###
+#################
 
 shares: grid
 
@@ -527,7 +564,9 @@ KEYWORD bitant_plane ""
 }
 
 
-###  FROM EINSTEIN  ###
+#####################
+### FROM EINSTEIN ###
+#####################
 
 shares: einstein