Updates to storage classes and methods

src/CMakeLists.txt

@@ -80,6 +80,7 @@ SET(FAST_MATH_FILES
             ${SRC}/util/util_minimize_bfgs.f90
             ${SRC}/util/util_peri.f90
             ${SRC}/util/util_rescale.f90
+            ${SRC}/util/util_reset.f90
             ${SRC}/util/util_resize.f90
             ${SRC}/util/util_set.f90
             ${SRC}/util/util_solve.f90

src/modules/swiftest_classes.f90

@@ -544,11 +544,13 @@ module swiftest_classes
 
    type :: swiftest_storage(nframes)
       !! An class that establishes the pattern for various storage objects
-      integer(I4B), len                                :: nframes    !! Total number of frames that can be stored
-      type(swiftest_storage_frame), dimension(nframes) :: frame      !! Array of stored frames
-      integer(I4B)                                     :: iframe = 0 !! The current frame number
+      integer(I4B), len                                :: nframes = 10 !! Total number of frames that can be stored
+      type(swiftest_storage_frame), dimension(nframes) :: frame        !! Array of stored frames
+      integer(I4B)                                     :: iframe = 0   !! The current frame number
    contains
-      procedure :: dump => io_dump_storage
+      procedure :: dump   => io_dump_storage     !! Dumps storage object contents to file
+      procedure :: reset  => util_reset_storage  !! Resets a storage object by deallocating all items and resetting the frame counter to 0
+      procedure :: resize => util_resize_storage 
    end type swiftest_storage
 
    abstract interface
@@ -1526,13 +1528,17 @@ module subroutine util_peri_tp(self, system, param)
          class(swiftest_parameters),   intent(in)    :: param  !! Current run configuration parameters
       end subroutine util_peri_tp
 
-
       module subroutine util_rescale_system(self, param, mscale, dscale, tscale)
          implicit none
          class(swiftest_nbody_system), intent(inout) :: self   !! Swiftest nbody system object
          class(swiftest_parameters),   intent(inout) :: param  !! Current run configuration parameters. Returns with new values of the scale vactors and GU
          real(DP),                     intent(in)    :: mscale, dscale, tscale !! Scale factors for mass, distance, and time units, respectively. 
       end subroutine util_rescale_system
+
+      module subroutine util_reset_storage(self)
+         implicit none
+         class(swiftest_storage(*)), intent(inout) :: self !! Swiftest storage object
+      end subroutine util_reset_storage
    end interface
 
 
@@ -1587,6 +1593,13 @@ module subroutine util_resize_pl(self, nnew)
          integer(I4B),       intent(in)    :: nnew !! New size neded
       end subroutine util_resize_pl
 
+      module subroutine util_resize_storage(self, nnew, new_storage)
+         implicit none
+         class(swiftest_storage(*)),                      intent(in)  :: self !! Swiftest storage object
+         integer(I4B),                                    intent(in)  :: nnew !! New size of list needed
+         class(swiftest_storage(*)), allocatable, intent(out) :: new_storage
+      end subroutine util_resize_storage
+
       module subroutine util_resize_tp(self, nnew)
          implicit none
          class(swiftest_tp), intent(inout) :: self !! Swiftest test particle object

src/modules/symba_classes.f90

@@ -208,7 +208,7 @@ module symba_classes
       class(symba_plplenc),                     allocatable :: plplenc_list       !! List of massive body-massive body encounters in a single step
       class(symba_plplenc),                     allocatable :: plplcollision_list !! List of massive body-massive body collisions in a single step
       integer(I4B)                                          :: irec               !! System recursion level
-      type(symba_encounter_storage(nframes=:)), allocatable :: encounter_history  !! Stores encounter history for later retrieval and saving to file
+      class(symba_encounter_storage(nframes=:)), allocatable :: encounter_history  !! Stores encounter history for later retrieval and saving to file
    contains
       procedure :: write_discard    => symba_io_write_discard             !! Write out information about discarded and merged planets and test particles in SyMBA
       procedure :: initialize       => symba_setup_initialize_system      !! Performs SyMBA-specific initilization steps

src/setup/setup.f90

@@ -67,6 +67,7 @@ module subroutine setup_construct_system(system, param)
             allocate(symba_merger :: system%pl_discards)
             allocate(symba_pltpenc :: system%pltpenc_list)
             allocate(symba_plplenc :: system%plplenc_list)
+            allocate(symba_encounter_storage :: system%encounter_history)
             allocate(symba_plplenc :: system%plplcollision_list)
          end select
       case (RINGMOONS)

src/symba/symba_step.f90

@@ -278,7 +278,6 @@ module subroutine symba_step_reset_system(self, param)
                   nenc_old = system%plplenc_list%nenc
                   call system%plplenc_list%setup(0_I8B)
                   call system%plplcollision_list%setup(0_I8B)
-                  if (allocated(system%encounter_history)) deallocate(system%encounter_history)
                   if (npl > 0) then
                      pl%lcollision(1:npl) = .false.
                      call pl%reset_kinship([(i, i=1, npl)])
@@ -313,8 +312,8 @@ module subroutine symba_step_reset_system(self, param)
                   tp%lfirst = param%lfirstkick
                   pl%lfirst = param%lfirstkick
 
-                  if (allocated(system%encounter_history)) deallocate(system%encounter_history)
-                  allocate(symba_encounter_storage(8) :: system%encounter_history)
+                  call system%encounter_history%reset()
+
                end associate
             end select
          end select

src/symba/symba_util.f90

@@ -918,34 +918,22 @@ module subroutine symba_util_resize_storage(self, nnew)
       class(symba_nbody_system), intent(inout) :: self !! Swiftest encounter list 
       integer(I4B),              intent(in)    :: nnew !! New size of list needed
       ! Internals
-      type(symba_encounter_storage(nframes=:)), allocatable :: tmp
-      integer(I4B) :: i, nold
-      logical      :: lmalloc
-
-
-      lmalloc = allocated(self%encounter_history)
-      if (lmalloc) then
-         nold = self%encounter_history%nframes
-      else
-         nold = 0
-      end if
-
-      if (nnew > nold) then
-         allocate(symba_encounter_storage(8 * nnew) :: tmp) 
-         if (lmalloc) then
-            do i = 1, nold
-               if (allocated(self%encounter_history%frame(i)%item)) tmp%frame(i) = self%encounter_history%frame(i)%item
-            end do
-            deallocate(self%encounter_history)
-         end if
-         call move_alloc(tmp,self%encounter_history)
+      class(swiftest_storage), allocatable :: tmp
+
+      if (nnew > self%encounter_history%nframes) then
+         call self%encounter_history%resize(nnew,tmp)
+         deallocate(self%encounter_history)
+         select type(tmp)
+         class is (symba_encounter_storage(*))
+            allocate(self%encounter_history, source=tmp)
+         end select
+         deallocate(tmp)
       end if
 
       return
    end subroutine symba_util_resize_storage
 
 
-
    module subroutine symba_util_resize_tp(self, nnew)
       !! author: David A. Minton
       !!
@@ -1323,6 +1311,8 @@ module subroutine symba_util_take_encounter_snapshot(self, param, t)
          if (npl > 0) allocate(symba_pl :: snapshot%pl)
          if (ntp > 0) allocate(symba_tp :: snapshot%tp)
          if (npl + ntp == 0) return
+         npl_snap = npl
+         ntp_snap = ntp
 
          select type (pl => self%pl)
          class is (symba_pl)
@@ -1384,6 +1374,7 @@ module subroutine symba_util_take_encounter_snapshot(self, param, t)
 
                ! Save the snapshot
                self%encounter_history%iframe = self%encounter_history%iframe + 1
+               call self%resize_storage(self%encounter_history%iframe)
                self%encounter_history%frame(self%encounter_history%iframe) = snapshot
             end select
          end select 

src/util/util_reset.f90

@@ -0,0 +1,32 @@
+!! Copyright 2022 - David Minton, Carlisle Wishard, Jennifer Pouplin, Jake Elliott, & Dana Singh
+!! 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. 
+
+submodule (swiftest_classes) s_util_reset
+   use swiftest
+contains
+
+   module subroutine util_reset_storage(self)
+      !! author: David A. Minton
+      !!
+      !! Resets a storage object by deallocating all items and resetting the frame counter to 0
+      implicit none
+      ! Arguments
+      class(swiftest_storage(*)), intent(inout) :: self !! Swiftest storage object
+      ! Internals
+      integer(I4B) :: i
+
+      do i = 1, self%nframes
+         if (allocated(self%frame(i)%item)) deallocate(self%frame(i)%item)
+      end do
+      self%iframe = 0
+
+      return
+   end subroutine util_reset_storage
+
+end submodule s_util_reset

src/util/util_resize.f90

@@ -350,6 +350,50 @@ module subroutine util_resize_pl(self, nnew)
    end subroutine util_resize_pl
 
 
+   module subroutine util_resize_storage(self, nnew, new_storage)
+      !! author: David A. Minton
+      !!
+      !! Checks the current size of the encounter storage against the required size and extends it by a factor of 2 more than requested if it is too small.
+      !! Note: The reason to extend it by a factor of 2 is for performance. When there are many enounters per step, resizing every time you want to add an 
+      !! encounter takes significant computational effort. Resizing by a factor of 2 is a tradeoff between performance (fewer resize calls) and memory managment
+      !! Memory usage grows by a factor of 2 each time it fills up, but no more. 
+      implicit none
+      ! Arguments
+      class(swiftest_storage(*)),           intent(in)  :: self         !! Swiftest storage_object
+      integer(I4B),                         intent(in)  :: nnew         !! New size of list needed
+      class(swiftest_storage), allocatable, intent(out) :: new_storage  !! New, resized storage
+      ! Internals
+      !type(symba_encounter_storage(nframes=:)), allocatable :: tmp
+      integer(I4B) :: i, nold, iframe_old, nbig
+
+      nold = self%nframes
+      iframe_old = self%iframe
+
+      if (nnew > nold) then
+         nbig = nold
+         do while (nbig < nnew)
+            nbig = 2*nbig
+         end do
+         select type(self)
+         class is (symba_encounter_storage(*))
+            allocate(symba_encounter_storage(nbig) :: new_storage) 
+         class is (swiftest_storage(*))
+            allocate(swiftest_storage(nbig) :: new_storage) 
+         end select
+         do i = 1, nold
+            if (allocated(self%frame(i)%item)) new_storage%frame(i) = self%frame(i)%item
+         end do
+      else
+         allocate(new_storage, source=self)
+      end if
+
+      new_storage%iframe = iframe_old
+      return
+   end subroutine util_resize_storage
+
+
+
+
    module subroutine util_resize_tp(self, nnew)
       !! author: David A. Minton
       !!