Docs update

Author: Ilya Mandel

compas_python_utils/preprocessing/compasConfigDefault.yaml

@@ -1,5 +1,5 @@
 ##~!!~## COMPAS option values
-##~!!~## File Created Thu Oct 23 15:46:49 2025 by COMPAS v03.26.01
+##~!!~## File Created Mon Oct 27 09:51:18 2025 by COMPAS v03.26.02
 ##~!!~##
 ##~!!~## The default COMPAS YAML file (``compasConfigDefault.yaml``), as distributed, has
 ##~!!~## all COMPAS option entries commented so that the COMPAS default value for the
@@ -29,7 +29,7 @@ booleanChoices:
 #    --enhance-CHE-lifetimes-luminosities: True                            # Default: True
 #    --expel-convective-envelope-above-luminosity-threshold: False         # Default: False
 #    --natal-kick-for-PPISN: False                                         # Default: False
-#    --scale-CHE-mass-loss-with-surface-helium-abundance: True             # Default: True
+#    --scale-mass-loss-with-surface-helium-abundance: True                 # Default: True
 
     ### BINARY PROPERTIES
 #    --allow-touching-at-birth: False                                      # Default: False                                                                                                                                                                            # record binaries that have stars touching at birth in output files
@@ -57,6 +57,7 @@ booleanChoices:
 #    --allow-non-stripped-ECSN: False                                      # Default: False
 #    --pair-instability-supernovae: True                                   # Default: True
 #    --pulsational-pair-instability: True                                  # Default: True
+#    --USSN-kicks-override-Mandel-Muller: False                            # Default: False
 
     ### PULSAR PARAMETERS
 #    --evolve-pulsars: False                                               # Default: False

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

@@ -1319,9 +1319,9 @@ Default = DECIN2023 |br|
 
 :ref:`Back to Top <options-props-top>`
 
-**--scale-CHE-mass-loss-with-surface-helium-abundance** |br|
-Scale mass loss for chemically homogeneously evolving (CHE) stars with the surface helium abundance. 
-Transition from OB to WR mass loss towards the end of the main sequence.
+**--scale-mass-loss-with-surface-helium-abundance** |br|
+Scale mass loss for main sequence, including chemically homogeneously evolving (CHE), stars with the surface helium abundance. 
+Transition from OB/VMS to WR mass loss towards the end of the main sequence.
 Default = TRUE
 
 **--scale-terminal-wind-velocity-with-metallicity-power** |br|
@@ -1431,6 +1431,10 @@ This option is primarily intended for debugging/testing of convergence issues ra
 Enable mass transfer. |br|
 Default = TRUE
 
+**--USSN-kicks-overwrite-mandel-muller** |br|
+Use user-defined USSN kicks (as a fixed value) in lieu of the Mandel & Muller kick prescription for USSNe. |br|
+Default = FALSE
+
 .. _options-props-V:
 
 :ref:`Back to Top <options-props-top>`
@@ -1531,7 +1535,7 @@ Go to :ref:`the top of this page <options-props-top>` for the full alphabetical
 
 --check-photon-tiring-limit, --cool-wind-mass-loss-multiplier, --luminous-blue-variable-prescription, --LBV-mass-loss-prescription
 --luminous-blue-variable-multiplier, --main-sequence-core-mass-prescription, --mass-loss-prescription, --overall-wind-mass-loss-multiplier, --wolf-rayet-multiplier, 
---expel-convective-envelope-above-luminosity-threshold, --luminosity-to-mass-threshold,
+--expel-convective-envelope-above-luminosity-threshold, --luminosity-to-mass-threshold, --scale--mass-loss-with-surface-helium-abundance
 --OB-mass-loss, --OB-mass-loss-prescription, --RSG-mass-loss, --RSG-mass-loss-prescription, --VMS-mass-loss, --vms-mass-loss-prescription, --WR-mass-loss, --WR-mass-loss-prescription
 
 --chemically-homogeneous-evolution, --chemically-homogeneous-evolution-mode
@@ -1583,8 +1587,8 @@ Go to :ref:`the top of this page <options-props-top>` for the full alphabetical
 --kick-magnitude-distribution, --kick-magnitude-sigma-CCSN-BH, --kick-magnitude-sigma-CCSN-NS, --kick-magnitude-sigma-ECSN, --kick-magnitude-sigma-USSN, 
 --black-hole-kicks, --black-hole-kicks-mode, --fix-dimensionless-kick-magnitude, --kick-magnitude, --kick-magnitude-1, --kick-magnitude-2, --kick-magnitude-min, --kick-magnitude-max, 
 --kick-magnitude-random, --kick-magnitude-random-1, --kick-magnitude-random-2, --kick-scaling-factor, -muller-mandel-kick-multiplier-BH, 
---muller-mandel-kick-multiplier-NS, --muller-mandel-sigma-kick-BH, --muller-mandel-sigma-kick-NS, --kick-direction, 
---kick-direction-distribution, --kick-direction-power, --kick-mean-anomaly-1, --kick-mean-anomaly-2, --kick-phi-1, --kick-phi-2, --kick-theta-1, --kick-theta-2
+--muller-mandel-kick-multiplier-NS, --muller-mandel-sigma-kick-BH, --muller-mandel-sigma-kick-NS, --USSN-kicks-overwrite-mandel-muller, 
+--kick-direction, --kick-direction-distribution, --kick-direction-power, --kick-mean-anomaly-1, --kick-mean-anomaly-2, --kick-phi-1, --kick-phi-2, --kick-theta-1, --kick-theta-2
 
 :ref:`Back to Top <options-props-top>`
 

online-docs/pages/whats-new.rst

@@ -3,6 +3,11 @@ What's new
 
 Following is a brief list of important updates to the COMPAS code.  A complete record of changes can be found in the file ``changelog.h``.
 
+**03.26.02 October 27, 2025**
+
+* Added option --USSN-kicks-overwrite-mandel-muller ; if set to true, use user-defined USSN kicks (as a fixed value) in lieu of the Mandel & Muller kick prescription for USSNe
+* Replaced --scale-CHE-mass-loss-with-surface-helium-abundance with the more general --scale-mass-loss-with-surface-helium-abundance (applies to all MS stars, not just CHE stars)
+
 **03.26.00 September 2, 2025**
 
 * Added HAMSTARS mass transfer efficiency prescription

src/changelog.h

@@ -1669,9 +1669,9 @@
 //                                          - Corrected errors in combining OB and WR winds in CH::CalculateMassLossRateBelczynski2010(), CalculateMassLossRateMerritt2025() and CH::CalculateMassLossFractionOB() [previously CalculateMassLossRateWeightOB()]
 //  03.26.01  AB - October 24, 2025     - Option name change:
 //                                          - Main sequence core mass prescription ZERO renamed to HURLEY; deprecated ZERO
-//  03.26.02  IM - October 26, 2025     - Enhancements
-//                                          - Added option -USSN-kicks-overwrite-mandel-muller ; if set to true, use user-defined USSN kicks (as a fixed value) in lieu of the Mandel & Muller kick prescription for USSNe
-//                                          - Replaced --scale-CHE-mass-loss-with-surface-helium-abundance with the more general --scale-mass-loss-with-surface-helium-abundance
+//  03.26.02  IM - October 27, 2025     - Enhancements
+//                                          - Added option --USSN-kicks-overwrite-mandel-muller ; if set to true, use user-defined USSN kicks (as a fixed value) in lieu of the Mandel & Muller kick prescription for USSNe
+//                                          - Replaced --scale-CHE-mass-loss-with-surface-helium-abundance with the more general --scale-mass-loss-with-surface-helium-abundance (applies to all MS stars, not just CHE stars)
 //                                          - Updated rotational velocity solver to use boost root finder
 //
 // Version string format is MM.mm.rr, where