Merged in drreynolds/enzo-dev_reynolds (pull request enzo-project#216)

Adding updates from other repositories to unigrid FLD solver, gFLDSplit

--HG--
branch : week-of-code

Author: samskillman

doc/manual/source/parameters/radiation.rst

@@ -376,25 +376,35 @@ Radiative Transfer (FLD) Split Solver Parameters
 
    ::
  
-    -1 - monochromatic spectrum at frequency h nu_{HI}= 13.6 eV
-    0  - power law spectrum, (nu / nu_{HI})^(-1.5) 
     1  - T=1e5 blackbody spectrum
+    0  - power law spectrum, ( nu / nu_{HI})^(-1.5)` 
+    -1 - monochromatic spectrum at frequency h nu_{HI}= 13.6 eV
+    -2 - monochromatic spectrum at frequency h nu_{HeI}= 24.6 eV
+    -3 - monochromatic spectrum at frequency h nu_{HeII}= 54.4 eV
 
 ``RadHydroChemistry`` (external)
-    Use of hydrogen chemistry in ionization model, set to 1 to turn on
-    the hydrogen chemistry, 0 otherwise. Default: 1.
+    Use of primordial chemistry in computing opacities and
+    photo-heating/photo-ionization.  Default: 1. 
+
+   ::
+
+    0 no chemistry
+    1 hydrogen chemistry
+    3 hydrogen and helium chemistry
+
 ``RadHydroHFraction`` (external)
     Fraction of baryonic matter comprised of hydrogen. Default: 1.0.
 ``RadHydroModel`` (external)
     Determines which set of equations to use within the solver.
     Default: 1.
 
    ::
+
     1  - chemistry-dependent model, with case-B hydrogen II recombination
          coefficient.
     4  - chemistry-dependent model, with case-A hydrogen II recombination
          coefficient, but assumes an isothermal gas energy.
-   10  - no chemistry, instead uses a model of local thermodynamic
+    10 - no chemistry, instead uses a model of local thermodynamic
        	 equilibrium to couple radiation to gas energy.
 
 
@@ -407,24 +417,43 @@ Radiative Transfer (FLD) Split Solver Parameters
 ``RadHydroInitDt`` (external)
     initial time step to use in the FLD solver. Default: 1e20 (uses
     hydro time step).
+``RadHydroMaxSubcycles`` (external)
+    desired number of FLD time steps per hydrodynamics time step (must
+    be greater than or equal to 1). This is only recommended if the
+    FLD solver is performing chemistry and heating internally, since
+    it will only synchronize with the ionization state at each
+    hydrodynamic time step.  When using Enzo's chemistry and cooling
+    solvers this parameter should be set to 1 to avoid overly
+    decoupling radiation and chemistry.  Default: 1.0.
+``RadHydroMaxChemSubcycles`` (external)
+    desired number of chemistry time steps per FLD time step.  This
+    only applies if the FLD solver is performing chemistry and heating
+    internally, instead of using Enzo's built-in routines for this
+    task. Default: 1.0.
 ``RadHydroDtNorm`` (external)
     type of p-norm to use in estimating time-accuracy for predicting
     next time step. Default: 2.0.
 
    ::
+
     0  - use the max-norm.
     >0 - use the specified p-norm.
     <0 - illegal.
 
+``RadHydroDtGrowth`` (external)
+    Maximum growth factor in the FLD time step between successive
+    iterations. Default: 1.1 (10% growth).
 ``RadHydroDtRadFac`` (external)
     Desired time accuracy tolerance for the radiation field. Default:
     1e20 (unused).
 ``RadHydroDtGasFac`` (external)
-    Desired time accuracy tolerance for the gas energy field. Default:
+    Desired time accuracy tolerance for the gas energy field.  Only
+    used if the FLD solver is performing heating internally.  Default:
     1e20 (unused).
 ``RadHydroDtChemFac`` (external)
-    Desired time accuracy tolerance for the hydrogen I number density.
-    Default: 1e20 (unused).
+    Desired time accuracy tolerance for the hydrogen I number
+    density.  Only used if the FLD solver is performing chemistry
+    internally.  Default: 1e20 (unused).
 ``RadiationScaling`` (external)
     Scaling factor for the radiation field, in case standard
     non-dimensionalization fails. Default: 1.0.
@@ -434,6 +463,11 @@ Radiative Transfer (FLD) Split Solver Parameters
 ``ChemistryScaling`` (external)
     Scaling factor for the hydrogen I number density, in case standard
     non-dimensionalization fails. Default: 1.0.
+``AutomaticScaling`` (external)
+    Enables an heuristic approach in the FLD solver to update the
+    above scaling factors internally.  Works well for reioniztaion
+    calculations, but is not recommended for problems in which the
+    optimal unit scaling factor is known a-priori. Default: 1.0.
 ``RadiationBoundaryX0Faces`` (external)
     Boundary condition types to use on the x0 faces of the radiation
     field. Default: [0 0].
@@ -453,6 +487,15 @@ Radiative Transfer (FLD) Split Solver Parameters
 ``RadHydroTheta`` (external)
     Time-discretization parameter to use, 0 gives explicit Euler, 1
     gives implicit Euler, 0.5 gives trapezoidal. Default: 1.0.
+``RadHydroKrylovMethod`` (external)
+    Desired outer linear solver algorithm to use.  Default: 1.
+
+    ::
+
+     0 - Preconditioned Conjugate Gradient (PCG)
+     1 - Stabilized Bi-Conjugate Gradient (BiCGStab)
+     2 - Generalized Minimum Residual (GMRES)
+
 ``RadHydroSolTolerance`` (external)
     Desired accuracy for solution to satisfy linear residual (measured
     in the 2-norm). Default: 1e-8.
@@ -464,10 +507,10 @@ Radiative Transfer (FLD) Split Solver Parameters
 
     ::
 
-     Jacobi.
-     Weighted Jacobi.
-     Red/Black Gauss-Seidel (symmetric).
-     Red/Black Gauss-Seidel (non-symmetric).
+     0 - Jacobi
+     1 - Weighted Jacobi
+     2 - Red/Black Gauss-Seidel (symmetric)
+     3 - Red/Black Gauss-Seidel (non-symmetric)
 
 ``RadHydroMGPreRelax`` (external)
     Number of pre-relaxation sweeps used by the multigrid solver.