# Parameter definitions for thorn ADM
# $Header$
 
shares:grid

USES KEYWORD domain 

shares:time

USES KEYWORD timestep_method 

USES BOOLEAN timestep_outonly 

shares:einstein

EXTENDS KEYWORD initial_lapse 
{
  "schwarz" :: "Set lapse to Schwarzschild"
}

EXTENDS KEYWORD evolution_system 
{
   "ADM" :: "Evolve using ADM evolution scheme"
}

EXTENDS KEYWORD slicing 
{
   "detg"     :: "detg = harmonic with f=1"
   "harmonic" :: "harmonic slicing"
   "1+log"    :: "1+log slicing"
} ""

KEYWORD advection ""
{
} ""


restricted: 

REAL harmonic_f "Harmonic speed: d_t alp = - alp^2 harmonic_f trK"
{
 *:* :: "" 
} 1.0

KEYWORD method "Numerical method to use for ADM"
{
   "stagleap" :: "Evolve using Staggered Leapfrog"
   "leapfrog" :: "Evolve using Double Leapfrog"
   "ICN"      :: "Evolve using Iterative Crank-Nicholson"
   "icn"      :: "Evolve using Iterative Crank-Nicholson"
} "stagleap"

KEYWORD bound "Boundary condition to implement"
{
  "flat"      :: "Flat boundary condition"
  "none"      :: "No boundary condition"
  "static"    :: "Boundaries held fixed"
  "zero"      :: "Zero boundary condition"
  "radiative" :: "Radiative boundary condition"
  "staticrad" :: "Static radiation boundary condition"
} "none"

private:

# This is a hack to add Cartoon
BOOLEAN cartoon "Use cartoon boundary conditions"
{
} "no"

REAL flat_dissip "Amount of flatspace nabla^2 alp added to alp source"
{
 : :: ""
} 0.0

REAL dissip "Amount of covariant nabla^2 alp added to alp source"
{
 : :: ""
} 0.0 

REAL nabla_K_coeff "Amount of covariant nabla^2 K added to K source"
{
 : :: ""
} 0.0

REAL ICN_stop_at_norm "???"
{
 : :: ""
} 1e-8

INT ICN_itnum "number of iterations of ICN"
{
 : :: "a negative value harwires 50 iterations"
} 3

INT ICN_itnum_min "minimum number of iterations of ICN"
{
0: :: "positive please"
} 1
 
KEYWORD leapfrog_firststep "How should we evolve the first DL timestep"
{
  "ftcs"       :: "Forward time centered space"
  "predcorr"   :: "Predictor Corrector"
} "ftcs"

KEYWORD stagleap_firststep "How should we evolve the first SL timestep"
{
  "ts1"        :: "First order time symmetric"
  "predcorr"   :: "Predictor Corrector"
} "ts1"

BOOLEAN verbose "Give more detailed information about the evolution step"
{
} "no"

BOOLEAN ICN_norm_error "normalize icn error on a per point basis"
{
} "no"

BOOLEAN evolution_storage "turn on storage for ADM evolution variables as default?"
{
} "no"

BOOLEAN staggered_storage "turn on stagleap storage as default?"
{
} "no"

KEYWORD slicing_flavour "none or kleing"
{
"none"       ::  "The standard"
"kleing"     ::  "As implemented in the kleing code"
} "none"

BOOLEAN store_initial_lapse "no or yes"
{
} "no"

BOOLEAN minimal_communications "If yes do not sychronise extrinsic curvature"
{
} "no"

BOOLEAN excise "Use excision"
{
} "no"

BOOLEAN evolveg_boundary "Use evolution equation for metric at boundary"
{
} "no"