Making enhanced, interpolated Nanjing lambdas the default

compas_python_utils/preprocessing/compasConfigDefault.yaml

@@ -1,5 +1,5 @@
 ##~!!~## COMPAS option values
-##~!!~## File Created Mon Apr 14 17:15:32 2025 by COMPAS v03.18.00
+##~!!~## File Created Thu May  1 20:17:56 2025 by COMPAS v03.18.01
 ##~!!~##
 ##~!!~## The default COMPAS YAML file (``compasConfigDefault.yaml``), as distributed, has
 ##~!!~## all COMPAS option entries commented so that the COMPAS default value for the
@@ -48,9 +48,9 @@ booleanChoices:
 #    --common-envelope-allow-immediate-RLOF-post-CE-survive: False         # Default: False
 #    --common-envelope-allow-main-sequence-survive: True                   # Default: True                                                                                                                                                                             # Allow main sequence stars to survive CE
 #    --common-envelope-allow-radiative-envelope-survive: False             # Default: False
-#    --common-envelope-lambda-nanjing-enhanced: False                      # Default: False
-#    --common-envelope-lambda-nanjing-interpolate-in-mass: False           # Default: False
-#    --common-envelope-lambda-nanjing-interpolate-in-metallicity: False    # Default: False
+#    --common-envelope-lambda-nanjing-enhanced: True                       # Default: True
+#    --common-envelope-lambda-nanjing-interpolate-in-mass: True            # Default: True
+#    --common-envelope-lambda-nanjing-interpolate-in-metallicity: True     # Default: True
 #    --common-envelope-lambda-nanjing-use-rejuvenated-mass: False          # Default: False
 #    --revised-energy-formalism-nandez-ivanova: False                      # Default: False
 

online-docs/pages/User guide/COMPAS output/standard-logfiles-default-record-specifications-BSE-switchlog.rst

@@ -1,87 +1,96 @@
-BSE switchlog
-=============
-
-Default record definition for the BSE SwitchLog log file::
-
-    const ANY_PROPERTY_VECTOR BSE_SWITCH_LOG_REC = {
-        BINARY_PROPERTY::RANDOM_SEED,
-        BINARY_PROPERTY::TIME
-    };
-
-
-The default record specification can be modified at runtime via a logfile record specifications file (program option ``--logfile-definitions``).
-See :doc:`standard-logfiles-record-specification` for details.
-
-Note that the BSE SwitchLog file has the following columns automatically appended to each record:
-
-    - The constituent star switching stellar type: 1 = Primary, 2 = Secondary.
-    - The stellar type from which the star is switching.
-    - The stellar type to which the star is switching.
-
-|br|
-**STAR_SWITCHING**
-
-.. list-table::
-   :widths: 20 80 
-   :header-rows: 0
-   :class: aligned-text
-
-   * - Data type:
-     - INT
-   * - COMPAS variable:
-     - `derived from` ``BaseBinaryStar::m_Star1/m_Star2``
-   * - Description:
-     - The constituent star switching stellar type, where 1 = Primary, and 2 = Secondary.
-   * - Header String:
-     - "STAR_SWITCHING"
-
-**SWITCHING_FROM**
-
-.. list-table::
-   :widths: 20 80 
-   :header-rows: 0
-   :class: aligned-text
-
-   * - Data type:
-     - INT
-   * - COMPAS variable:
-     - `derived from` ``BaseStar::m_StellarType``
-   * - Description:
-     - The stellar type of the constituent star immediately prior to the switch.
-   * - Header String:
-     - "SWITCHING_FROM"
-
-**SWITCHING_TO**
-
-.. list-table::
-   :widths: 20 80 
-   :header-rows: 0
-   :class: aligned-text
-
-   * - Data type:
-     - INT
-   * - COMPAS variable:
-     - Not applicable
-   * - Description:
-     - The stellar type to which the constituent star will switch (i.e. the stellar type immediately following the switch).
-   * - Header String:
-     - "SWITCHING_TO"
-
-**IS_MERGER**
-
-.. list-table::
-   :widths: 20 80 
-   :header-rows: 0
-   :class: aligned-text
-
-   * - Data type:
-     - BOOL
-   * - COMPAS variable:
-     - Not applicable
-   * - Description:
-     - Flag to indicate if the switchlog record records a merger (rather than a simple switch)
-   * - Header String:
-     - "IS_MERGER"
-
-These columns will always be automatically appended to each BSE Switch Log record: they cannot be removed via the log file record 
-specifications file.
+BSE switchlog
+=============
+
+Default record definition for the BSE SwitchLog log file::
+
+    const ANY_PROPERTY_VECTOR BSE_SWITCH_LOG_REC = {
+        BINARY_PROPERTY::RANDOM_SEED,
+        BINARY_PROPERTY::TIME,
+        BINARY_PROPERTY::SEMI_MAJOR_AXIS_RSOL,
+        BINARY_PROPERTY::ROCHE_LOBE_RADIUS_1,
+        BINARY_PROPERTY::ROCHE_LOBE_RADIUS_2,
+        STAR_1_PROPERTY::MASS,
+        STAR_2_PROPERTY::MASS,
+        STAR_1_PROPERTY::STELLAR_TYPE,
+        STAR_2_PROPERTY::STELLAR_TYPE,
+        STAR_1_PROPERTY::RADIUS,
+        STAR_2_PROPERTY::RADIUS
+    };
+
+
+The default record specification can be modified at runtime via a logfile record specifications file (program option ``--logfile-definitions``).
+See :doc:`standard-logfiles-record-specification` for details.
+
+Note that the BSE SwitchLog file has the following columns automatically appended to each record:
+
+    - The constituent star switching stellar type: 1 = Primary, 2 = Secondary.
+    - The stellar type from which the star is switching.
+    - The stellar type to which the star is switching.
+
+|br|
+**STAR_SWITCHING**
+
+.. list-table::
+   :widths: 20 80 
+   :header-rows: 0
+   :class: aligned-text
+
+   * - Data type:
+     - INT
+   * - COMPAS variable:
+     - `derived from` ``BaseBinaryStar::m_Star1/m_Star2``
+   * - Description:
+     - The constituent star switching stellar type, where 1 = Primary, and 2 = Secondary.
+   * - Header String:
+     - "STAR_SWITCHING"
+
+**SWITCHING_FROM**
+
+.. list-table::
+   :widths: 20 80 
+   :header-rows: 0
+   :class: aligned-text
+
+   * - Data type:
+     - INT
+   * - COMPAS variable:
+     - `derived from` ``BaseStar::m_StellarType``
+   * - Description:
+     - The stellar type of the constituent star immediately prior to the switch.
+   * - Header String:
+     - "SWITCHING_FROM"
+
+**SWITCHING_TO**
+
+.. list-table::
+   :widths: 20 80 
+   :header-rows: 0
+   :class: aligned-text
+
+   * - Data type:
+     - INT
+   * - COMPAS variable:
+     - Not applicable
+   * - Description:
+     - The stellar type to which the constituent star will switch (i.e. the stellar type immediately following the switch).
+   * - Header String:
+     - "SWITCHING_TO"
+
+**IS_MERGER**
+
+.. list-table::
+   :widths: 20 80 
+   :header-rows: 0
+   :class: aligned-text
+
+   * - Data type:
+     - BOOL
+   * - COMPAS variable:
+     - Not applicable
+   * - Description:
+     - Flag to indicate if the switchlog record records a merger (rather than a simple switch)
+   * - Header String:
+     - "IS_MERGER"
+
+These columns will always be automatically appended to each BSE Switch Log record: they cannot be removed via the log file record 
+specifications file.

online-docs/pages/User guide/COMPAS output/standard-logfiles-default-record-specifications-SSE-switchlog.rst

@@ -1,54 +1,57 @@
-SSE switchlog
-=============
-
-Default record definition for the SSE SwitchLog log file::
-
-    const ANY_PROPERTY_VECTOR SSE_SWITCH_LOG_REC = {
-        STAR_PROPERTY::RANDOM_SEED,
-        STAR_PROPERTY::TIME
-    };
-
-
-The default record specification can be modified at runtime via a logfile record specifications file (program option ``--logfile-definitions``).
-See :doc:`standard-logfiles-record-specification` for details.
-
-Note that the SSE SwitchLog file has the following columns automatically appended to each record:
-
-    - The stellar type from which the star is switching.
-    - The stellar type to which the star is switching.
-
-|br|
-**SWITCHING_FROM**
-
-.. list-table::
-   :widths: 20 80 
-   :header-rows: 0
-   :class: aligned-text
-
-   * - Data type:
-     - INT
-   * - COMPAS variable:
-     - `derived from` ``BaseStar::m_StellarType``
-   * - Description:
-     - The stellar type of the star immediately prior to the switch.
-   * - Header String:
-     - "SWITCHING_FROM"
-
-**SWITCHING_TO**
-
-.. list-table::
-   :widths: 20 80 
-   :header-rows: 0
-   :class: aligned-text
-
-   * - Data type:
-     - INT
-   * - COMPAS variable:
-     - Not applicable
-   * - Description:
-     - The stellar type to which the star will switch (i.e. the stellar type immediately following the switch).
-   * - Header String:
-     - "SWITCHING_TO"
-
-These columns will always be automatically appended to each SSE Switch Log record: they cannot be removed via the log file record 
-specifications file.
+SSE switchlog
+=============
+
+Default record definition for the SSE SwitchLog log file::
+
+    const ANY_PROPERTY_VECTOR SSE_SWITCH_LOG_REC = {
+        STAR_PROPERTY::RANDOM_SEED,
+        STAR_PROPERTY::TIME,
+    	STAR_PROPERTY::MASS,
+    	STAR_PROPERTY::STELLAR_TYPE,
+    	STAR_PROPERTY::RADIUS
+    };
+
+
+The default record specification can be modified at runtime via a logfile record specifications file (program option ``--logfile-definitions``).
+See :doc:`standard-logfiles-record-specification` for details.
+
+Note that the SSE SwitchLog file has the following columns automatically appended to each record:
+
+    - The stellar type from which the star is switching.
+    - The stellar type to which the star is switching.
+
+|br|
+**SWITCHING_FROM**
+
+.. list-table::
+   :widths: 20 80 
+   :header-rows: 0
+   :class: aligned-text
+
+   * - Data type:
+     - INT
+   * - COMPAS variable:
+     - `derived from` ``BaseStar::m_StellarType``
+   * - Description:
+     - The stellar type of the star immediately prior to the switch.
+   * - Header String:
+     - "SWITCHING_FROM"
+
+**SWITCHING_TO**
+
+.. list-table::
+   :widths: 20 80 
+   :header-rows: 0
+   :class: aligned-text
+
+   * - Data type:
+     - INT
+   * - COMPAS variable:
+     - Not applicable
+   * - Description:
+     - The stellar type to which the star will switch (i.e. the stellar type immediately following the switch).
+   * - Header String:
+     - "SWITCHING_TO"
+
+These columns will always be automatically appended to each SSE Switch Log record: they cannot be removed via the log file record 
+specifications file.

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

@@ -164,15 +164,15 @@ Default = 1.0
 
 **--common-envelope-lambda-nanjing-enhanced** |br|
 Continuous extrapolation beyond maximum radius range in Nanjing lambda's as implemented in StarTrack. Only used when ``--common-envelope-lambda-prescription = LAMBDA_NANJING``. |br|
-Default = FALSE
+Default = TRUE
 
 **--common-envelope-lambda-nanjing-interpolate-in-mass** |br|
-Interpolate Nanjing lambda parameters across different mass models. Only used when ``--common-envelope-lambda-prescription = LAMBDA_NANJING``. |br|
-Default = FALSE
+Interpolate Nanjing lambda parameters across different mass models. Only used when ``--common-envelope-lambda-prescription = LAMBDA_NANJING``.  Requires ``--common-envelope-lambda-nanjing-enhanced``. |br| 
+Default = TRUE
 
 **--common-envelope-lambda-nanjing-interpolate-in-metallicity** |br|
-Interpolate Nanjing lambda parameters across population I and population II metallicity models. Only used when ``--common-envelope-lambda-prescription = LAMBDA_NANJING``. |br|
-Default = FALSE
+Interpolate Nanjing lambda parameters across population I and population II metallicity models. Only used when ``--common-envelope-lambda-prescription = LAMBDA_NANJING``. Requires ``--common-envelope-lambda-nanjing-enhanced``. |br| 
+Default = TRUE
 
 **--common-envelope-lambda-nanjing-use-rejuvenated-mass** |br|
 Use rejuvenated or effective ZAMS mass instead of true birth mass when computing Nanjing lambda parameters. Only used when ``--common-envelope-lambda-prescription = LAMBDA_NANJING``. |br|
@@ -1350,8 +1350,8 @@ This option is primarily intended for debugging/testing of convergence issues ra
 **--timestep-multipliers** |br|
 Phase-dependent multiplicative factors for timestep duration. |br|
 See :doc:`Vector program options <./program-options-vector-options>` for option format. |br|
-A multicative factor can be specified for each phase (stellar type), where the ordinal value (zero-based) of the option value
-indicates the stellar type (from ``MS_LTE_07`` to ``CHEMICALLY_HOMOGENEOUS``, see stellar type list at 
+A multiplicative factor can be specified for each phase (stellar type), where the ordinal value (zero-based) of the 
+option value indicates the stellar type (from ``MS_LTE_07`` to ``CHEMICALLY_HOMOGENEOUS``, see stellar type list at 
 :doc:`../../Developer guide/Headers/typedefs-dot-h`>). |br|
 |br|
 This multiplier is applied after the timesteps are chosen using other program options such as ``--radial-change-fraction`` and 

online-docs/pages/whats-new.rst

@@ -3,6 +3,10 @@ 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.18.02 May 1, 2025**
+
+* Changed default for Nanjing lambdas to use enhanced lambdas and interpolate in mass and metallicity
+
 **03.18.00 Apr 14, 2025**
 
 New command line option:

src/LogTypedefs.h

@@ -2146,7 +2146,16 @@ const ANY_PROPERTY_VECTOR BSE_SUPERNOVAE_REC = {
 //
 const ANY_PROPERTY_VECTOR BSE_SWITCH_LOG_REC = {
     BINARY_PROPERTY::RANDOM_SEED,
-    BINARY_PROPERTY::TIME
+    BINARY_PROPERTY::TIME,
+    BINARY_PROPERTY::SEMI_MAJOR_AXIS_RSOL,
+    BINARY_PROPERTY::ROCHE_LOBE_RADIUS_1,
+    BINARY_PROPERTY::ROCHE_LOBE_RADIUS_2,
+    STAR_1_PROPERTY::MASS,
+    STAR_2_PROPERTY::MASS,
+    STAR_1_PROPERTY::STELLAR_TYPE,
+    STAR_2_PROPERTY::STELLAR_TYPE,
+    STAR_1_PROPERTY::RADIUS,
+    STAR_2_PROPERTY::RADIUS
 };
 
 
@@ -2265,7 +2274,10 @@ const ANY_PROPERTY_VECTOR SSE_SUPERNOVAE_REC = {
 //
 const ANY_PROPERTY_VECTOR SSE_SWITCH_LOG_REC = {
     STAR_PROPERTY::RANDOM_SEED,
-    STAR_PROPERTY::TIME
+    STAR_PROPERTY::TIME,
+    STAR_PROPERTY::MASS,
+    STAR_PROPERTY::STELLAR_TYPE,
+    STAR_PROPERTY::RADIUS
 };