Tidal deformation

binary/defaults/binary_controls.defaults

@@ -49,9 +49,9 @@
 
 
 ! initial_eccentricity
-! ~~~~~~~~~~~~~~~~~~~~
 
 ! Initial eccentricity of the system
+! ~~~~~~~~~~~~~~~~~~~~
 
 ! ::
 
@@ -1462,6 +1462,22 @@
     mdot_limit_donor_switch = 1d-20
 
 
+! tidal_deformation
+! ~~~~~~~~~~~~~~~~~
+
+! use the tidal deformation corrections fp/ft and the specific moments of inertia irot
+! based on binary Roche geometry integrations of Fabry et al., 2022, A&A 661, A123
+! this uses the methodology of Kippenhahn and Thomas, 1970, and Endal and Sofia, 1976 to represent
+! the stellar stucture on equipotential surfaces. In these coordinates, all radii are volume equivalent
+! radii.
+
+! ::
+
+   use_tidal_deformation = .false.
+   f_sync_switch_from_rot_defor = 8d-1
+   f_sync_switch_width = 1d-1
+   f_sync_switch_lim = 1d-2
+
 ! use_other_{hook}
 ! ~~~~~~~~~~~~~~~~
 

binary/make/makefile

@@ -3,6 +3,6 @@
 # goal of QUIET is to make it easier to spot warnings and/or circular dependency
 # errors.
 
-QUIET = yes
+QUIET = no
 
 include makefile_base

binary/make/makefile_base

@@ -47,6 +47,7 @@ SRCS = \
    binary_wind.f90 \
    binary_mdot.f90 \
    binary_tides.f90 \
+   binary_roche_deformation.f90 \
    binary_edot.f90 \
    binary_ctrls_io.f90 \
    binary_irradiation.f90 \
@@ -71,6 +72,7 @@ SRCS = \
    mod_other_binary_edot.f90 \
    mod_other_binary_ce.f90 \
    mod_other_implicit_rlo.f90 \
+   mod_other_tidal_deformation_switch_function.f90 \
    mod_other_binary_extras.f90 \
    mod_other_binary_photo_read.f90 \
    mod_other_binary_photo_write.f90 \

binary/other/mod_other_tidal_deformation_switch_function.f90

@@ -0,0 +1,56 @@
+! ***********************************************************************
+!
+!   Copyright (C) 2025  Matthias Fabry and the MESA Team
+!
+!   MESA is free software; you can use it and/or modify
+!   it under the combined terms and restrictions of the MESA MANIFESTO
+!   and the GNU General Library Public License as published
+!   by the Free Software Foundation; either version 2 of the License,
+!   or (at your option) any later version.
+!
+!   You should have received a copy of the MESA MANIFESTO along with
+!   this software; if not, it is available at the mesa website:
+!   http://mesa.sourceforge.net/
+!
+!   MESA is distributed in the hope that it will be useful,
+!   but WITHOUT ANY WARRANTY; without even the implied warranty of
+!   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+!   See the GNU Library General Public License for more details.
+!
+!   You should have received a copy of the GNU Library General Public License
+!   along with this software; if not, write to the Free Software
+!   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+!
+! ***********************************************************************
+
+module mod_other_tidal_deformation_switch_function
+
+   ! NOTE: remember to set true:
+   ! use_other_tidal_deformation_function = .true.
+
+   ! you can add your own routine for use instead of the default one.
+   ! the default routine uses the synchronicity parameter to switch from single rotating to tidal corrections.
+   ! When the shell is quite synchronous, f_switch -> 1, when not synchronous, f_switch -> 0. It uses a sigmoid around
+   ! omega/omega_sync = b% f_sync_switch_from_rot_defor to smoothly vary f_switch from 0 to 1.
+
+   use const_def
+
+   implicit none
+
+   contains
+
+   subroutine null_other_tidal_deformation_switch_function(id, k, omega_in, f_switch, ierr)
+      integer, intent(in) :: id, k
+      real(dp), intent(in) :: omega_in
+      real(dp), intent(out) :: f_switch
+      integer, intent(out) :: ierr
+      include 'formats'
+
+      write (*, 1) 'no implementation for other_tidal_deformation_function'
+      ! must set f_switch
+      ierr = -1
+   end subroutine null_other_tidal_deformation_switch_function
+
+
+end module mod_other_tidal_deformation_switch_function
+

binary/private/binary_ctrls_io.f90

@@ -202,6 +202,11 @@ module binary_ctrls_io
          ! miscellaneous controls
          keep_donor_fixed, &
          mdot_limit_donor_switch, &
+         use_tidal_deformation, &
+         f_sync_switch_from_rot_defor, &
+         f_sync_switch_width, &
+         f_sync_switch_lim, &
+         use_other_tidal_deformation_switch_function, &
          use_other_rlo_mdot, &
          use_other_check_implicit_rlo, &
          use_other_implicit_function_to_solve, &
@@ -511,6 +516,11 @@ subroutine store_binary_controls(b, ierr)
          ! miscellaneous controls
          b% keep_donor_fixed = keep_donor_fixed
          b% mdot_limit_donor_switch = mdot_limit_donor_switch
+         b% use_tidal_deformation = use_tidal_deformation
+         b% f_sync_switch_from_rot_defor = f_sync_switch_from_rot_defor
+         b% f_sync_switch_width = f_sync_switch_width
+         b% f_sync_switch_lim = f_sync_switch_lim
+         b% use_other_tidal_deformation_switch_function = use_other_tidal_deformation_switch_function
          b% use_other_rlo_mdot = use_other_rlo_mdot
          b% use_other_check_implicit_rlo = use_other_check_implicit_rlo
          b% use_other_implicit_function_to_solve = use_other_implicit_function_to_solve
@@ -705,6 +715,11 @@ subroutine set_binary_controls_for_writing(b, ierr)
          ! miscellaneous controls
          keep_donor_fixed = b% keep_donor_fixed
          mdot_limit_donor_switch = b% mdot_limit_donor_switch
+         use_tidal_deformation = b% use_tidal_deformation
+         f_sync_switch_from_rot_defor = b% f_sync_switch_from_rot_defor
+         f_sync_switch_width = b% f_sync_switch_width
+         f_sync_switch_lim = b% f_sync_switch_lim
+         use_other_tidal_deformation_switch_function = b% use_other_tidal_deformation_switch_function
          use_other_rlo_mdot = b% use_other_rlo_mdot
          use_other_check_implicit_rlo = b% use_other_check_implicit_rlo
          use_other_implicit_function_to_solve = b% use_other_implicit_function_to_solve