Line data    Source code

       1              : ! ***********************************************************************
       2              : !
       3              : !   Copyright (C) 2025  Matthias Fabry and the MESA Team
       4              : !
       5              : !   MESA is free software; you can use it and/or modify
       6              : !   it under the combined terms and restrictions of the MESA MANIFESTO
       7              : !   and the GNU General Library Public License as published
       8              : !   by the Free Software Foundation; either version 2 of the License,
       9              : !   or (at your option) any later version.
      10              : !
      11              : !   You should have received a copy of the MESA MANIFESTO along with
      12              : !   this software; if not, it is available at the mesa website:
      13              : !   http://mesa.sourceforge.net/
      14              : !
      15              : !   MESA is distributed in the hope that it will be useful,
      16              : !   but WITHOUT ANY WARRANTY; without even the implied warranty of
      17              : !   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
      18              : !   See the GNU Library General Public License for more details.
      19              : !
      20              : !   You should have received a copy of the GNU Library General Public License
      21              : !   along with this software; if not, write to the Free Software
      22              : !   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
      23              : !
      24              : ! ***********************************************************************
      25              : 
      26              : module mod_other_tidal_deformation_switch_function
      27              : 
      28              :    ! NOTE: remember to set true:
      29              :    ! use_other_tidal_deformation_function = .true.
      30              : 
      31              :    ! you can add your own routine for use instead of the default one.
      32              :    ! the default routine uses the synchronicity parameter to switch from single rotating to tidal corrections.
      33              :    ! When the shell is quite synchronous, f_switch -> 1, when not synchronous, f_switch -> 0. It uses a sigmoid around
      34              :    ! omega/omega_sync = b% f_sync_switch_from_rot_defor to smoothly vary f_switch from 0 to 1.
      35              : 
      36              :    use const_def
      37              : 
      38              :    implicit none
      39              : 
      40              :    contains
      41              : 
      42            0 :    subroutine null_other_tidal_deformation_switch_function(id, k, omega_in, f_switch, ierr)
      43              :       integer, intent(in) :: id, k
      44              :       real(dp), intent(in) :: omega_in
      45              :       real(dp), intent(out) :: f_switch
      46              :       integer, intent(out) :: ierr
      47              :       include 'formats'
      48              : 
      49            0 :       write (*, 1) 'no implementation for other_tidal_deformation_function'
      50              :       ! must set f_switch
      51            0 :       ierr = -1
      52            0 :    end subroutine null_other_tidal_deformation_switch_function
      53              : 
      54              : 
      55              : end module mod_other_tidal_deformation_switch_function
      56              :