hydro - hyschive/gamer-fork GitHub Wiki
Related options: MODEL, FLU_SCHEME, LR_SCHEME, RSOLVER, DUAL_ENERGY, NCOMP_PASSIVE_USER, MHD, COSMIC_RAY, CR_DIFFUSION, EOS, BAROTROPIC_EOS
Parameters described on this page: OPT__BC_FLU_XM, OPT__BC_FLU_XP, OPT__BC_FLU_YM, OPT__BC_FLU_YP, OPT__BC_FLU_ZM, OPT__BC_FLU_ZP, GAMMA, MOLECULAR_WEIGHT, MU_NORM, ISO_TEMP, OPT__LR_LIMITER, MINMOD_COEFF, MINMOD_MAX_ITER, OPT__1ST_FLUX_CORR, OPT__1ST_FLUX_CORR_SCHEME, DUAL_ENERGY_SWITCH, OPT__SAME_INTERFACE_B, OPT__FIXUP_FLUX, OPT__FIXUP_ELECTRIC, OPT__FIXUP_RESTRICT, OPT__CORR_AFTER_ALL_SYNC, OPT__NORMALIZE_PASSIVE, OPT__INT_FRAC_PASSIVE_LR, OPT__RESET_FLUID, OPT__RESET_FLUID_INIT, OPT__FREEZE_FLUID, MIN_DENS, MIN_PRES, MIN_EINT, OPT__CHECK_PRES_AFTER_FLU, OPT__LAST_RESORT_FLOOR, JEANS_MIN_PRES, JEANS_MIN_PRES_LEVEL, JEANS_MIN_PRES_NCELL, GAMMA_CR, CR_DIFF_PARA, CR_DIFF_PERP, CR_DIFF_MIN_B
Other related parameters: DT__FLUID, DT__FLUID_INIT, DT__CR_DIFFUSION, AUTO_REDUCE_DT, FLU_GPU_NPGROUP, AUTO_REDUCE_MINMOD_FACTOR
Parameters below are shown in the format: β Name
β (Valid Values) β [Default Value]
-
-
Description:
Fluid boundary conditions on the -x face.
For the user-specified (i.e., inflow) boundary conditions, edit
src/Fluid/Flu_BoundaryCondition_User.cpp
for the cell-centered fluid variables andsrc/Model_Hydro/MHD_BoundaryCondition_User.cpp
for the face-centered magnetic field, respectively, when TESTPROB_ID=0 or a problem-specific function when TESTPROB_IDβ 0. - Restriction: When adopting periodic conditions, they must be applied to both the -x and +x faces. Particles only support the periodic boundary conditions. When adopting any non-periodic boundary condition for fluid, particles will be removed when getting too close to the boundaries (see PAR_REMOVE_CELL ).
-
Description:
Fluid boundary conditions on the -x face.
For the user-specified (i.e., inflow) boundary conditions, edit
-
- Description: Fluid boundary conditions on the +x face. See the description of OPT__BC_FLU_XM.
- Restriction: See the restriction on OPT__BC_FLU_XM.
-
- Description: Fluid boundary conditions on the -y face. See the description of OPT__BC_FLU_XM.
- Restriction: See the restriction on OPT__BC_FLU_XM.
-
- Description: Fluid boundary conditions on the +y face. See the description of OPT__BC_FLU_XM.
- Restriction: See the restriction on OPT__BC_FLU_XM.
-
- Description: Fluid boundary conditions on the -z face. See the description of OPT__BC_FLU_XM.
- Restriction: See the restriction on OPT__BC_FLU_XM.
-
- Description: Fluid boundary conditions on the +z face. See the description of OPT__BC_FLU_XM.
- Restriction: See the restriction on OPT__BC_FLU_XM.
-
- Description: Mean molecular weight.
- Restriction:
-
- Description: Normalization of MOLECULAR_WEIGHT.
- Restriction:
-
- Description: Temperature in kelvin for the isothermal equation of state.
-
Restriction:
Only applicable when adopting the compilation option
EOS=
EOS_ISOTHERMAL
.
-
OPT__LR_LIMITER
β (-1β set to default, 0=none, 1=van Leer, 2=generalized minmod, 3=van Albada, 4=van Leer+generalized minmod, 6=central, 7=Athena) β [-1]-
Description:
Slope limiter for data reconstruction. The coefficient of the
generalized minmod limiter can be set by MINMOD_COEFF.
7=Athena
mimics the extrema-preserving limiter implemented in Athena++. -
Restriction:
Only applicable when adopting the compilation option
FLU_SCHEME=
MHM/MHM_RP/CTU
.7=Athena
must work with LR_SCHEME=PPM
.
-
Description:
Slope limiter for data reconstruction. The coefficient of the
generalized minmod limiter can be set by MINMOD_COEFF.
-
- Description: Coefficient of the generalized minmod limiter for data reconstruction (OPT__LR_LIMITER=2/4). Smaller values lead to more diffusive but also more stable solutions.
- Restriction:
-
- Description: Maximum number of iterations to reduce MINMOD_COEFF when data reconstruction fails. It improves code stability but may break strict conservation.
- Restriction:
-
-
Description:
Correct unphysical results (e.g., negative density or pressure) by
recalculating the solutions of failed cells with only first-order
accuracy in space and time.
OPT__1ST_FLUX_CORR=1
: only use dimensionally unsplit update.OPT__1ST_FLUX_CORR=2
: use dimensionally unsplit update first; and if it fails, switch to dimensionally split update. The number of cells corrected by this option will be recorded in the file Record__NCorrUnphy. -
Restriction:
Only applicable when adopting the compilation option
FLU_SCHEME=MHM/MHM_RP/CTU.
MHD currently does not support
3D+1D
. Be aware that this option may cause conservation errors.
-
Description:
Correct unphysical results (e.g., negative density or pressure) by
recalculating the solutions of failed cells with only first-order
accuracy in space and time.
-
OPT__1ST_FLUX_CORR_SCHEME
β (<0 β set to default, 0=none, 1=Roe, 2=HLLC, 3=HLLE, 4=HLLD) β [1]-
Description:
Riemann solver for
OPT__1ST_FLUX_CORR
. - Restriction:
-
Description:
Riemann solver for
-
-
Description:
Switch threshold of the dual energy formalism. Specifically, we enable
the dual energy formalism for cells with
Eint/Ekin
β<β ΞΎ, where
Eint is gas internal energy,
Ekin is gas kinematic energy,
and ΞΎ=
DUAL_ENERGY_SWITCH
. - Restriction: Only applicable when enabling the compilation option DUAL_ENERGY.
-
Description:
Switch threshold of the dual energy formalism. Specifically, we enable
the dual energy formalism for cells with
Eint/Ekin
β<β ΞΎ, where
Eint is gas internal energy,
Ekin is gas kinematic energy,
and ΞΎ=
-
- Description: Ensure adjacent patches on the same level have exactly the same magnetic field on their shared interfaces (including round-off errors). This option is mainly for debugging purposes.
- Restriction:
-
- Description: Correct the coarse-grid data by the fluxes on the coarse-fine boundaries.
- Restriction:
-
- Description: Correct the coarse-grid magnetic field by the electric field on the coarse-fine boundaries.
- Restriction: For MHD only.
-
- Description: Correct the coarse-grid data by the volume-weighted average of the child patch data.
- Restriction:
-
-
Description:
Apply additional corrections when all levels are synchronized.
See
Fluid/Flu_CorrAfterAllSync.cpp
for details. This functionality is mainly for achieving bitwise reproducibility.OPT__CORR_AFTER_ALL_SYNC=1
: apply corrections after each root-level update.OPT__CORR_AFTER_ALL_SYNC=2
: apply corrections before each data dump. The default depends on the compilation option GAMER_DEBUG. - Restriction: Must be turned on when enabling the compilation option BITWISE_REPRODUCIBILITY.
-
Description:
Apply additional corrections when all levels are synchronized.
See
-
- Description: Renormalize passively advected scalars after every update to ensure that the sum of their mass fractions equals unity. See also Add Problem-specific Grid Fields and Particle Attributes.
- Restriction:
-
- Description: Convert specified passive scalars from mass density to fraction during data reconstruction. See also Add Problem-specific Grid Fields and Particle Attributes.
- Restriction:
-
-
Description:
Reset fluid variables after each update. It can be useful for adding
sources or sinks to a simulation. To specify how to reset fluid variables,
edit the source file
src/Fluid/Flu_ResetByUser.cpp
directly or add a specific routine to your test problem files. See Adding New Simulations for details. - Restriction:
-
Description:
Reset fluid variables after each update. It can be useful for adding
sources or sinks to a simulation. To specify how to reset fluid variables,
edit the source file
-
OPT__RESET_FLUID_INIT
β (<0 β set to OPT__RESET_FLUID, 0=off, 1=on) β [-1]- Description: Reset fluid variables during initialization. See OPT__RESET_FLUID for details.
- Restriction:
-
- Description: Do not evolve fluid variables at all. It can be useful for evolving particles in a static gravitational potential of fluid or wave dark matter.
- Restriction:
-
- Description: Check unphysical pressure at the end of the fluid solver. If it is off, the code will only check internal energy. This is particularly useful for a complicated equation of state.
- Restriction:
-
- Description: Apply floor values (e.g., MIN_DENS and MIN_EINT) when both OPT__1ST_FLUX_CORR and AUTO_REDUCE_DT fail. Always enable this option unless for debugging purposes.
- Restriction:
-
- Description: Gas mass density floor.
- Restriction:
-
- Description: Gas pressure floor.
- Restriction:
-
- Description: Gas internal energy density floor.
- Restriction:
-
- Description: Employ a pressure floor in the hydrodynamic solver to ensure that the local Jeans length of all cells on all levels is resolved by at least a width equal to JEANS_MIN_PRES_NCELL cells on level JEANS_MIN_PRES_LEVEL.
- Restriction: Only applicable when enabling the compilation option GRAVITY.
-
JEANS_MIN_PRES_LEVEL
β (β₯0; <0 β set to default) β [ MAX_LEVEL ]- Description: See JEANS_MIN_PRES.
- Restriction:
-
- Description: See JEANS_MIN_PRES.
- Restriction: Must be an integer.
-
- Description: Effective adiabatic index of cosmic rays.
- Restriction: Only applicable when enabling the compilation option COSMIC_RAY.
-
- Description: Cosmic-ray diffusion coefficient parallel to the magnetic field.
- Restriction: Only applicable when enabling the compilation option CR_DIFFUSION.
-
- Description: Cosmic-ray diffusion coefficient perpendicular to the magnetic field.
- Restriction: Only applicable when enabling the compilation option CR_DIFFUSION.
-
- Description: Disable cosmic-ray diffusion locally when the magnetic field amplitude is smaller than this threshold.
- Restriction: Only applicable when enabling the compilation option CR_DIFFUSION.