Merge pull request #1367 from yuzhesong/issue-1366

ilyamandel · web-flow · commit f0605e1fecf7 · 2025-04-14T03:16:59.000+02:00
Fix to Issue #1366
diff --git a/online-docs/pages/User guide/COMPAS output/standard-logfiles-record-specification-stellar.rst b/online-docs/pages/User guide/COMPAS output/standard-logfiles-record-specification-stellar.rst
@@ -1789,22 +1789,6 @@ same header string.`
    * - Header Strings:
      - Recycled_NS, Recycled_NS(1), Recycled_NS(2), Recycled_NS(SN), Recycled_NS(CP)
 
-.. flat-table::
-   :widths: 25 75 1 1
-   :header-rows: 0
-   :class: aligned-text
-
-   * - :cspan:`2` **RLOF_ONTO_NS**
-     -
-   * - Data type:
-     - DOUBLE
-   * - COMPAS variable:
-     - `derived from` BaseStar::m_SupernovaDetails.events.past
-   * - Description:
-     - Flag to indicate whether the star transferred mass to a neutron star at any time prior to the current timestep.
-   * - Header Strings:
-     - RLOF->NS, RLOF->NS(1), RLOF->NS(2), RLOF->NS(SN), RLOF->NS(CP)
-
 .. flat-table::
    :widths: 25 75 1 1
    :header-rows: 0
diff --git a/online-docs/pages/whats-new.rst b/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.16.04 Apr 6, 2025**
+
+* Neutron stars are now labelled as ``RecycledNS`` when undergoing mass transfer through common envelope (when ``--neutron-star-accretion-in-ce`` is not set to ``ZERO``). 
+
+* Removed output option ``RLOF_ONTO_NS`` as it can be retrieved from existing RLOF output info. 
+
 **03.17.00 Mar 22, 2025**
 
 * Added ENVELOPE_STATE_PRESCRIPTION::CONVECTIVE_MASS_FRACTION (default threshold of convective envelope by mass to label envelope 
diff --git a/src/BaseBinaryStar.cpp b/src/BaseBinaryStar.cpp
@@ -2146,12 +2146,14 @@ void BaseBinaryStar::CalculateMassTransfer(const double p_Dt) {
         }
     }
     
-	// Check for recycled pulsars. Not considering CEE as a way of recycling NSs.
-	if (!m_CEDetails.CEEnow && m_Accretor->IsOneOf({ STELLAR_TYPE::NEUTRON_STAR })) {                                           // accretor is a neutron star
-        m_Donor->SetRLOFOntoNS();                                                                                               // donor donated mass to a neutron star
+    // Check for recycled pulsars. Not considering CEE as a way of recycling NSs.
+    if (!m_CEDetails.CEEnow && m_Accretor->IsOneOf({ STELLAR_TYPE::NEUTRON_STAR })) {                                           // accretor is a neutron star, system is not in CE 
         m_Accretor->SetRecycledNS();                                                                                            // accretor is (was) a recycled NS
-	}
-    
+    }
+    else if (m_CEDetails.CEEnow && m_Accretor->IsOneOf({ STELLAR_TYPE::NEUTRON_STAR })
+             && OPTIONS->NeutronStarAccretionInCE() != NS_ACCRETION_IN_CE::ZERO) {                                              // accretor is a neutron star, system is in CE
+        m_Accretor->SetRecycledNS();                                                                                            // accretor is (was) a recycled NS
+    }
 }
 
 
diff --git a/src/BinaryConstituentStar.cpp b/src/BinaryConstituentStar.cpp
@@ -79,7 +79,6 @@ COMPAS_VARIABLE BinaryConstituentStar::StellarPropertyValue(const T_ANY_PROPERTY
         case ANY_STAR_PROPERTY::RADIAL_EXPANSION_TIMESCALE_POST_COMMON_ENVELOPE:    value = RadialExpansionTimescalePostCEE();              break;
         case ANY_STAR_PROPERTY::RADIAL_EXPANSION_TIMESCALE_PRE_COMMON_ENVELOPE:     value = RadialExpansionTimescalePreCEE();               break;
         case ANY_STAR_PROPERTY::RECYCLED_NEUTRON_STAR:                              value = ExperiencedRecycledNS();                        break;
-        case ANY_STAR_PROPERTY::RLOF_ONTO_NS:                                       value = ExperiencedRLOFOntoNS();                        break;
         case ANY_STAR_PROPERTY::TEMPERATURE_POST_COMMON_ENVELOPE:                   value = TemperaturePostCEE() * TSOL;                    break;
         case ANY_STAR_PROPERTY::TEMPERATURE_PRE_COMMON_ENVELOPE:                    value = TemperaturePreCEE() * TSOL;                     break;
         case ANY_STAR_PROPERTY::THERMAL_TIMESCALE_POST_COMMON_ENVELOPE:             value = ThermalTimescalePostCEE();                      break;
diff --git a/src/BinaryConstituentStar.h b/src/BinaryConstituentStar.h
@@ -50,8 +50,7 @@ class BinaryConstituentStar: virtual public Star {
         m_CEDetails.postCEE.radialExpansionTimescale = DEFAULT_INITIAL_DOUBLE_VALUE;
 
         m_Flags.recycledNS                           = false;
-        m_Flags.rlofOntoNS                           = false;
-
+        
         m_MassLossDiff                               = DEFAULT_INITIAL_DOUBLE_VALUE;
         m_MassTransferDiff                           = DEFAULT_INITIAL_DOUBLE_VALUE;
 
@@ -151,7 +150,6 @@ class BinaryConstituentStar: virtual public Star {
 
     bool            ExperiencedRecycledNS() const                                       { return m_Flags.recycledNS; }
     bool            ExperiencedRLOF() const                                             { return m_RLOFDetails.experiencedRLOF; }
-    bool            ExperiencedRLOFOntoNS() const                                       { return m_Flags.rlofOntoNS; }
 
     double          HeCoreMassAtCEE() const                                             { return m_CEDetails.HeCoreMass; }
 
@@ -196,8 +194,6 @@ class BinaryConstituentStar: virtual public Star {
     void            ClearRecycledNS()                                                   { m_Flags.recycledNS = false; }
     void            SetRecycledNS()                                                     { m_Flags.recycledNS = true; }
 
-    void            ClearRLOFOntoNS()                                                   { m_Flags.rlofOntoNS = false; }
-    void            SetRLOFOntoNS()                                                     { m_Flags.rlofOntoNS = true; }
 
     void            CalculateCommonEnvelopeValues();
 
@@ -248,7 +244,6 @@ class BinaryConstituentStar: virtual public Star {
 
     struct FLAGS {                                                  // Miscellaneous flags
         bool recycledNS;                                            // Indicate whether the accretor was a recycled neutron star
-        bool rlofOntoNS;                                            // Indicates whether the donor donated mass to neutron star through RLOF
     }                       m_Flags;
 
     double                  m_MassLossDiff;
diff --git a/src/LogTypedefs.h b/src/LogTypedefs.h
@@ -245,7 +245,6 @@ enum class STRING_QUALIFIER: int { NONE, FIXED_LENGTH, VARIABLE_LENGTH };
     RADIUS,                                          \
     RANDOM_SEED,                                     \
     RECYCLED_NEUTRON_STAR,                           \
-    RLOF_ONTO_NS,                                    \
     ROCKET_KICK_MAGNITUDE,                           \
     ROCKET_KICK_PHI,                                 \
     ROCKET_KICK_THETA,                               \
@@ -393,7 +392,6 @@ const COMPASUnorderedMap<STAR_PROPERTY, std::string> STAR_PROPERTY_LABEL = {
     { STAR_PROPERTY::RADIUS,                                          "RADIUS" },
     { STAR_PROPERTY::RANDOM_SEED,                                     "RANDOM_SEED" },
     { STAR_PROPERTY::RECYCLED_NEUTRON_STAR,                           "RECYCLED_NEUTRON_STAR" },
-    { STAR_PROPERTY::RLOF_ONTO_NS,                                    "RLOF_ONTO_NS" },
     { STAR_PROPERTY::ROCKET_KICK_MAGNITUDE,                           "ROCKET_KICK_MAGNITUDE" },
     { STAR_PROPERTY::ROCKET_KICK_PHI,                                 "ROCKET_KICK_PHI" },
     { STAR_PROPERTY::ROCKET_KICK_THETA,                               "ROCKET_KICK_THETA" },
@@ -1321,7 +1319,6 @@ const std::map<ANY_STAR_PROPERTY, PROPERTY_DETAILS> ANY_STAR_PROPERTY_DETAIL = {
     { ANY_STAR_PROPERTY::RADIUS,                                            { TYPENAME::DOUBLE,           "Radius",                          "Rsol",             24, 15}},
     { ANY_STAR_PROPERTY::RANDOM_SEED,                                       { TYPENAME::ULONGINT,         "SEED",                            "-",                12, 1 }},
     { ANY_STAR_PROPERTY::RECYCLED_NEUTRON_STAR,                             { TYPENAME::BOOL,             "Recycled_NS",                     "Event",             0, 0 }},
-    { ANY_STAR_PROPERTY::RLOF_ONTO_NS,                                      { TYPENAME::BOOL,             "RLOF->NS",                        "Event",             0, 0 }},
     { ANY_STAR_PROPERTY::ROCKET_KICK_MAGNITUDE,                             { TYPENAME::DOUBLE,           "Rocket_Kick_Magnitude",           "kms^-1",           24, 15}},
     { ANY_STAR_PROPERTY::ROCKET_KICK_PHI,                                   { TYPENAME::DOUBLE,           "Rocket_Kick_Phi",                 "-",                24, 15}},
     { ANY_STAR_PROPERTY::ROCKET_KICK_THETA,                                 { TYPENAME::DOUBLE,           "Rocket_Kick_Theta",               "-",                24, 15}},
diff --git a/src/changelog.h b/src/changelog.h
@@ -1526,6 +1526,10 @@
 //  03.17.02    JR - Apr 11, 2025   - Defect Repair:
 //                                      - Remove extraneous debug print statement in MainSequence.h (inavertently added by me in v03.17.00)
 //                                      - fix description of return value for BaseStar::CalculateOmegaCHE()
-const std::string VERSION_STRING = "03.17.02";
+//  03.17.03    YS  - Apr 6, 2025   - Enhancement:
+//                                      - Fix to issue #1366
+//                                      - Removed "RLOF_ONTO_NS" output option as it can be retrieved from RLOF Output info. 
+
+const std::string VERSION_STRING = "03.17.03";
 
 # endif // __changelog_h__

Original file line number	Diff line number	Diff line change
`@@ -2146,12 +2146,14 @@ void BaseBinaryStar::CalculateMassTransfer(const double p_Dt) {`
`2146`	`2146`	`}`
`2147`	`2147`	`}`
`2148`	`2148`
`2149`		`- // Check for recycled pulsars. Not considering CEE as a way of recycling NSs.`
`2150`		`- if (!m_CEDetails.CEEnow && m_Accretor->IsOneOf({ STELLAR_TYPE::NEUTRON_STAR })) { // accretor is a neutron star`
`2151`		`- m_Donor->SetRLOFOntoNS(); // donor donated mass to a neutron star`
	`2149`	`+ // Check for recycled pulsars. Not considering CEE as a way of recycling NSs.`
	`2150`	`+ if (!m_CEDetails.CEEnow && m_Accretor->IsOneOf({ STELLAR_TYPE::NEUTRON_STAR })) { // accretor is a neutron star, system is not in CE`
`2152`	`2151`	`m_Accretor->SetRecycledNS(); // accretor is (was) a recycled NS`
`2153`		`- }`
`2154`		`-`
	`2152`	`+ }`
	`2153`	`+ else if (m_CEDetails.CEEnow && m_Accretor->IsOneOf({ STELLAR_TYPE::NEUTRON_STAR })`
	`2154`	`+ && OPTIONS->NeutronStarAccretionInCE() != NS_ACCRETION_IN_CE::ZERO) { // accretor is a neutron star, system is in CE`
	`2155`	`+ m_Accretor->SetRecycledNS(); // accretor is (was) a recycled NS`
	`2156`	`+ }`
`2155`	`2157`	`}`
`2156`	`2158`
`2157`	`2159`