Updated wind perscriptions

.dictionary.txt

@@ -13,3 +13,5 @@ accreting
 accrete
 accreted
 YHe
+yhe
+

.github/workflows/precommit-checks.yml

@@ -7,8 +7,8 @@ jobs:
   pre-commit:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-python@v2
-    - uses: pre-commit/[email protected]
-
-
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v4
+      with:
+        python-version: 3.8
+    - uses: pre-commit/[email protected]

.pre-commit-config.yaml

@@ -5,4 +5,4 @@ repos:
     rev: v2.2.4
     hooks:
     -   id: codespell # Spellchecker
-        args: [-L, nd, --ignore-words=.dictionary.txt, --skip, '*.eps,*.svg,*.ipynb,./misc/*,paper.md,./online-docs/index.rst']
+        args: [--ignore-words=.dictionary.txt, --skip, '*.eps,*.svg,*.ipynb,./misc/*,paper.md,./online-docs/index.rst']

compas_python_utils/preprocessing/compasConfigDefault.yaml

@@ -1,5 +1,5 @@
 ##~!!~## COMPAS option values
-##~!!~## File Created Mon Jun 26 10:54:22 2023 by COMPAS v02.38.08
+##~!!~## File Created Wed Nov  1 11:25:11 2023 by COMPAS v02.40.00
 ##~!!~##
 ##~!!~## The default COMPAS YAML file (``compasConfigDefault.yaml``), as distributed, has
 ##~!!~## all COMPAS option entries commented so that the COMPAS default value for the
@@ -96,7 +96,7 @@ numericalChoices:
 #    --rotational-frequency: 0.000000                                      # Default: 0.000000
 #    --rotational-frequency-1: 0.000000                                    # Default: 0.000000
 #    --rotational-frequency-2: 0.000000                                    # Default: 0.000000
-#    --wolf-rayet-multiplier: 0.100000                                     # Default: 0.100000
+#    --wolf-rayet-multiplier: 1.000000                                     # Default: 1.000000
 
     ### BINARY PROPERTIES
 #    --eccentricity: 0.000000                                              # Default: 0.000000                                                                                                                                                           # eccentricity for BSE
@@ -213,7 +213,11 @@ stringChoices:
 #    --envelope-state-prescription: 'LEGACY'                               # Default: 'LEGACY'                      # Options: ['FIXED_TEMPERATURE','HURLEY','LEGACY']
 #    --initial-mass-function: 'KROUPA'                                     # Default: 'KROUPA'                      # Options: ['KROUPA','UNIFORM','POWERLAW','SALPETER']
 #    --luminous-blue-variable-prescription: 'HURLEY_ADD'                   # Default: 'HURLEY_ADD'                  # Options: ['BELCZYNSKI','HURLEY','HURLEY_ADD','NONE']
-#    --mass-loss-prescription: 'VINK'                                      # Default: 'VINK'                        # Options: ['VINK','HURLEY','NONE']
+#    --mass-loss-prescription: 'FLEXIBLE2023'                              # Default: 'FLEXIBLE2023'                # Options: ['FLEXIBLE2023','BELCZYNSKI2010','HURLEY','NONE']
+#    --OB-mass-loss: 'VINK2021'                                            # Default: 'VINK2021'                    # Options: ['KRTICKA2018','BJORKLUND2022','VINK2021','VINK2001','NONE']
+#    --RSG-mass-loss: 'DECIN2023'                                          # Default: 'DECIN2023'                   # Options: ['NJ90','KEE2021','YANG2023','DECIN2023','BEASOR2020','VINKSABHAHIT2023','NONE']
+#    --VMS-mass-loss: 'SABHAHIT2023'                                       # Default: 'SABHAHIT2023'                # Options: ['SABHAHIT2023','BESTENLEHNER2020','VINK2011','NONE']
+#    --WR-mass-loss: 'SANDERVINK2023'                                      # Default: 'SANDERVINK2023'              # Options: ['SHENAR2019','SANDERVINK2023','BELCZYNSKI2010']
 #    --metallicity-distribution: 'ZSOLAR'                                  # Default: 'ZSOLAR'                      # Options: ['LOGUNIFORM','ZSOLAR']
 #    --pulsational-pair-instability-prescription: 'MARCHANT'               # Default: 'MARCHANT'                    # Options: ['FARMER','MARCHANT','STARTRACK','COMPAS']
 

misc/examples/methods_paper_plots/detailed_evolution/example_bbh_compas_config.yaml

@@ -183,7 +183,7 @@ stringChoices:
     --envelope-state-prescription: 'LEGACY'
     --initial-mass-function: 'KROUPA'
     --luminous-blue-variable-prescription: 'HURLEY_ADD'
-    --mass-loss-prescription: 'VINK'
+    --mass-loss-prescription: 'FLEXIBLE2023'
     --metallicity-distribution: 'ZSOLAR'
     --pulsational-pair-instability-prescription: 'MARCHANT'
     ### BINARY PROPERTIES

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

@@ -935,6 +935,12 @@ Default = 10
 
 :ref:`Back to Top <options-props-top>`
 
+**--OB-mass-loss** |br|
+Main sequence mass loss prescription. |br|
+Options: { NONE, VINK2001, VINK2021, BJORKLUND2022, KRTICKA2018 } |br|
+NONE turns off mass loss for main sequence stars. Also available are Vink (2001, previous default), Vink (2021), Bjorklund (2022), and Krticka (2018).   |br|
+Default = VINK2021
+
 **--orbital-period** |br|
 Initial orbital period for a binary star when evolving in BSE mode (days). |br|
 Used only if the semi-major axis is not specified via ``--semi-major-axis``. |br|
@@ -1101,6 +1107,12 @@ Options: { ZERO, HURLEY, VLTFLAMES } |br|
 ``ZERO`` sets all initial rotational velocities to 0, while ``HURLEY`` and ``VLTFLAMES`` sample them from the Hurley, Pols, Tout (2000) and Ramirez-Agudelo et al. (2013,2015), respectively |br|
 Default = ZERO
 
+**--RSG-mass-loss** |br|
+Red supergiant mass loss prescription. |br|
+Options: { NONE, VINKSABHAHIT2023, BEASOR2020, DECIN2023, YANG2023, KEE2021, NJ90 } |br|
+NONE turns off mass loss for giant (CHeB, FGB, AGB, TPAGB stellar types) stars below the RSG_MAXIMUM_TEMP. Also available are Vink and Sabhahit (2023), Beasor et al. (2020), Decin et al. (2023), Yang et al. (2023), Kee et. al (2021), and Nieuwenhuijzen and de Jager (1990, previous default).   |br|
+Default = DECIN2023
+
 .. _options-props-S:
 
 :ref:`Back to Top <options-props-top>`
@@ -1169,6 +1181,12 @@ Default = TRUE
 **--version [ -v ]** |br|
 Prints COMPAS version string.
 
+**--VMS-mass-loss** |br|
+Very massive main sequence mass loss prescription. |br|
+Options: { NONE, VINK2011, SABHAHIT2023, BESTENLEHNER2020 } |br|
+Applied above the VERY_MASSIVE_MINIMUM_MASS (100 Msol by default). NONE turns off mass loss. Also available are Vink (2011), Bestenlehner (2020), and Sabhahit (2023).   |br|
+Default = SABHAHIT2023
+
 .. _options-props-W:
 
 :ref:`Back to Top <options-props-top>`
@@ -1178,6 +1196,12 @@ Multiplicative constant for Wolf Rayet winds. Note that wind mass loss will also
 ``overall-wind-mass-loss-multiplier``. |br|
 Default = 1.0
 
+**--WR-mass-loss** |br|
+Wolf-Rayet mass loss prescription. |br|
+Options: { BELCZYNSKI2010, SANDERVINK2023, SHENAR2019 } |br|
+Selects between Belczynski (2010), Sander and Vink (2021 updated), and Shenar (2019).   |br|
+Default = SANDERVINK2023
+
 .. _options-props-X:
 .. _options-props-Y:
 
@@ -1235,7 +1259,8 @@ Go to :ref:`the top of this page <options-props-top>` for the full alphabetical
 
 --use-mass-loss, --check-photon-tiring-limit, --cool-wind-mass-loss-multiplier, --luminous-blue-variable-prescription, 
 --luminous-blue-variable-multiplier, --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,
+--OB-mass-loss, --RSG-mass-loss, --VMS-mass-loss, --WR-mass-loss
 
 --chemically-homogeneous-evolution
 

online-docs/pages/whats-new.rst

@@ -6,6 +6,15 @@ Following is a brief list of important updates to the COMPAS code.  A complete r
 
 **LATEST RELEASE** |br|
 
+**02.40.00 Oct 20, 2023**
+
+* Added ``FLEXIBLE2023`` as a new default, and ``BELCZYNSKI2010`` as a replacement for the previous ``VINK`` mass loss prescription. The following new sub-wrappers are overridden when selecting ``BELCZYNSKI2010``:
+* Added ``--OB-mass-loss`` program option, applying to main sequence stars, with default ``VINK2021``, and options ``NONE``, ``VINK2001`` (previous default), ``BJORKLUND2022``, and ``KRTICKA2018``.
+* Added ``--RSG-mass-loss`` program option, applying to stars below 8kK in giant branch stellar types, with default ``DECIN2023``, and options ``NONE``, ``VINISABHAHIT2023``, ``BEASOR2020``, ``YANG2023``, ``KEE2021``, ``NJ90`` (previous default).
+* Added ``--VMS-mass-loss`` program option, applying to stars over 100 Msol, with default ``SABHAHIT2023``, and options ``NONE``, ``VINK2011``, and ``BESTENLEHNER2020``.
+* Added ``--WR-mass-loss`` program option, with default ``SANDERVINK2023``, and options ``BELCZYNSKI2010``, and ``SHENAR2019``.
+* Changed default value for option ``--wolf-rayet-multiplier`` from 0.1 to 1.0
+
 **02.39.00 Jul 4, 2023**
 
 * Added 'Evolution_Status' columns to both SSE and BSE default system parameters records - records final status of evolution (reason evolution stopped).