helio_module.f90 Source File

! Copyright 2024 - The Minton Group at Purdue University
! This file is part of Swiftest.
! Swiftest is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License 
! as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
! Swiftest 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 General Public License for more details.
! You should have received a copy of the GNU General Public License along with Swiftest. 
! If not, see: https://www.gnu.org/licenses. 

module helio
   !! author: The Purdue Swiftest Team - David A. Minton, Carlisle A. Wishard, Jennifer L.L. Pouplin, and Jacob R. Elliott
   !!
   !! Definition of classes and methods specific to the Democratic Heliocentric Method
   !! Adapted from David E. Kaufmann's Swifter routine: module_helio.f90
   use swiftest
   use whm
   implicit none
   public


   type, extends(whm_nbody_system) :: helio_nbody_system
   contains
      procedure :: step       => helio_step_system             
         !! Advance the Helio nbody system forward in time by one step
      procedure :: initialize => helio_util_setup_initialize_system 
         !! Performs Helio-specific initilization steps, including converting to DH coordinates
   end type helio_nbody_system


   !> Helio central body particle class
   type, extends(swiftest_cb) :: helio_cb
      real(DP), dimension(NDIM)  :: ptbeg 
         !! negative barycentric velocity of the central body at the beginning of time step
      real(DP), dimension(NDIM)  :: ptend 
         !! negative barycentric velocity of the central body at the end of time step
   contains
   end type helio_cb


   !> Helio massive body particle class
   type, extends(swiftest_pl) :: helio_pl
   contains
      procedure :: drift       => helio_drift_pl           
         !! Method for Danby drift in Democratic Heliocentric coordinates 
      procedure :: lindrift    => helio_drift_linear_pl    
         !! Method for linear drift of massive bodies due to barycentric momentum of Sun
      procedure :: accel_gr    => helio_gr_kick_getacch_pl 
         !! Acceleration term arising from the post-Newtonian correction
      procedure :: gr_pos_kick => helio_gr_p4_pl           
         !! Position kick due to p**4 term in the post-Newtonian correction
      procedure :: accel       => helio_kick_getacch_pl    
         !! Compute heliocentric accelerations of massive bodies
      procedure :: kick        => helio_kick_vb_pl         
         !! Kicks the barycentric velocities
      procedure :: step        => helio_step_pl            
         !! Steps the body forward one stepsize
   end type helio_pl


   !> Helio test particle class
   type, extends(swiftest_tp) :: helio_tp
   contains
      procedure :: lindrift    => helio_drift_linear_tp    
         !! Method for linear drift of massive bodies due to barycentric momentum of Sun
      procedure :: drift       => helio_drift_tp           
         !! Method for Danby drift in Democratic Heliocentric coordinates 
      procedure :: accel_gr    => helio_gr_kick_getacch_tp 
         !! Acceleration term arising from the post-Newtonian correction
      procedure :: gr_pos_kick => helio_gr_p4_tp           
         !! Position kick due to p**4 term in the post-Newtonian correction
      procedure :: accel       => helio_kick_getacch_tp    
         !! Compute heliocentric accelerations of massive bodies
      procedure :: kick        => helio_kick_vb_tp         
         !! Kicks the barycentric velocities
      procedure :: step        => helio_step_tp            
         !! Steps the body forward one stepsize
   end type helio_tp

   interface
      module subroutine helio_drift_body(self, nbody_system, param, dt)
         implicit none
         class(swiftest_body),         intent(inout) :: self   
            !! Swiftest massive body object
         class(swiftest_nbody_system), intent(inout) :: nbody_system 
            !! Swiftest nbody system object
         class(swiftest_parameters),   intent(in)    :: param  
            !! Current run configuration parameters 
         real(DP),                     intent(in)    :: dt     
            !! Stepsize
      end subroutine helio_drift_body
   
      module subroutine helio_drift_pl(self, nbody_system, param, dt)
         implicit none
         class(helio_pl),              intent(inout) :: self   
            !! Helio massive body object
         class(swiftest_nbody_system), intent(inout) :: nbody_system 
            !! Swiftest nbody system object
         class(swiftest_parameters),   intent(in)    :: param  
            !! Current run configuration parameters 
         real(DP),                     intent(in)    :: dt     
            !! Stepsize
      end subroutine helio_drift_pl

      module subroutine helio_drift_tp(self, nbody_system, param, dt)
         implicit none
         class(helio_tp),              intent(inout) :: self   
            !! Helio massive body object
         class(swiftest_nbody_system), intent(inout) :: nbody_system 
            !! Swiftest nbody system object
         class(swiftest_parameters),   intent(in)    :: param  
            !! Current run configuration parameters 
         real(DP),                     intent(in)    :: dt     
            !! Stepsize
      end subroutine helio_drift_tp

      module subroutine helio_drift_linear_pl(self, cb, dt, lbeg)
         implicit none
         class(helio_pl),               intent(inout) :: self 
            !! Helio massive body object
         class(helio_cb),               intent(inout) :: cb   
            !! Helio central body
         real(DP),                      intent(in)    :: dt   
            !! Stepsize
         logical,                       intent(in)    :: lbeg 
            !! Argument that determines whether or not this is the beginning or end of the step
      end subroutine helio_drift_linear_pl 

      module subroutine helio_drift_linear_tp(self, cb, dt, lbeg)
         implicit none
         class(helio_tp),               intent(inout) :: self 
            !! Helio test particle object
         class(helio_cb),               intent(in)    :: cb   
            !! Helio central body
         real(DP),                      intent(in)    :: dt   
            !! Stepsize
         logical,                       intent(in)    :: lbeg 
            !! Argument that determines whether or not this is the beginning or end of the step
      end subroutine helio_drift_linear_tp

      pure module subroutine helio_gr_kick_getacch_pl(self, param) 
         implicit none
         class(helio_pl),            intent(inout) :: self   
            !! Helio massive body particle data structure
         class(swiftest_parameters), intent(in)    :: param 
            !! Current run configuration parameters 
      end subroutine helio_gr_kick_getacch_pl
   
      pure module subroutine helio_gr_kick_getacch_tp(self, param)
         implicit none
         class(helio_tp),            intent(inout) :: self   
            !! Helio massive body particle data structure
         class(swiftest_parameters), intent(in)    :: param  
            !! Current run configuration parameters 
      end subroutine helio_gr_kick_getacch_tp
      
      pure module subroutine helio_gr_p4_pl(self, nbody_system, param, dt)
         implicit none
         class(helio_pl),              intent(inout) :: self   
            !! Swiftest particle object
         class(swiftest_nbody_system), intent(inout) :: nbody_system 
            !! Swiftest nbody system object
         class(swiftest_parameters),   intent(in)    :: param  
            !! Current run configuration parameters 
         real(DP),                     intent(in)    :: dt     
            !! Step size
      end subroutine helio_gr_p4_pl
   
      pure module subroutine helio_gr_p4_tp(self, nbody_system, param, dt)
         implicit none
         class(helio_tp),              intent(inout) :: self   
            !! Swiftest particle object
         class(swiftest_nbody_system), intent(inout) :: nbody_system 
            !! Swiftest nbody system object
         class(swiftest_parameters),   intent(in)    :: param  
            !! Current run configuration parameters 
         real(DP),                     intent(in)    :: dt     
            !! Step size
      end subroutine helio_gr_p4_tp

      module subroutine helio_kick_getacch_pl(self, nbody_system, param, t, lbeg)
         implicit none
         class(helio_pl),              intent(inout) :: self   
            !! Helio massive body object
         class(swiftest_nbody_system), intent(inout) :: nbody_system 
            !! Swiftest nbody system object
         class(swiftest_parameters),   intent(inout) :: param  
            !! Current run configuration parameters 
         real(DP),                     intent(in)    :: t      
            !! Current simulation time
         logical,                      intent(in)    :: lbeg   
            !! Logical flag that determines whether or not this is the beginning or end of the step
      end subroutine helio_kick_getacch_pl

      module subroutine helio_kick_getacch_tp(self, nbody_system, param, t, lbeg)
         implicit none
         class(helio_tp),              intent(inout) :: self   
            !! Helio test particle object
         class(swiftest_nbody_system), intent(inout) :: nbody_system 
            !! Swiftest nbody system object
         class(swiftest_parameters),   intent(inout) :: param  
            !! Current run configuration parameters
         real(DP),                     intent(in)    :: t      
            !! Current time
         logical,                      intent(in)    :: lbeg   
            !! Logical flag that determines whether or not this is the beginning or end of the step
      end subroutine helio_kick_getacch_tp

      module subroutine helio_kick_vb_pl(self, nbody_system, param, t, dt, lbeg)
         implicit none
         class(helio_pl),              intent(inout) :: self   
            !! Helio massive body object
         class(swiftest_nbody_system), intent(inout) :: nbody_system 
            !! Swiftest nbody system object
         class(swiftest_parameters),   intent(inout) :: param  
            !! Current run configuration parameters 
         real(DP),                     intent(in)    :: t      
            !! Current time
         real(DP),                     intent(in)    :: dt     
            !! Stepsize
         logical,                      intent(in)    :: lbeg   
            !! Logical flag indicating whether this is the beginning of the half step or not. 
      end subroutine helio_kick_vb_pl

      module subroutine helio_kick_vb_tp(self, nbody_system, param, t, dt, lbeg)
         implicit none
         class(helio_tp),              intent(inout) :: self   
            !! Helio test particle object
         class(swiftest_nbody_system), intent(inout) :: nbody_system 
            !! Swiftest nbody system object
         class(swiftest_parameters),   intent(inout) :: param  
            !! Current run configuration parameters 
         real(DP),                     intent(in)    :: t      
            !! Current time
         real(DP),                     intent(in)    :: dt     
            !! Stepsize
         logical,                      intent(in)    :: lbeg   
            !! Logical flag indicating whether this is the beginning of the half step or not. 
      end subroutine helio_kick_vb_tp

      module subroutine helio_util_setup_initialize_system(self, system_history, param)
         implicit none
         class(helio_nbody_system),               intent(inout) :: self           
            !! Helio nbody system object
         class(swiftest_storage),    allocatable, intent(inout) :: system_history 
            !! Stores the system history between output dumps
         class(swiftest_parameters),              intent(inout) :: param          
            !! Current run configuration parameters 
      end subroutine helio_util_setup_initialize_system

      module subroutine helio_step_pl(self, nbody_system, param, t, dt)
         implicit none
         class(helio_pl),              intent(inout) :: self   
            !! Helio massive body particle object
         class(swiftest_nbody_system), intent(inout) :: nbody_system 
            !! Swiftest nbody system
         class(swiftest_parameters),   intent(inout) :: param  
            !! Current run configuration parameters 
         real(DP),                     intent(in)    :: t      
            !! Current simulation time
         real(DP),                     intent(in)    :: dt     
            !! Stepsize
      end subroutine helio_step_pl

      module subroutine helio_step_system(self, param, t, dt)
         implicit none
         class(helio_nbody_system),  intent(inout) :: self  
            !! Helio nbody system object
         class(swiftest_parameters), intent(inout) :: param 
            !! Current run configuration parameters
         real(DP),                   intent(in)    :: t     
            !! Simulation time
         real(DP),                   intent(in)    :: dt    
            !! Current stepsize
      end subroutine helio_step_system

      module subroutine helio_step_tp(self, nbody_system, param, t, dt)
         implicit none
         class(helio_tp),              intent(inout) :: self   
            !! Helio test particle object
         class(swiftest_nbody_system), intent(inout) :: nbody_system 
            !! Swiftest nbody system object
         class(swiftest_parameters),   intent(inout) :: param  
            !! Current run configuration parameters 
         real(DP),                     intent(in)    :: t      
            !! Current simulation time
         real(DP),                     intent(in)    :: dt     
            !! Stepsizee
      end subroutine helio_step_tp
   end interface

end module helio