Skip to content

docs: fix stale default-off comments for RPS / precipitation regulation #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MBradley1985 merged 1 commit into from
Jul 5, 2026
Merged

docs: fix stale default-off comments for RPS / precipitation regulation #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ optional parameters take the listed default if omitted.
| `BulgeSizeOn` | int | no | `3` | Bulge radius model: 0=off; 1=Shen+2003 eq.33; 2=Shen+2003 eq.32; 3=Tonini+2016 (separate merger and instability channels, mass-weighted average). |
| `StarburstColdGasOn` | 0/1 | no | `1` | Include cold gas contribution during merger starbursts. |
| `DynamicDisruptionSplit` | int | no | `2` | ICS-vs-BCG split for disrupted satellite stellar mass: 0=fixed fraction `FractionDisruptedToICS`; 1=mass-ratio split `f_ICS = 1 - (infallMvir / Mhost)^DisruptionSplitAlpha`; 2=mass-ratio split with concentration weighting (`alpha_eff = DisruptionSplitAlpha * DisruptionSplitCref / c_sat`). |
| `RamPressureStrippingOn` | 0/1 | no | `0` | Gunn & Gott (1972) ram-pressure stripping of satellite cold gas (ISM): 0=off (baseline unchanged); 1=on. Independent of the hot-gas (starvation) stripping controlled by `PhysicalStrippingOn`; see `docs/physics/infall.md`. |
| `RamPressureStrippingOn` | 0/1 | no | `1` | Gunn & Gott (1972) ram-pressure stripping of satellite cold gas (ISM): 1=on (default); 0=off. Independent of the hot-gas (starvation) stripping controlled by `PhysicalStrippingOn`; see `docs/physics/infall.md`. |
| `RamPressureEpsilon` | double | no | `1.0` | Order-unity prefactor on the ram pressure `P_ram = eps * rho_host * v_sat^2`, absorbing the disk-orientation geometry uncertainty. Used only when `RamPressureStrippingOn=1`. |

---
Expand All @@ -82,6 +82,7 @@ optional parameters take the listed default if omitted.
|-----------|------|----------|---------|-------------|
| `CGMDensityProfile` | int | no | `0` | CGM gas density profile for precipitation: 0=uniform; 1=NFW; 2=beta (β=2/3). |
| `CGMAGNOn` | 0/1 | no | `1` | Enable AGN heating coupling to the CGM-regime cooling path. |
| `PrecipRegulationOn` | 0/1 | no | `1` | Self-regulating precipitation: 1=on (default) condenses only the CGM above the `tcool/tff = 10` Voit equilibrium, so the flow relaxes to equilibrium instead of draining the reservoir at the free-fall rate; 0=off (legacy free-fall drain). See `cooling_recipe_cgm` in `src/model_cooling_heating.c`. |

---

Expand Down
6 changes: 3 additions & 3 deletions docs/physics/infall.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,8 +133,8 @@ hot reservoir and are skipped.

## `ram_pressure_strip_satellite()` -- ram-pressure stripping of the ISM

Enabled by `RamPressureStrippingOn = 1` (default 0, which leaves the
calibrated baseline output byte-identical). Where `strip_from_satellite()`
Controlled by `RamPressureStrippingOn` (default 1, on); set 0 for the
legacy no-ISM-stripping behaviour. Where `strip_from_satellite()`
removes a satellite's *hot-phase* gas (starvation), this channel removes the
*ISM* (`ColdGas`) directly, following Gunn & Gott (1972): disk gas at radius
r is stripped where the ram pressure of the host's ambient medium exceeds
Expand Down Expand Up @@ -194,7 +194,7 @@ against the calibration.
| `ReIncorporationFactor` | Sets `Vcrit` for the reincorporation cutoff. Larger values delay reincorporation in low-mass halos. |
| `CGMrecipeOn` | Routes infall, reincorporation, and satellite CGM by regime when set. |
| `TrackICSAssembly` | Records satellite-derived ICS mass into `ICS_accrete` for the central. |
| `RamPressureStrippingOn` | 1 enables Gunn & Gott (1972) ram-pressure stripping of satellite `ColdGas`; 0 (default) leaves the baseline unchanged. |
| `RamPressureStrippingOn` | 1 (default) enables Gunn & Gott (1972) ram-pressure stripping of satellite `ColdGas`; 0 disables it. |
| `RamPressureEpsilon` | Order-unity prefactor on `P_ram = eps * rho_host * v_sat^2` (disk-orientation geometry uncertainty); default 1.0. |

See [`parameters.md`](../parameters.md) for full descriptions and defaults.
Expand Down
2 changes: 1 addition & 1 deletion src/core_allvars.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -519,7 +519,7 @@ struct params
double StrippingTimescaleFactor; // calibration prefactor on the satellite-stripping timescale: t_strip = factor * t_dyn(host); default 1.0. Only used by physical schemes (PhysicalStrippingOn 1/2). Larger = slower stripping.
int32_t RamPressureStrippingOn; // 1 = on (DEFAULT): Gunn & Gott (1972) ram-pressure stripping of satellite ColdGas, applied once per snapshot (see model_ram_pressure.c). 0 = off. Independent of PhysicalStrippingOn, which strips the hot/CGM phase.
double RamPressureEpsilon; // order-unity prefactor on the ram pressure P_ram = eps * rho_host * v_sat^2; default 1.0. Absorbs the disk-orientation geometry uncertainty (face-on vs edge-on infall). Only used when RamPressureStrippingOn == 1.
int32_t PrecipRegulationOn; // 0 = off (DEFAULT; baseline unchanged): precipitation drains the whole CGM at the free-fall rate once tcool/tff < threshold. 1 = self-regulating: only the CGM above the tcool/tff = PRECIP_THRESHOLD equilibrium mass condenses, so the flow shuts off at the Voit equilibrium instead of emptying the reservoir (see cooling_recipe_cgm).
int32_t PrecipRegulationOn; // 1 = on (DEFAULT): self-regulating precipitation -- only the CGM above the tcool/tff = PRECIP_THRESHOLD equilibrium mass condenses, so the flow shuts off at the Voit equilibrium instead of emptying the reservoir (see cooling_recipe_cgm). 0 = off: precipitation drains the whole CGM at the free-fall rate once tcool/tff < threshold.
double DisruptionSplitAlpha; // Base exponent for mass-ratio dependence of ICL fraction (DynamicDisruptionSplit>=1)
double DisruptionSplitCref; // Reference concentration for concentration weighting (DynamicDisruptionSplit=2)
double RedshiftPowerLawExponent; /* exponent of the (1+z) term in the FIRE mass-loading scaling (Muratov+15); default 1.25 */
Expand Down
2 changes: 1 addition & 1 deletion src/model_ram_pressure.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
* M_strip = ColdGas * f_strip * (1 - exp(-dt/t_strip)) on the host stripping
* timescale, and donates the gas and its metals to the central's hot/CGM
* reservoir. It runs once per snapshot from evolve_galaxies() when
* RamPressureStrippingOn == 1 (default 0: no effect on the baseline).
* RamPressureStrippingOn == 1 (the default; set 0 to disable).
*
* This channel strips the ISM (ColdGas) and is complementary to and
* independent of PhysicalStrippingOn, which strips the satellite's hot/CGM
Expand Down
Loading