document more of the runtime parameters (#1695)

Author: zingale

Docs/rp.py

@@ -46,6 +46,8 @@ def pretty_category(path):
         return f"CONDUCTIVITY_DIR={subdir}"
     if path.startswith("integration/"):
         return f"INTEGRATOR_DIR={subdir}"
+    if path.startswith("opacity/"):
+        return f"OPACITY_DIR={subdir}"
     return path
 
 
@@ -65,9 +67,9 @@ def make_rest_table(param_files):
 
         # open the file
         try:
-            f = open(pf, "r")
-        except IOError:
-            sys.exit("ERROR: {} does not exist".format(pf))
+            f = open(pf)
+        except OSError:
+            sys.exit(f"ERROR: {pf} does not exist")
 
         descr = r""
 

EOS/gamma_law/_parameters

@@ -1,4 +1,9 @@
 @namespace: eos
 
+# ratio of specific heats
 eos_gamma            real     5.e0/3.e0
-eos_assume_neutral   bool     1
+
+# when computing mu / Abar, do we assume that the composition is atoms
+# or ionized, and therefore include the electron contributions
+# separately?
+eos_assume_neutral bool 1

EOS/multigamma/_parameters

@@ -1,14 +1,25 @@
 @namespace: eos
 
+# default ratio of specific heats used for all components unless specified
+# explicitly as species a, b, or c
 eos_gamma_default       real          1.4
 
+# name of species "a"
 species_a_name          string        ""
+
+# ratio of specific heats for species "a"
 species_a_gamma         real          1.4
 
+# name of species "b"
 species_b_name          string        ""
+
+# ratio of specific heats for species "b"
 species_b_gamma         real          1.4
 
+# name of species "c"
 species_c_name          string        ""
+
+# ratio of specific heats for species "c"
 species_c_gamma         real          1.4
 
 

EOS/polytrope/_parameters

@@ -1,7 +1,17 @@
 @namespace: eos
 
+# polytrope type: 1 is non-relativistic, fully degenerate electron
+# gas; 2 is fully-relativistic, fully degenerate gas.  If these are
+# set, then only pulytrope_mu_e needs to be set.
 polytrope_type       int      0
+
+# density exponent for pressure, P = K rho**gamma
 polytrope_gamma      real     0.0e0
+
+# proportionality constant in EOS, P = K rho**gamma
 polytrope_K          real     0.0e0
+
+# mean molecular weight per electron for the cases when polytrope_type
+# is 1 or 2.  In that case, we have P = K (rho / mu_e)**gamma
 polytrope_mu_e       real     2.0e0
 

EOS/rad_power_law/_parameters

@@ -1,5 +1,10 @@
 @namespace: eos
 
+# specific heat proportionality constant, K, c_v = K rho**m T**(-n)
 eos_const_c_v        real     -1.e0
+
+# specific heat density exponent, m, c_v = K rho**m T**(-n)
 eos_c_v_exp_m        real      0.e0
+
+# specific heat (negative) temperature exponent, n, c_v = K rho**m T**(-n)
 eos_c_v_exp_n        real      0.e0

EOS/tillotson/_parameters

@@ -1,13 +1,27 @@
 @namespace: eos
 
 eos_la               real     0.5
+
 eos_lb               real     1.3
+
+# minimum energy
 eos_e_0              real     1.6e11
+
+# reference density
 eos_rho_0            real     2.7
+
+
 eos_A                real     1.8e11
+
 eos_B                real     1.8e11
+
 eos_e_s              real     3.5e10
+
 eos_e_s_prime        real     1.8e11
+
 eos_alpha            real     5.0
+
 eos_beta             real     5.0
+
+# specific heat
 eos_c_v              real     7.9e6

conductivity/constant/_parameters

@@ -1,5 +1,6 @@
 @namespace: conductivity
 
+# constant value of the conductivity, in erg/s/cm/K
 const_conductivity   real     1.0e0
 
 

conductivity/constant_opacity/_parameters

@@ -1,5 +1,6 @@
 @namespace: conductivity
 
+# opacity value, in units of cm**2/g
 const_opacity        real     7.0e-2
 
 

conductivity/powerlaw/_parameters

@@ -1,6 +1,9 @@
 @namespace: conductivity
 
+# proportionality constant, C, in k = C T**m
 cond_coeff       real 1.0
+
+# temperature exponent, m, in k = C T**m
 cond_exponent    real 1.0
 
 

integration/_parameters

@@ -21,10 +21,17 @@ burner_verbose           bool     0
 
 # Tolerances for the solver (relative and absolute), for the
 # species and energy equations.
+
+# relative tolerance for species
 rtol_spec                real      1.e-12
+
+# relative tolerance for energy
 rtol_enuc                real      1.e-6
 
+# absolute tolerance for species
 atol_spec                real      1.e-8
+
+# absolute tolerance for energy
 atol_enuc                real      1.e-6
 
 # Whether to renormalize the mass fractions at each step in the evolution
@@ -69,10 +76,17 @@ retry_swap_jacobian       bool    1
 # Tolerances for the solver (relative and absolute), for the
 # species and energy equations.  If set to < 0, then the same
 # value as the first attempt is used.
+
+# relative tolerance for species on retry
 retry_rtol_spec                real      -1
+
+# relative tolerance for energy on retry
 retry_rtol_enuc                real      -1
 
+# absolute tolerance for species on retry
 retry_atol_spec                real      -1
+
+# absolute tolerance for energy on retry
 retry_atol_enuc                real      -1
 
 # in the clean_state process, do we clip the species such that they