Runtime Parameters Documentation for FLASH Release 4-beta


physics/Hydro
    useHydro [BOOLEAN] CONSTANT [FALSE]
        Whether Hydro calculations should be performed.

physics/Hydro/HydroMain
    UnitSystem [STRING] ["none"]
        Valid Values: Unconstrained
        System of Units
    cfl [REAL] [0.8]
        Valid Values: Unconstrained
        Courant factor
    irenorm [INTEGER] [0]
        Valid Values: Unconstrained
        Renormalize the abundances before eos
    threadHydroBlockList [BOOLEAN] [TRUE]

    threadHydroWithinBlock [BOOLEAN] [TRUE]

    updateHydroFluxes [BOOLEAN] [TRUE]
        whether fluxes computed by Hydro should be used to update the solution
        (currently, probably only used in split PPM Hydro)
    useHydro [BOOLEAN] [TRUE]

    use_cma_advection [BOOLEAN] [FALSE]

    use_cma_flattening [BOOLEAN] [FALSE]
        use the flattening procedure for the abundances as described in the CMA
        paper
    use_cma_steepening [BOOLEAN] [FALSE]

    use_steepening [BOOLEAN] [TRUE]


physics/Hydro/HydroMain/split/MHD_8Wave
    RoeAvg [BOOLEAN] [TRUE]

    hall_parameter [REAL] [0.0]
        Valid Values: Unconstrained

    hyperResistivity [REAL] [0.0]
        Valid Values: Unconstrained

    irenorm [INTEGER] [0]
        Valid Values: Unconstrained

    killdivb [BOOLEAN] [TRUE]

    small [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value
    smalle [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value for energy
    smallp [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value for pressure
    smallt [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value for temperature
    smallu [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value for velocity
    smallx [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value for abundances
    smlrho [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value for density

physics/Hydro/HydroMain/split/PPM
    charLimiting [BOOLEAN] [TRUE]
        use characteristic variables for slope limiting
    cvisc [REAL] [0.1]
        Valid Values: Unconstrained
        Artificial viscosity constant
    dp_sh [REAL] [0.33]
        Valid Values: Unconstrained

    dp_sh_md [REAL] [0.33]
        Valid Values: Unconstrained
        pressure jump for multi-dimensional shock detection
    epsiln [REAL] [0.33]
        Valid Values: Unconstrained
        PPM shock detection parameter
    hy_fluxRepresentation [STRING] ["fluxes"]
        Valid Values: "hybrid", "fluxes", "auto"
        determines the nature of the data stored in flux arrays. With this
        parameter set to "fluxes", the fluxes and cell volumes used in the Hydro
        method are calculated correctly using geometry measures (in units
        matching those in which coordinates are represented). If
        hy_fluxRepresentation is "hybrid", fluxes are calculated in a simpler
        way; for example, the fluxes in Cartesian coordinates use the convention
        Face Area == 1 (and thus Cell Volume == dx during the X sweep, etc.).
        Both settings lead to a correct algorithm, because what is ultimately
        applied in the Hydro update is of the form fluxes times dt/CellVolume,
        so cell areas (thus fluxes) and volumes can be multiplied by an
        arbitrary constant (as long as it is done consistently) without changing
        results (except for rounding effects). The setting here must match
        Paramesh's understanding of what the "fluxes" are that it is being
        passed if Grid_conserveFluxes is called: If hy_fluxRepresentation is
        "fluxes", then Paramesh4 should have set consv_fluxes==.true., 
        consv_flux_densities==.false. If hy_fluxRepresentation is "hybrid", then
        Paramesh4 should have set consv_fluxes==.false.,
        consv_flux_densities==.true. Hydro_init will try to set Paramesh to the
        right mode if possible, this requires Paramesh to be compiled in LIBRARY
        mode. If this fails, the flux representation will be modified to
        correspond to what the Grid unit supports. A third possible value for
        hy_fluxRepresentation is "auto", in which case the Hydro code unit will
        pick either "fluxes" or "hybrid" based on geometry and support in Grid.
    hybrid_riemann [BOOLEAN] [FALSE]
        use HLLE in shocks to remove odd-even decoupling
    igodu [INTEGER] [0]
        Valid Values: Unconstrained
        Use Godunov method
    iplm [INTEGER] [0]
        Valid Values: Unconstrained
        Use linear profiles
    leveque [BOOLEAN] [FALSE]
        modify states due to gravity -- leveque's way.
    nriem [INTEGER] [10]
        Valid Values: Unconstrained
        No. of iterations in Riemann solver
    omg1 [REAL] [0.75]
        Valid Values: Unconstrained
        PPM dissipation parameter omega1
    omg2 [REAL] [10.]
        Valid Values: Unconstrained
        PPM dissipation parameter omega2
    ppmEintCompFluxConstructionMeth [INTEGER] [0]
        Valid Values: -1, 0 to 7

    ppmEintFluxConstructionMeth [INTEGER] [0]
        Valid Values: -1, 0 to 2, 4 to 6
        selects a method for constructing energy fluxes, for internal energy,
        from the results of calling the Riemann solver. Note that the eintSwitch
        runtime parameter controls whether internal energy fluxes, rather than
        total energy fluxes, are sometimes used for updating the energy
        variables (both internal and total) in a given cell (depending on the
        ratio of kinetic to internal energy in that cell).
    ppmEnerCompFluxConstructionMeth [INTEGER] [0]
        Valid Values: 0 to 7, 11 to 17, 20 to 27

    ppmEnerFluxConstructionMeth [INTEGER] [0]
        Valid Values: 0 to 2, 4 to 6, 11 to 12, 14 to 16, 20 to 27
        selects a method for constructing energy fluxes, for total
        (internal+kinetic) energy, from the results of calling the Riemann
        solver.
    ppm_modifystates [BOOLEAN] [FALSE]
        modify states due to gravity -- our way.
    rieman_tol [REAL] [1.0e-5]
        Valid Values: Unconstrained
        Converge factor for Riemann solver
    small [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value ... DEV: for what?
    smalle [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value for energy
    smallp [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value for pressure
    smallt [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value for temperature
    smallu [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value for velocity
    smallx [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value for abundances
    smlrho [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value for density
    vgrid [REAL] [0.]
        Valid Values: Unconstrained
        Scale factor for grid velocity

physics/Hydro/HydroMain/split/PPM/chomboCompatible
    chomboLikeUpdateSoln [BOOLEAN] [true]
        Use a simplified hy_ppm_updateSoln
    excludeGradPresFromFlux [BOOLEAN] [false]
        PLUTO like excludeGradPresFromFlux=.true., FLASH like
        excludeGradPresFromFlux=.false.

physics/Hydro/HydroMain/split/PPM/multiTemp
    hy_3Ttry_Arelated [BOOLEAN] [FALSE]
        a code switch for hydro_1d, determines how fluxes for eint-without-PdV
        are computed. TRUE: eia (Energy Internal Advected) fluxes always based
        on eint fluxes calculation. FALSE: eia fluxes always calculated based on
        advecting eint like any old mass scalar. Difference should matter only
        for ppmEintCompFluxConstructionMeth=0,4. Eia fluxes themselves only
        matter for cases B0,B1, or for E1 (with D2 or D3).
    hy_3Ttry_B [INTEGER] [2]
        Valid Values: 0, 1, 2
        How to deal with "work" term
    hy_3Ttry_B_rad [INTEGER] [-1]
        Valid Values: -1, 0, 1, 2
        How to deal with "work" term for radiation, i.e. for Erad, -1 means same
        as hy_3Ttry_B
    hy_3Ttry_D [REAL] [2.0]
        Valid Values: 0.0, 1.0, 1.5, 1.75, 1.875, 2.0, 3.0
        How to consolidate energies. Values: 0. Do not, 1. Trust Eele, discard
        Eion, 1.5 Trust Eele, discard Eion, 2. Trust combined Eint, recalibrate
        both components, etc.
    hy_3Ttry_E [INTEGER] [1]
        Valid Values: 1, 2
        How to recalibrate (if D2 or D3)
    hy_3Ttry_F [INTEGER] [2]
        Valid Values: 2, 3
        What to consolidate/recalibrate (if E2)
    hy_3Ttry_G [INTEGER] [1]
        Valid Values: 0, 1
        What to use for component P (if B1)
    hy_3Ttry_Q [INTEGER] [0]
        Valid Values: 0 to 2
        Whether to implement preferential allocation of shock heating (over and
        above heating through adiabatic compression) to ions; 2 for additional
        debug info from rieman.
    hy_dbgReconstConsvSele [BOOLEAN] [FALSE]
        whether to reconstruct electron entropy ("Sele") in conservative form.
    hy_eosModeAfter [STRING] ["dens_ie_gather"]
        Valid Values: "dens_ie", "dens_pres", "dens_temp", "dens_ie_all",
        "dens_ie_scatter", "dens_ie_gather", "dens_ie_sele_gather",
        "dens_ie_shocksele_gather", "dens_temp_equi", "dens_temp_all",
        "dens_temp_gather"
        Eos mode to apply at the end of a hydro sweep, after hy_ppm_updateSoln
        is done.  This is currently ONLY used with multiTemp, and ignored
        otherwise! Some meaningful choices are (1): == eosMode (traditional),
        (2): "dens_ie_sele_gather" for MODE_DENS_EI_SELE_GATHER.

physics/Hydro/HydroMain/split/RHD
    reconType [INTEGER] [2]
        Valid Values: Unconstrained
        Order of reconstruction
    small [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value
    smalle [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value for energy
    smallp [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value for pressure
    smallt [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value for temperature
    smallu [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value for velocity
    smallx [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value for abundances
    smlrho [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value for density

physics/Hydro/HydroMain/unsplit
    EOSforRiemann [BOOLEAN] [FALSE]
        Call EOS to get gamc and game for the Riemann state calculations
    LimitedSlopeBeta [REAL] [1.0]
        Valid Values: Unconstrained
        Any real value specific for the Limited Slope limiter
    RiemannSolver [STRING] ["Roe"]
        Valid Values: Unconstrained
        Roe, HLL, HLLC, Marquina, MarquinaModified, Hybrid or local
        Lax-Friedrichs, plus HLLD for MHD
    addThermalFlux [BOOLEAN] [TRUE]

    charLimiting [BOOLEAN] [TRUE]
        Apply limiting for characteristic variable
    cvisc [REAL] [0.1]
        Valid Values: Unconstrained

    entropy [BOOLEAN] [FALSE]
        Entropy Fix routine for the Roe Riemann solver
    entropyFixMethod [STRING] ["HARTENHYMAN"]
        Valid Values: Unconstrained
        Entropy fix method for the Roe Riemann solver: Harten or HartenHyman
    irenorm [INTEGER] [0]
        Valid Values: Unconstrained
        Renormalize abundances
    order [INTEGER] [2]
        Valid Values: Unconstrained
        1st order Godunov scheme, 2nd MUSCL-Hancock scheme, or 3rd PPM, 5th WENO
    shockDetect [BOOLEAN] [FALSE]
        Switch to use a strong compressive shock detection
    slopeLimiter [STRING] ["vanLeer"]
        Valid Values: Unconstrained
        mc, vanLeer, minmod, hybrid, limited
    small [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value
    smalle [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value for energy
    smallp [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value for pressure
    smallt [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value for temperature
    smallu [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value for velocity
    smallx [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value for abundances
    smlrho [REAL] [1.E-10]
        Valid Values: Unconstrained
        Cutoff value for density
    tiny [REAL] [1.e-16]
        Valid Values: Unconstrained
        A threshold value for an arbitrarily small number
    transOrder [INTEGER] [1]
        Valid Values: Unconstrained
        order of approximating transeverse flux derivative in data
        reconstruction
    use_3dFullCTU [BOOLEAN] [TRUE]
        Turn on/off the full CTU scheme that gives CFL <= 1 for 3D
    use_GravPotUpdate [BOOLEAN] [FALSE]
        Parameter for half timestep update of gravitational potential
    use_avisc [BOOLEAN] [FALSE]

    use_flattening [BOOLEAN] [FALSE]
        Switch for PPM flattening
    use_gravConsv [BOOLEAN] [FALSE]
        Use conservative variables for gravity coupling at n+1/2
    use_gravHalfUpdate [BOOLEAN] [FALSE]
        Include gravitational accelerations to hydro coupling at n+1/2
    use_hybridOrder [BOOLEAN] [FALSE]
        Apply RH jump condition to check monotonicity of reconstructed values
    use_steepening [BOOLEAN] [FALSE]
        Switch for steepening contact discontinuities for 3rd order PPM
    use_upwindTVD [BOOLEAN] [FALSE]
        Turn on/off upwinding TVD slopes

physics/Hydro/HydroMain/unsplit/Hydro_Unsplit/multiTemp
    hy_3Ttry_B [INTEGER] [0]
        Valid Values: 0, 1, 2
        How to deal with component energy "work" term
    hy_3Ttry_D [REAL] [2.0]
        Valid Values: 0.0, 2.0, 3.0
        How to consolidate energies. Values: 0. Do not, 1. Trust Eele, discard
        Eion, 1.5 Trust Eele, discard Eion, 2. Trust combined Eint, recalibrate
        both components.
    hy_3Ttry_E [INTEGER] [1]
        Valid Values: 1, 2
        How to recalibrate component energy (if D2)
    hy_3Ttry_F [INTEGER] [2]
        Valid Values: 2, 3
        What to consolidate/recalibrate (if E2)
    hy_3Ttry_G [INTEGER] [1]
        Valid Values: 0, 1
        What to use for component P (if B1)
    hy_eosModeAfter [STRING] ["dens_ie_gather"]
        Valid Values: "dens_ie", "dens_pres", "dens_temp", "dens_ie_all",
        "dens_ie_scatter", "dens_ie_gather", "dens_ie_sele_gather",
        "dens_temp_equi", "dens_temp_all", "dens_temp_gather"
        Eos mode to apply at the end of a state advance, before Hydro returns.
        This is currently ONLY used with multiTemp, and ignored otherwise! Some
        meaningful choices are (1): == eosMode (traditional), (2):
        "dens_ie_sele_gather" for MODE_DENS_EI_SELE_GATHER.

physics/Hydro/HydroMain/unsplit/MHD_StaggeredMesh
    E_modification [BOOLEAN] [TRUE]
        Switch for modified electric fields calculation from flux
    E_upwind [BOOLEAN] [FALSE]
        Switch for upwind update for induction equations
    ForceHydroLimit [BOOLEAN] [FALSE]
        Switch to force B=0 limit, i.e., the solver will not update B fields
    energyFix [BOOLEAN] [FALSE]
        Switch for an energy correction for CT scheme
    facevar2ndOrder [BOOLEAN] [TRUE]
        Switch to use 2nd order data reconstruction-evolution of facevars
    hy_bier1TA [REAL] [-1.0]
        Valid Values: Unconstrained
        Atomic number to use for 1T Biermann Battery term
    hy_bier1TZ [REAL] [-1.0]
        Valid Values: Unconstrained
        Ionization number to use for 1T Biermann Battery term
    hy_biermannCoef [REAL] [1.0]
        Valid Values: Unconstrained

    hy_biermannSource [BOOLEAN] [FALSE]
        Switch to implement battery term as an external source
    killdivb [BOOLEAN] [TRUE]
        Switch for maintaing solenoidal field
    prolMethod [STRING] ["INJECTION_PROL"]
        Valid Values: Unconstrained
        Injection or Balsara's method in prolongation
    use_Biermann [BOOLEAN] [FALSE]
        Switch to add the Battery term for B-field generation
    use_Biermann1T [BOOLEAN] [FALSE]
        Switch to add the 1T Battery term for B-field generation