Modifications to Maltsev prescription (#1423)

* replaced muller mandel remnant masses with pseudo-NS masses for non-direct collapse

* simplified kiril model, in compas

* added 50% fallback

* cosmetic changes

* changed extrapolotion of maltsev remnant masses to be nearest neighbor, and added option for fallback fraction

* added rlof T and L

* added pre and post RLOF values for Teff, L in basebinarystar

* cleaned up Maltsev function

* fixed fallback setup for Maltsev BH kicks

* modified Kiril options

* cleanup

* fixed bug in upper limit of Maltsev variations

* removed print statements

* added Klencki linear AM loss prescription, variant of MacLeod linear

* fixed bug with klencki gamma

* minor fix for one of the Maltsev values

* removed code that wasn't specifically relevant to just the Maltsev modifications. These changes will be added to another PR

* comment cleanup

* typo fix

* changelog

* documentation

* typo

* fixed teffX and lumX to temperatureX and luminosityX for X in {1,2}

* forgot to update version in changelog

* new program options for maltsev model

* cleaned up MALTSEV treatment of NS masses, now all are the canonical NS mass

* yaml

* yaml

* teff -> temperature, lum -> luminosity

* Update GiantBranch.cpp - formatting

* changelog

* added constexpr and description of M1, M2, M3 for PR

* what's new

* what's new, more detail

* typo

* typo

---------

Co-authored-by: jeffriley <jeffrey.riley@monash.edu>

Author: reinhold-willcox

compas_python_utils/preprocessing/compasConfigDefault.yaml

@@ -1,5 +1,5 @@
 ##~!!~## COMPAS option values
-##~!!~## File Created Sun Aug 10 13:16:13 2025 by COMPAS v03.23.00
+##~!!~## File Created Mon Aug 18 13:37:46 2025 by COMPAS v03.23.02
 ##~!!~##
 ##~!!~## The default COMPAS YAML file (``compasConfigDefault.yaml``), as distributed, has
 ##~!!~## all COMPAS option entries commented so that the COMPAS default value for the
@@ -283,6 +283,8 @@ stringChoices:
 #    --fryer-supernova-engine: 'DELAYED'                                   # Default: 'DELAYED'                     # Options: ['DELAYED','RAPID']
 #    --kick-magnitude-distribution: 'MULLERMANDEL'                         # Default: 'MULLERMANDEL'                # Options: ['LOGNORMAL','MULLERMANDEL','MULLER2016MAXWELLIAN','MULLER2016','BRAYELDRIDGE','MAXWELLIAN','FLAT','FIXED','ZERO']
 #    --kick-direction-distribution: 'ISOTROPIC'                            # Default: 'ISOTROPIC'                   # Options: ['POLES','WEDGE','POWERLAW','PERPENDICULAR','INPLANE','ISOTROPIC']
+#    --maltsev-fallback: 0.500000                                          # Default: 0.500000
+#    --maltsev-mode: 'BALANCED'                                            # Default: 'BALANCED'                    # Options: ['PESSIMISTIC','BALANCED','OPTIMISTIC']
 #    --neutron-star-accretion-in-ce: 'ZERO'                                # Default: 'ZERO'                        # Options: ['DISK','SURFACE','ZERO']
 #    --neutron-star-equation-of-state: 'SSE'                               # Default: 'SSE'                         # Options: ['ARP3','SSE']
 #    --neutrino-mass-loss-BH-formation: 'FIXED_MASS'                       # Default: 'FIXED_MASS'                  # Options: ['FIXED_MASS','FIXED_FRACTION']

online-docs/pages/User guide/COMPAS output/standard-logfiles-record-specification-binary.rst

@@ -790,6 +790,38 @@ Binary Properties
    * - Header String:
      - SemiMajorAxis>MT
 
+.. flat-table::
+   :widths: 25 75 1 1
+   :header-rows: 0
+   :class: aligned-text
+
+   * - :cspan:`2` **RLOF_POST_MT_STAR1_LUM**
+     -
+   * - Data type:
+     - DOUBLE
+   * - COMPAS variable:
+     - BaseBinaryStar::m_RLOFDetails.propsPostMT→luminosity1
+   * - Description:
+     - Luminosity (\ :math:`L_\odot`) of the primary immediately after RLOF.
+   * - Header String:
+     - Lum(1)>MT
+
+.. flat-table::
+   :widths: 25 75 1 1
+   :header-rows: 0
+   :class: aligned-text
+
+   * - :cspan:`2` **RLOF_POST_MT_STAR2_LUM**
+     -
+   * - Data type:
+     - DOUBLE
+   * - COMPAS variable:
+     - BaseBinaryStar::m_RLOFDetails.propsPostMT→luminosity2
+   * - Description:
+     - Luminosity (\ :math:`L_\odot`) of the secondary immediately after RLOF.
+   * - Header String:
+     - Lum(2)>MT
+
 .. flat-table::
    :widths: 25 75 1 1
    :header-rows: 0
@@ -854,6 +886,38 @@ Binary Properties
    * - Header String:
      - Radius(2)>MT
 
+.. flat-table::
+   :widths: 25 75 1 1
+   :header-rows: 0
+   :class: aligned-text
+
+   * - :cspan:`2` **RLOF_POST_MT_STAR1_TEFF**
+     -
+   * - Data type:
+     - DOUBLE
+   * - COMPAS variable:
+     - BaseBinaryStar::m_RLOFDetails.propsPostMT→temperature1
+   * - Description:
+     - Effective temperature (\ :math:`K`) of the primary immediately after RLOF.
+   * - Header String:
+     - Teff(1)>MT
+
+.. flat-table::
+   :widths: 25 75 1 1
+   :header-rows: 0
+   :class: aligned-text
+
+   * - :cspan:`2` **RLOF_POST_MT_STAR2_TEFF**
+     -
+   * - Data type:
+     - DOUBLE
+   * - COMPAS variable:
+     - BaseBinaryStar::m_RLOFDetails.propsPostMT→temperature2
+   * - Description:
+     - Effective temperature (\ :math:`K`) of the secondary immediately after RLOF.
+   * - Header String:
+     - Teff(2)>MT
+
 .. flat-table::
    :widths: 25 75 1 1
    :header-rows: 0
@@ -1026,6 +1090,39 @@ but not both. If both are printed then the file will contain two columns with th
    * - Header String:
      - SemiMajorAxis<MT
 
+.. flat-table::
+   :widths: 25 75 1 1
+   :header-rows: 0
+   :class: aligned-text
+
+   * - :cspan:`2` **RLOF_PRE_MT_STAR1_LUM**
+     -
+   * - Data type:
+     - DOUBLE
+   * - COMPAS variable:
+     - BaseBinaryStar::m_RLOFDetails.propsPreMT→luminosity1
+   * - Description:
+     - Luminosity (\ :math:`L_\odot`) of the primary at the onset of RLOF.
+   * - Header String:
+     - Lum(1)<MT
+
+.. flat-table::
+   :widths: 25 75 1 1
+   :header-rows: 0
+   :class: aligned-text
+
+   * - :cspan:`2` **RLOF_PRE_MT_STAR2_LUM**
+     -
+   * - Data type:
+     - DOUBLE
+   * - COMPAS variable:
+     - BaseBinaryStar::m_RLOFDetails.propsPreMT→luminosity2
+   * - Description:
+     - Luminosity (\ :math:`L_\odot`) of the secondary at the onset of RLOF.
+   * - Header String:
+     - Lum(2)<MT
+
+
 .. flat-table::
    :widths: 25 75 1 1
    :header-rows: 0
@@ -1090,6 +1187,38 @@ but not both. If both are printed then the file will contain two columns with th
    * - Header String:
      - Radius(2)<MT
 
+.. flat-table::
+   :widths: 25 75 1 1
+   :header-rows: 0
+   :class: aligned-text
+
+   * - :cspan:`2` **RLOF_PRE_MT_STAR1_TEFF**
+     -
+   * - Data type:
+     - DOUBLE
+   * - COMPAS variable:
+     - BaseBinaryStar::m_RLOFDetails.propsPreMT→temperature1
+   * - Description:
+     - Effective temperature (\ :math:`K`) of the primary at the onset of RLOF.
+   * - Header String:
+     - Teff(1)<MT
+
+.. flat-table::
+   :widths: 25 75 1 1
+   :header-rows: 0
+   :class: aligned-text
+
+   * - :cspan:`2` **RLOF_PRE_MT_STAR2_TEFF**
+     -
+   * - Data type:
+     - DOUBLE
+   * - COMPAS variable:
+     - BaseBinaryStar::m_RLOFDetails.propsPreMT→temperature2
+   * - Description:
+     - Effective temperature (\ :math:`K`) of the secondary at the onset of RLOF.
+   * - Header String:
+     - Teff(2)<MT
+
 .. flat-table::
    :widths: 25 75 1 1
    :header-rows: 0

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

@@ -818,6 +818,20 @@ Options: {ZERO, MANDEL, BRCEK} |br|
 ``BRCEK``  : Core mass according to Shikauchi et al. (2024) with added rejuvenation of MS accretors and updated stellar tracks |br|
 Default = MANDEL
 
+**--maltsev-fallback** |br|
+Fixed fallback fraction when using MALTSEV2024 remnant mass prescription (must be between 0 and 1). |br|
+A value of 0.0 means that fallback BHs get no fallback, only the mass of the proto-NS remnant (and will get flagged as NSs). |br|
+A value of 1.0 means that fallback BHs get total fallback, taking the mass of the progenitor up to and including the He core (but not the H envelope). |br|
+Default = 0.5
+
+**--maltsev-mode** |br|
+Choice of which variant for the MALTSEV remnant mass prescription. Variants pertain to the treatment of extrapolation at low metallicities, and are described in detail in Willcox+ 2025. |br|
+Options: {OPTIMISTIC, BALANCED, PESSIMISTIC} |br|
+``OPTIMISTIC``  : Compactness-peak BHs formed from the lowest CO-mass progenitors for a given metallicity.                               |br|
+``PESSIMISTIC`` : Compactness-peak BHs only formed from the highest CO-mass progenitors for a given metallicity.                         |br|
+``BALANCED``    : Compactness-peak BHs formed from CO-mass progenitors with masses between the two previous extremes for a given metallicity. |br|
+Default = BALANCED
+
 **--mass-change-fraction** |br|
 Approximate desired fractional change in stellar mass on phase when setting SSE and BSE timesteps (applied before ``--timestep--multiplier``). |br|
 Recommended value is 0.005. |br|

online-docs/pages/whats-new.rst

@@ -3,6 +3,12 @@ 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.24.00 August 19, 2025**
+
+* Updated Maltsev remnant mass prescription to include the 3 variants described in Willcox+ 2025 (bimodality paper). 
+* New related options `--maltsev-fallback` which takes a float between 0 and 1 to specify the fallback fraction, and
+  `--maltsev-mode` with choices `'OPTIMISTIC','PESSIMISTIC','BALANCED'` for the extrapolation prescription (see Willcox+ 2025b)
+
 **03.23.00 August 09, 2025**
 
 * The following option is now deprecated, and will be removed in 1 year:

src/BaseBinaryStar.cpp

@@ -572,6 +572,10 @@ COMPAS_VARIABLE BaseBinaryStar::BinaryPropertyValue(const T_ANY_PROPERTY p_Prope
         case BINARY_PROPERTY::RLOF_POST_MT_STAR2_MASS:                              value = RLOFDetails().propsPostMT->mass2;                                   break;
         case BINARY_PROPERTY::RLOF_POST_MT_STAR1_RADIUS:                            value = RLOFDetails().propsPostMT->radius1;                                 break;
         case BINARY_PROPERTY::RLOF_POST_MT_STAR2_RADIUS:                            value = RLOFDetails().propsPostMT->radius2;                                 break;
+        case BINARY_PROPERTY::RLOF_POST_MT_STAR1_TEFF:                              value = RLOFDetails().propsPostMT->temperature1;                            break;
+        case BINARY_PROPERTY::RLOF_POST_MT_STAR2_TEFF:                              value = RLOFDetails().propsPostMT->temperature2;                            break;
+        case BINARY_PROPERTY::RLOF_POST_MT_STAR1_LUM:                               value = RLOFDetails().propsPostMT->luminosity1;                             break;
+        case BINARY_PROPERTY::RLOF_POST_MT_STAR2_LUM:                               value = RLOFDetails().propsPostMT->luminosity2;                             break;
         case BINARY_PROPERTY::RLOF_POST_MT_STAR1_RLOF:                              value = RLOFDetails().propsPostMT->isRLOF1;                                 break;
         case BINARY_PROPERTY::RLOF_POST_MT_STAR2_RLOF:                              value = RLOFDetails().propsPostMT->isRLOF2;                                 break;
         case BINARY_PROPERTY::RLOF_POST_MT_STAR1_STELLAR_TYPE:                      value = RLOFDetails().propsPostMT->stellarType1;                            break;
@@ -586,6 +590,10 @@ COMPAS_VARIABLE BaseBinaryStar::BinaryPropertyValue(const T_ANY_PROPERTY p_Prope
         case BINARY_PROPERTY::RLOF_PRE_MT_STAR2_MASS:                               value = RLOFDetails().propsPreMT->mass2;                                    break;
         case BINARY_PROPERTY::RLOF_PRE_MT_STAR1_RADIUS:                             value = RLOFDetails().propsPreMT->radius1;                                  break;
         case BINARY_PROPERTY::RLOF_PRE_MT_STAR2_RADIUS:                             value = RLOFDetails().propsPreMT->radius2;                                  break;
+        case BINARY_PROPERTY::RLOF_PRE_MT_STAR1_TEFF:                               value = RLOFDetails().propsPreMT->temperature1;                             break;
+        case BINARY_PROPERTY::RLOF_PRE_MT_STAR2_TEFF:                               value = RLOFDetails().propsPreMT->temperature2;                             break;
+        case BINARY_PROPERTY::RLOF_PRE_MT_STAR1_LUM:                                value = RLOFDetails().propsPreMT->luminosity1;                              break;
+        case BINARY_PROPERTY::RLOF_PRE_MT_STAR2_LUM:                                value = RLOFDetails().propsPreMT->luminosity2;                              break;
         case BINARY_PROPERTY::RLOF_PRE_MT_STAR1_RLOF:                               value = RLOFDetails().propsPreMT->isRLOF1;                                  break;
         case BINARY_PROPERTY::RLOF_PRE_MT_STAR2_RLOF:                               value = RLOFDetails().propsPreMT->isRLOF2;                                  break;
         case BINARY_PROPERTY::RLOF_PRE_MT_STAR1_STELLAR_TYPE:                       value = RLOFDetails().propsPreMT->stellarType1;                             break;
@@ -906,6 +914,10 @@ void BaseBinaryStar::StashRLOFProperties(const MT_TIMING p_Which) {
     rlofPropertiesToReset->massLossRateFromDonor       = m_MassLossRateInRLOF;
     rlofPropertiesToReset->accretionEfficiency         = m_FractionAccreted;
     rlofPropertiesToReset->massTransferTimescale       = m_MassTransferTimescale;
+    rlofPropertiesToReset->temperature1                = m_Star1->Temperature();
+    rlofPropertiesToReset->temperature2                = m_Star2->Temperature();
+    rlofPropertiesToReset->luminosity1                 = m_Star1->Luminosity();
+    rlofPropertiesToReset->luminosity2                 = m_Star2->Luminosity();
 }
 
 

src/ErrorCatalog.h

@@ -166,6 +166,7 @@ enum class ERROR: int {
     UNKNOWN_KICK_MAGNITUDE_DISTRIBUTION,                            // unknown kick magnitude distribution
     UNKNOWN_LOGFILE,                                                // unknown log file
     UNKNOWN_LBV_MASS_LOSS_PRESCRIPTION,                             // unknown LBV mass loss prescription
+    UNKNOWN_MALTSEV_MODE,                                           // unknown maltsev mode 
     UNKNOWN_MT_ACCRETION_EFFICIENCY_PRESCRIPTION,                   // unknown mass transfer accretion efficiency prescription
     UNKNOWN_MT_ANGULAR_MOMENTUM_LOSS_PRESCRIPTION,                  // unknown mass transfer angular momentum loss prescription
     UNKNOWN_MASS_LOSS_PRESCRIPTION,                                 // unknown mass loss prescription
@@ -342,6 +343,7 @@ const COMPASUnorderedMap<ERROR, std::tuple<ERROR_SCOPE, std::string>> ERROR_CATA
     { ERROR::UNKNOWN_KICK_MAGNITUDE_DISTRIBUTION,                   { ERROR_SCOPE::ALWAYS,              "Unknown kick magnitude distribution" }},
     { ERROR::UNKNOWN_LBV_MASS_LOSS_PRESCRIPTION,                    { ERROR_SCOPE::ALWAYS,              "Unknown LBV mass loss prescription" }},
     { ERROR::UNKNOWN_LOGFILE,                                       { ERROR_SCOPE::ALWAYS,              "Unknown log file" }},
+    { ERROR::UNKNOWN_MALTSEV_MODE,                                  { ERROR_SCOPE::ALWAYS,              "Unknown Maltsev remnant mass mode" }},
     { ERROR::UNKNOWN_MT_CASE,                                       { ERROR_SCOPE::ALWAYS,              "Unknown mass transfer case" }},
     { ERROR::UNKNOWN_MT_ACCRETION_EFFICIENCY_PRESCRIPTION,          { ERROR_SCOPE::ALWAYS,              "Unknown mass transfer accretion efficiency prescription" }},
     { ERROR::UNKNOWN_MT_ANGULAR_MOMENTUM_LOSS_PRESCRIPTION,         { ERROR_SCOPE::ALWAYS,              "Unknown mass transfer angular momentum loss prescription" }},