# Parameter definitions for thorn MoL
# $Header$

restricted:

CCTK_INT MoL_Num_Evolved_Vars "The maximum number of variables to be evolved by MoL" ACCUMULATOR = (x+y)
{
  (0:*		:: "Anything non negative. Added to by other thorns."
} 1

CCTK_INT MoL_Num_Constrained_Vars "The maximum number of constrained variables with timelevels that MoL needs to know about" ACCUMULATOR = (x+y)
{
  (0:*		:: "Anything non negative. Added to by other thorns."
} 1

CCTK_INT MoL_Num_SaveAndRestore_Vars "The maximum number of variables to be evolved outside of MoL but that MoL needs to know about" ACCUMULATOR = (x+y)
{
  (0:*		:: "Anything non negative. Added to by other thorns."
} 1

CCTK_INT MoL_Num_ComplexEvolved_Vars "The maximum number of complex variables to be evolved by MoL" ACCUMULATOR = (x+y)
{
  (0:*		:: "Anything non negative. Added to by other thorns."
} 1

CCTK_INT MoL_Num_ComplexConstrained_Vars "The maximum number of complex constrained variables with timelevels that MoL needs to know about" ACCUMULATOR = (x+y)
{
  (0:*		:: "Anything non negative. Added to by other thorns."
} 1

CCTK_INT MoL_Num_ComplexSaveAndRestore_Vars "The maximum number of complex variables to be evolved outside of MoL but that MoL needs to know about" ACCUMULATOR = (x+y)
{
  (0:*		:: "Anything non negative. Added to by other thorns."
} 1

CCTK_INT MoL_Max_Evolved_Array_Size "The maximum total size of any grid arrays to be evolved" ACCUMULATOR = (x+y)
{
  (0:*          :: "Anything non negative. Accumulated by other thorns"
} 1

CCTK_INT MoL_Max_Evolved_ComplexArray_Size "The maximum total size of any complex grid arrays to be evolved" ACCUMULATOR = (x+y)
{
  (0:*          :: "Anything non negative. Accumulated by other thorns"
} 1

CCTK_INT MoL_Num_ArrayEvolved_Vars "The maximum number of array variables to be evolved by MoL" ACCUMULATOR = (x+y)
{
  (0:*		:: "Anything non negative. Added to by other thorns."
} 1

CCTK_INT MoL_Num_ArrayConstrained_Vars "The maximum number of array constrained variables with timelevels that MoL needs to know about" ACCUMULATOR = (x+y)
{
  (0:*		:: "Anything non negative. Added to by other thorns."
} 1

CCTK_INT MoL_Num_ArraySaveAndRestore_Vars "The maximum number of array variables to be evolved outside of MoL but that MoL needs to know about" ACCUMULATOR = (x+y)
{
  (0:*		:: "Anything non negative. Added to by other thorns."
} 1

CCTK_INT MoL_Num_ComplexArrayEvolved_Vars "The maximum number of complex array variables to be evolved by MoL" ACCUMULATOR = (x+y)
{
  (0:*		:: "Anything non negative. Added to by other thorns."
} 1

CCTK_INT MoL_Num_ComplexArrayConstrained_Vars "The maximum number of complex array constrained variables with timelevels that MoL needs to know about" ACCUMULATOR = (x+y)
{
  (0:*		:: "Anything non negative. Added to by other thorns."
} 1

CCTK_INT MoL_Num_ComplexArraySaveAndRestore_Vars "The maximum number of complex array variables to be evolved outside of MoL but that MoL needs to know about" ACCUMULATOR = (x+y)
{
  (0:*		:: "Anything non negative. Added to by other thorns."
} 1

CCTK_INT MoL_Num_Scratch_Levels "Number of scratch levels required by the ODE method"
{
  0:*		:: "Anything non negative"
} 0

private:

KEYWORD ODE_Method "The ODE method use by MoL to do time integration"
{
  "Generic"	:: "Generic Shu-Osher Runga-Kutta type"
  "ICN"		:: "Iterative Crank Nicholson"
  "ICN-avg"	:: "Iterative Crank Nicholson with averaging"
  "RK2"		:: "Efficient RK2"
  "RK3"		:: "Efficient RK3"
} "ICN"

KEYWORD Generic_Type "If using the generic method, which sort"
{
  "RK"		:: "One of the standard TVD Runga-Kutta methods"
  "ICN"		:: "Iterative Crank Nicholson as a generic method"
  "Table"       :: "Given from the generic method descriptor parameter"
} "RK"

CCTK_INT MoL_Intermediate_Steps "Number of intermediate steps taken by the ODE method"
{
  1:*		:: "Anything greater than 1"
} 3

BOOLEAN MoL_Memory_Always_On "Do we keep the scratch arrays allocated all the time?"
{
} "yes"

CCTK_REAL MoL_Tiny "Effective local machine zero; required by generic solvers"
{
  0:*		:: "Defaults to 1.e-15"
} 1.e-15

BOOLEAN initial_data_is_crap "If the initial data routine fails to set up the previous time levels, copy the current backwards"
{
} "no"

# The default for this parameter corresponds to generic RK2
STRING Generic_Method_Descriptor "A string used to create a table containing the description of the generic method"
{
  ".*"          :: "Should contain the Alpha and Beta arrays, and the number of intermediate steps"
} "GenericIntermediateSteps = 2 \
   GenericAlphaCoeffs = { 1.0 0.0 0.5 0.5 } \
   GenericBetaCoeffs = { 1.0 0.5 }"
       
BOOLEAN MoL_NaN_Check "Should the RHS GFs be checked for NaNs?"
{
} "no"