feat(prt): configurable event buffering

Author: wpbonelli

doc/mf6io/mf6ivar/dfn/prt-oc.dfn

@@ -292,6 +292,14 @@ mf6internal dev_dump_evtrace
 longname print particle tracking events
 description print a verbose particle tracking event trace to standard output
 
+block options
+name scratch_buffer
+type keyword
+reader urword
+optional true
+longname buffer track events in scratch file instead of memory
+description keyword to stage track events in a scratch file instead of an in-memory buffer, which prevents out-of-memory errors for simulations with very many particles or events
+
 # --------------------- prt oc dimensions ------------------
 
 block dimensions

src/Idm/prt-ocidm.f90

@@ -40,6 +40,7 @@ module PrtOcInputModule
     logical :: track_timesfile = .false.
     logical :: timesfile = .false.
     logical :: dev_dump_evtrace = .false.
+    logical :: scratch_buffer = .false.
     logical :: ntracktimes = .false.
     logical :: time = .false.
     logical :: saverecord = .false.
@@ -594,6 +595,25 @@ module PrtOcInputModule
     .false. & ! timeseries
     )
 
+  type(InputParamDefinitionType), parameter :: &
+    prtoc_scratch_buffer = InputParamDefinitionType &
+    ( &
+    'PRT', & ! component
+    'OC', & ! subcomponent
+    'OPTIONS', & ! block
+    'SCRATCH_BUFFER', & ! tag name
+    'SCRATCH_BUFFER', & ! fortran variable
+    'KEYWORD', & ! type
+    '', & ! shape
+    'buffer track events in scratch file instead of memory', & ! longname
+    .false., & ! required
+    .false., & ! developmode
+    .false., & ! multi-record
+    .false., & ! preserve case
+    .false., & ! layered
+    .false. & ! timeseries
+    )
+
   type(InputParamDefinitionType), parameter :: &
     prtoc_ntracktimes = InputParamDefinitionType &
     ( &
@@ -853,6 +873,7 @@ module PrtOcInputModule
     prtoc_track_timesfile, &
     prtoc_timesfile, &
     prtoc_dev_dump_evtrace, &
+    prtoc_scratch_buffer, &
     prtoc_ntracktimes, &
     prtoc_time, &
     prtoc_saverecord, &

src/Model/ParticleTracking/prt-oc.f90

@@ -33,6 +33,7 @@ module PrtOcModule
     logical(LGP), pointer :: trackdropped => null() !< whether to track drops to water table
     integer(I4B), pointer :: ntracktimes => null() !< number of user-specified tracking times
     logical(LGP), pointer :: dump_event_trace => null() !< whether to dump event trace for debugging
+    logical(LGP), pointer :: scratch_buffer => null() !< whether to use scratch file instead of memory for event buffering
     type(TimeSelectType), pointer :: tracktimes !< user-specified tracking times
 
   contains
@@ -78,6 +79,7 @@ subroutine prt_oc_allocate_scalars(this, name_model, input_mempath)
     allocate (this%name_model)
     allocate (this%input_fname)
     call mem_allocate(this%dump_event_trace, 'DUMP_EVENT_TRACE', this%memoryPath)
+    call mem_allocate(this%scratch_buffer, 'SCRATCH_BUFFER', this%memoryPath)
     call mem_allocate(this%inunit, 'INUNIT', this%memoryPath)
     call mem_allocate(this%iout, 'IOUT', this%memoryPath)
     call mem_allocate(this%ibudcsv, 'IBUDCSV', this%memoryPath)
@@ -101,6 +103,7 @@ subroutine prt_oc_allocate_scalars(this, name_model, input_mempath)
     this%input_mempath = input_mempath
     this%input_fname = ''
     this%dump_event_trace = .false.
+    this%scratch_buffer = .false.
     this%inunit = 0
     this%iout = 0
     this%ibudcsv = 0
@@ -178,6 +181,7 @@ subroutine prt_oc_da(this)
 
     deallocate (this%name_model)
     call mem_deallocate(this%dump_event_trace)
+    call mem_deallocate(this%scratch_buffer)
     call mem_deallocate(this%inunit)
     call mem_deallocate(this%iout)
     call mem_deallocate(this%ibudcsv)
@@ -251,6 +255,8 @@ subroutine prt_oc_source_options(this)
                        found%track_usertime)
     call mem_set_value(evinput, 'DEV_DUMP_EVTRACE', this%input_mempath, &
                        found%dev_dump_evtrace)
+    call mem_set_value(evinput, 'SCRATCH_BUFFER', this%input_mempath, &
+                       found%scratch_buffer)
 
     if (found%track_release) this%trackrelease = .true.
     if (found%track_exit) this%trackfeatexit = .true.
@@ -261,6 +267,7 @@ subroutine prt_oc_source_options(this)
     if (found%track_weaksink) this%trackweaksink = .true.
     if (found%track_usertime) this%trackusertime = .true.
     if (found%dev_dump_evtrace) this%dump_event_trace = .true.
+    if (found%scratch_buffer) this%scratch_buffer = .true.
 
     ! default to all events
     if (.not. (found%track_release .or. &

src/Model/ParticleTracking/prt.f90

@@ -22,7 +22,7 @@ module PrtModule
   use ParticleEventsModule, only: ParticleEventDispatcherType, handle_event
   use ParticleTracksModule, only: ParticleTracksType, &
                                   ParticleTrackFileType, &
-                                  write_particle_event
+                                  add_particle_event
   use SimModule, only: count_errors, store_error, store_error_filename
   use MemoryManagerModule, only: mem_allocate
   use MethodModule, only: MethodType, LEVEL_FEATURE
@@ -53,7 +53,7 @@ module PrtModule
     type(MethodDisType), pointer :: method_dis => null() ! DIS tracking method
     type(MethodDisvType), pointer :: method_disv => null() ! DISV tracking method
     type(ParticleEventDispatcherType), pointer :: events => null() ! event dispatcher
-    class(ParticleTracksType), pointer :: tracks ! track output manager
+    type(ParticleTracksType), pointer :: tracks ! track output manager
     integer(I4B), pointer :: infmi => null() ! unit number FMI
     integer(I4B), pointer :: inmip => null() ! unit number MIP
     integer(I4B), pointer :: inmvt => null() ! unit number MVT
@@ -262,6 +262,9 @@ subroutine prt_ar(this)
     call this%oc%oc_ar(this%dis, DHNOFLO)
     call this%budget%set_ibudcsv(this%oc%ibudcsv)
 
+    ! Initialize the event buffer (memory or scratch file per OC option)
+    call this%tracks%init_buffer(this%oc%scratch_buffer)
+
     ! Select tracking events
     call this%tracks%select_events( &
       this%oc%trackrelease, &
@@ -331,7 +334,7 @@ subroutine prt_ar(this)
 
     ! Subscribe particle track output manager to events
     p => this%tracks
-    call this%events%subscribe(write_particle_event, p)
+    call this%events%subscribe(add_particle_event, p)
 
     ! Set verbose tracing if requested
     if (this%oc%dump_event_trace) this%tracks%iout = 0
@@ -573,7 +576,8 @@ subroutine prt_ot(this)
     integer(I4B) :: ibudfl
     integer(I4B) :: ipflag
 
-    ! Note: particle tracking output is handled elsewhere
+    ! Flush buffered events to disk
+    call this%tracks%flush_buffer()
 
     ! Set write and print flags
     idvsave = 0