Merge pull request #1390 from TeamCOMPAS/tides_updates

Tides updates

Author: ilyamandel

compas_python_utils/preprocessing/compasConfigDefault.yaml

@@ -1,5 +1,5 @@
 ##~!!~## COMPAS option values
-##~!!~## File Created Thu May 22 20:41:26 2025 by COMPAS v03.19.00
+##~!!~## File Created Sun May 25 00:33:11 2025 by COMPAS v03.20.00
 ##~!!~##
 ##~!!~## The default COMPAS YAML file (``compasConfigDefault.yaml``), as distributed, has
 ##~!!~## all COMPAS option entries commented so that the COMPAS default value for the
@@ -274,7 +274,7 @@ stringChoices:
 #    --common-envelope-mass-accretion-prescription: 'ZERO'                 # Default: 'ZERO'                        # Options: ['CHEVALIER','MACLEOD','UNIFORM','CONSTANT','ZERO']
 
     ### TIDES
-#    --tides-prescription: 'NONE'                                          # Default: 'NONE'                        # Options: ['KAPIL2024','PERFECT','NONE']
+#    --tides-prescription: 'NONE'                                          # Default: 'NONE'                        # Options: ['KAPIL2025','PERFECT','NONE']
 
     ### SUPERNOVAE, KICKS AND REMNANTS
 #    --black-hole-kicks-mode: 'FALLBACK'                                   # Default: 'FALLBACK'                    # Options: ['FALLBACK','ZERO','REDUCED','FULL']

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

@@ -1818,16 +1818,32 @@ both. If both are printed then the file will contain two columns with the same h
    :header-rows: 0
    :class: aligned-text
 
-   * - :cspan:`2` **SYNCHRONIZATION_TIMESCALE**
+   * - :cspan:`2` **SYNCHRONIZATION_TIMESCALE_1**
      -
    * - Data type:
      - DOUBLE
    * - COMPAS variable:
-     - BaseBinaryStar::m_SynchronizationTimescale
+     - BaseBinaryStar::m_SynchronizationTimescale1
    * - Description:
-     - Tidal synchronisation timescale (Myr).
+     - Tidal synchronisation timescale for the primary star (Myr).
    * - Header String:
-     - Tau_Sync
+     - Tau_Sync(1)
+  
+  .. flat-table::
+   :widths: 25 75 1 1
+   :header-rows: 0
+   :class: aligned-text
+
+   * - :cspan:`2` **SYNCHRONIZATION_TIMESCALE_2**
+     -
+   * - Data type:
+     - DOUBLE
+   * - COMPAS variable:
+     - BaseBinaryStar::m_SynchronizationTimescale2
+   * - Description:
+     - Tidal synchronisation timescale for the secondary star (Myr).
+   * - Header String:
+     - Tau_Sync(2)
 
 .. flat-table::
    :widths: 25 75 1 1
@@ -1897,6 +1913,103 @@ both. If both are printed then the file will contain two columns with the same h
 
 :ref:`Back to Top <binary-props-top>`
 
+.. flat-table::
+   :widths: 25 75 1 1
+   :header-rows: 0
+   :class: aligned-text
+
+   * - :cspan:`2` **TIDAL_POTENTIAL_LOVE_NUMBER_10_1, TIDAL_POTENTIAL_LOVE_NUMBER_12_1, TIDAL_POTENTIAL_LOVE_NUMBER_22_1, TIDAL_POTENTIAL_LOVE_NUMBER_32_1**
+     -
+   * - Data type:
+     - DOUBLE
+   * - COMPAS variable:
+     - `derived from` BaseStar::CalculateImKnmTidal()
+   * - Description:
+     - l=2 components of the tidal potential Love number for the primary star, indexed by (n,m).
+   * - Header String:
+     - ImKnm1_10, ImKnm1_12, ImKnm1_22, ImKnm1_32
+
+.. flat-table::
+   :widths: 25 75 1 1
+   :header-rows: 0
+   :class: aligned-text
+
+   * - :cspan:`2` **TIDAL_POTENTIAL_LOVE_NUMBER_10_2, TIDAL_POTENTIAL_LOVE_NUMBER_12_2, TIDAL_POTENTIAL_LOVE_NUMBER_22_2, TIDAL_POTENTIAL_LOVE_NUMBER_32_2**
+     -
+   * - Data type:
+     - DOUBLE
+   * - COMPAS variable:
+     - `derived from` BaseStar::CalculateImKnmTidal()
+   * - Description:
+     - l=2 components of the tidal potential Love number for the secondary star, indexed by (n,m).
+   * - Header String:
+     - ImKnm2_10, ImKnm2_12, ImKnm2_22, ImKnm2_32
+
+.. flat-table::
+   :widths: 25 75 1 1
+   :header-rows: 0
+   :class: aligned-text
+
+   * - :cspan:`2` **TIDAL_POTENTIAL_LOVE_NUMBER_10_EQ_1, TIDAL_POTENTIAL_LOVE_NUMBER_12_EQ_1, TIDAL_POTENTIAL_LOVE_NUMBER_22_EQ_1, TIDAL_POTENTIAL_LOVE_NUMBER_32_EQ_1**
+     -
+   * - Data type:
+     - DOUBLE
+   * - COMPAS variable:
+     - `derived from` BaseStar::CalculateImKnmEquilibrium()
+   * - Description:
+     - l=2 components of the equilibrium tidal potential Love number for the primary star, indexed by (n,m).
+   * - Header String:
+     - ImKnm1_10_eq, ImKnm1_12_eq, ImKnm1_22_eq, ImKnm1_32_eq
+
+.. flat-table::
+   :widths: 25 75 1 1
+   :header-rows: 0
+   :class: aligned-text
+
+   * - :cspan:`2` **TIDAL_POTENTIAL_LOVE_NUMBER_10_EQ_2, TIDAL_POTENTIAL_LOVE_NUMBER_12_EQ_2, TIDAL_POTENTIAL_LOVE_NUMBER_22_EQ_2, TIDAL_POTENTIAL_LOVE_NUMBER_32_EQ_2**
+     -
+   * - Data type:
+     - DOUBLE
+   * - COMPAS variable:
+     - `derived from` BaseStar::CalculateImKnmEquilibrium()
+   * - Description:
+     - l=2 components of the equilibrium tidal potential Love number for the secondary star, indexed by (n,m).
+   * - Header String:
+     - ImKnm2_10_eq, ImKnm2_12_eq, ImKnm2_22_eq, ImKnm2_32_eq
+
+.. flat-table::
+   :widths: 25 75 1 1
+   :header-rows: 0
+   :class: aligned-text
+
+   * - :cspan:`2` **TIDAL_POTENTIAL_LOVE_NUMBER_10_DYN_1, TIDAL_POTENTIAL_LOVE_NUMBER_12_DYN_1, TIDAL_POTENTIAL_LOVE_NUMBER_22_DYN_1, TIDAL_POTENTIAL_LOVE_NUMBER_32_DYN_1**
+     -
+   * - Data type:
+     - DOUBLE
+   * - COMPAS variable:
+     - `derived from` BaseStar::CalculateImKnmDynamical()
+   * - Description:
+     - l=2 components of the dynamical tidal potential Love number for the primary star, indexed by (n,m).
+   * - Header String:
+     - ImKnm1_10_dyn, ImKnm1_12_dyn, ImKnm1_22_dyn, ImKnm1_32_dyn
+
+.. flat-table::
+   :widths: 25 75 1 1
+   :header-rows: 0
+   :class: aligned-text
+
+   * - :cspan:`2` **TIDAL_POTENTIAL_LOVE_NUMBER_10_DYN_2, TIDAL_POTENTIAL_LOVE_NUMBER_12_DYN_2, TIDAL_POTENTIAL_LOVE_NUMBER_22_DYN_2, TIDAL_POTENTIAL_LOVE_NUMBER_32_DYN_2**
+     -
+   * - Data type:
+     - DOUBLE
+   * - COMPAS variable:
+     - `derived from` BaseStar::CalculateImKnmDynamical()
+   * - Description:
+     - l=2 components of the dynamical tidal potential Love number for the secondary star, indexed by (n,m).
+   * - Header String:
+     - ImKnm2_10_dyn, ImKnm2_12_dyn, ImKnm2_22_dyn, ImKnm2_32_dyn
+
+
 .. flat-table::
    :widths: 25 75 1 1
    :header-rows: 0

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

@@ -1354,10 +1354,10 @@ A record is written to the System Snapshot logfile on the first timestep at whic
 
 **--tides-prescription** |br|
 Prescription for tidal evolution of the binary. |br|
-Options: { NONE, PERFECT, KAPIL2024 } |br|
+Options: { NONE, PERFECT, KAPIL2025 } |br|
 ``NONE`` disables tidal interactions. |br|
 ``PERFECT`` evolves the binary assuming instantaneous synchronization and circularization. |br|
-``KAPIL2024`` uses the prescription from Kapil+ (2024). |br|
+``KAPIL2025`` uses the prescription from Kapil+ (2025). |br|
 Default = NONE
 
 **--timestep-filename** |br|

online-docs/pages/whats-new.rst

@@ -3,6 +3,13 @@ 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.20.00 May 25, 2025**
+
+* Replaced the name of the ``KAPIL2024`` tides prescription with ``KAPIL2025``.
+* Updated the equilibrium and dynamical tides equations to match the paper.
+* New outputs for BSE_DETAILED_OUTPUT from tidal evolution, including ``CIRCULARIZATION_TIMESCALE``, ``SYNCHRONIZATION_TIMESCALE_1``, ``SYNCHRONIZATION_TIMESCALE_2``, ``TIDAL_POTENTIAL_LOVE_NUMBER_22_1``, ``TIDAL_POTENTIAL_LOVE_NUMBER_10_EQ_1``, and ``TIDAL_POTENTIAL_LOVE_NUMBER_32_DYN_2``
+
+
 **03.19.00 May 22, 2025**
 
 * Added functionality to create new System Snapshot logfile |br|