path: root/param.ccl

# Parameter definitions for thorn AHFinder
# $Header$


#These parameters are to switch on the finder, and to control how
#often and when to start looking for horizons.

restricted:

BOOLEAN ahf_active "Activate AHFinder?"
{
} "no"

BOOLEAN ahf_persists "Does the AH Finder array and mask stay around"
{
} "no"


private:

BOOLEAN ahf_find3 "Searching for 3 surfaces?"
{
} "no"

BOOLEAN ahf_trapped_surface "Minimize (expansion + delta) to find trapped surface?"
{
} "no"

INT ahf_findevery "How often to look for horizons"
{
 : :: "Ranges from 1 for each iteration to higher numbers with default set to 1"
} 1

INT ahf_findafter "After how many iterations look for horizons"
{
 : :: "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"
} 0.0

REAL trapped_surface_delta "find (expansion = delta) surface"
{
 : :: "Just a real number. Range ??"
} 0.0

#Parameters for surface expansion.

BOOLEAN ahf_phi "Expand also in phi? I.e seach for non-axisymmetric surface"
{
} "no"

BOOLEAN ahf_offset "Center offset from origin?"
{
} "no"

BOOLEAN ahf_wander "Allow the center to wander?"
{
} "no"

INT ahf_lmax "Maximum number of terms in theta expansion"
{
0:20 :: "Range from 0 to 20. 8 is the default"
} 8

#Parameters for surface integrals.

INT ahf_ntheta "Number of subdivisions in theta"
{
 : :: "Any senseful integer. The default of 200 is useful"
} 200

INT ahf_nphi "Number of subdivisions in phi"
{
 : :: "Any senseful integer. The default of 200 is useful"
} 200

#Parameters to indicate symmetries.  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
#extra symmetry of rotation of pi/2 around the z axis.

BOOLEAN ahf_refx "Reflection symmetry x->-x?"
{
} "no"

BOOLEAN ahf_refy "Reflection symmetry y->-y?"
{
} "no"

BOOLEAN ahf_refz "Reflection symmetry z->-z?"
{
} "no"

KEYWORD ahf_octant "Octant symmetry?"
{
  "no"   :: "No octant symmetry"
  "yes"  :: "Octant symmetry: reflection symmetry on all three coordinate planes"
  "high" :: "reflection symmetry on all three planes and symmetry of rotation of pi/2 around the z axis"
} "no"

#Parameters for minimization algorithm.

BOOLEAN ahf_minarea "Minimize area instead of expansion?"
{
} "no"

INT ahf_maxiter "Maximum number of iterations of POWELL"
{
 : :: "Any senseful integer value. Default is 10"
} 10

REAL ahf_tol "Tolerance for minimization routines"
{
 : :: "A senseful real number."
} 0.1

#Parameters for initial guess.

BOOLEAN ahf_sloppyguess "Use sphere as initial guess?"
{
} "no"

BOOLEAN ahf_guess_absmin "Use absolute min to start Minimization?"
{
} "no"

BOOLEAN ahf_guessold "Use old horizon as initial guess?"
{
} "no"

BOOLEAN ahf_inner "Look for inner horizon?"
{
} "no"

BOOLEAN ahf_manual_guess "Use specified coefficients for guess?"
{
} "no"

INT ahf_nn0 "Number of subdivisions of c0(0) for initial guess"
{
 : :: "Some positive integer"
} 10

INT ahf_nn2 "Number of subdivisions of c0(2) for initial guess"
{
 : :: "Some positive integer"
} 10

REAL  ahf_l0_guess "Manual guess for l=0 component"
{
 : ::
} 1.0

REAL  ahf_l2_guess "Manual guess for l=2 component"
{
 : ::
} 0.0

REAL  ahf_l4_guess "Manual guess for l=4 component"
{
 : ::
} 0.0

REAL  ahf_l6_guess "Manual guess for l=6 component"
{
 : ::
} 0.0

REAL  ahf_l8_guess "Manual guess for l=8 component"
{
 : ::
} 0.0

REAL  ahf_l10_guess "Manual guess for l=10 component"
{
 : ::
} 0.0

REAL  ahf_l12_guess "Manual guess for l=12 component"
{
 : ::
} 0.0

REAL  ahf_l14_guess "Manual guess for l=14 component"
{
 : ::
} 0.0

REAL  ahf_l16_guess "Manual guess for l=16 component"
{
 : ::
} 0.0

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"
{
 : ::
} 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 flow algorithm.

BOOLEAN ahf_flow "Use flow instead of minimization?"
{
} "no"

INT ahf_flowiter "Maximum number of iterations for flow"
{
 : ::
} 200

REAL ahf_flowa "alpha parameter for flow"
{
 : :: 
} 0.01

REAL ahf_flowb "beta parameter for flow"
{
 : ::
} 0.5

REAL ahf_flowh "Weight of H flow"
{
 : ::
} 0.0

REAL ahf_flowc "Weight of C flow"
{
 : ::
} 1.0

REAl ahf_flown "Weight of N flow"
{
 : ::
} 0.0

REAL ahf_flowtol "Tolerance for flow"
{
 : ::
} 0.0001

REAL ahf_maxchange "max rel diff between 1 big and 2 small steps"
{
 : ::
} 0.1

REAL ahf_minchange "min rel diff between 1 big and 2 small steps"
{
 : ::
} 0.01

#Parameters for output.

#IMPORTANT:  3D output for grid functions is still not implemented!

BOOLEAN ahf_logfile "Write log file?"
{
} "no"

BOOLEAN ahf_verbose "Print messages to screen?"
{
} "yes"

BOOLEAN ahf_veryverbose "Print messages at each iteration step to screen?"
{
} "no"

BOOLEAN ahf_guessverbose "Print info on initial guell points?"
{
} "no"

BOOLEAN ahf_2Doutput "2D output of grid functions?"
{
} "yes"

BOOLEAN ahf_3Doutput "3D output of grid functions? (Not yet implemented!)"
{
} "no"

BOOLEAN ahf_areamap "Find area map?"
{
} "no"

BOOLEAN ahf_gaussout "Output gaussian curvature of horizon?"
{
} "yes"


#Parameters for mask.

KEYWORD ahf_mask "Use mask for definite horizons?"
{
"off"    :: "Mask is off"
"strong" :: "Mask set only for definite horizons"
"weak"   :: "Mask set for both definite and probable horizons"
} "off"

BOOLEAN ahf_maskcube "Do we want a cubical mask?"
{
} "no"

REAL ahf_maskshrink "Shrink factor for mask"
{
0.0:1.0 :: "Must be positive and not larger than 1"
} 0.9


####################################
### PARAMETERS FROM OTHER THORNS ###
####################################

###  FROM IO  ###

shares: IO

EXTENDS STRING outdir "Name of IO output directory"
{
} "."

###  FROM GRID  ###

shares: grid

KEYWORD domain ""
{
}