Skip to content

Commit 4df6970

Browse files
committed
Missed a couple of docs edits
1 parent 530fe84 commit 4df6970

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

online-docs/pages/User guide/Program options/program-options-list-defaults.rst

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -832,6 +832,20 @@ Options: { ZERO, HURLEY, BELCZYNSKI2010, MERRITT2025 } |br|
832832
``BELCZYNSKI2010``: Mass loss as per Belczynski (2010), and the default prior to 2023 |br|
833833
``MERRITT2025`` : Flexible mass loss with phase specific options: (OB, RSG, WR, VMS) |br|
834834
Default = MERRITT2025 |br|
835+
|br|
836+
Note that setting this option to ``ZERO`` can have unexpected consequences, e.g., TPAGB stars that are prevented from losing
837+
mass cannot become white dwarfs, so will become massless remnants. This is a useful option for testing, but this setting is
838+
not recommended for production. It is better to use specific wind prescription controls, such as: |br|
839+
|br|
840+
``--cool-wind-mass-loss-multiplier`` |br|
841+
``--overall-wind-mass-loss-multiplier`` |br|
842+
``--wolf-rayet-multiplier`` |br|
843+
``--luminous-blue-variable-multiplier`` |br|
844+
``--LBV-mass-loss-prescription`` |br|
845+
``--OB-mass-loss-prescription`` |br|
846+
``--RSG-mass-loss-prescription`` |br|
847+
``--VMS-mass-loss-prescription`` |br|
848+
``--WR-mass-loss-prescription`` |br|
835849

836850
**--mass-ratio [ -q ]** |br|
837851
Mass ratio :math:`\frac{m2}{m1}` used to determine secondary mass if not specified via ``--initial-mass-2``. |br|
@@ -1399,19 +1413,6 @@ This option is primarily intended for debugging/testing of convergence issues ra
13991413

14001414
:ref:`Back to Top <options-props-top>`
14011415

1402-
**--use-mass-loss** |br|
1403-
Enable mass loss through winds. |br|
1404-
Default = TRUE
1405-
Note that setting this option to FALSE can have unexpected consequences, e.g., TPAGB stars that are prevented from losing mass
1406-
cannot become white dwarfs, so will become massless remnants. This is a useful option for testing, but this setting is not recommended
1407-
for production. It is better to use specific wind prescription controls, such as: |br|
1408-
``--cool-wind-mass-loss-multiplier`` |br|
1409-
``--LBV-mass-loss-prescription`` |br|
1410-
``--luminous-blue-variable-multiplier`` |br|
1411-
``--mass-loss-prescription`` |br|
1412-
``--overall-wind-mass-loss-multiplier`` |br|
1413-
``--wolf-rayet-multiplier`` |br|
1414-
14151416
**--use-mass-transfer** |br|
14161417
Enable mass transfer. |br|
14171418
Default = TRUE

0 commit comments

Comments
 (0)