add track file type hierarchy, subscription-based event selection

Author: wpbonelli

autotest/__snapshots__/test_prt_ats/test_mf6model[0-case0].npy

@@ -25,6 +25,14 @@ module PrtPrpInputModule
     logical :: trackcsvfr = .false.
     logical :: trackcsv = .false.
     logical :: trackcsvfile = .false.
+    logical :: track_release = .false.
+    logical :: track_exit = .false.
+    logical :: track_subf_exit = .false.
+    logical :: track_timestep = .false.
+    logical :: track_terminate = .false.
+    logical :: track_weaksink = .false.
+    logical :: track_usertime = .false.
+    logical :: track_dropped = .false.
     logical :: stoptime = .false.
     logical :: stoptraveltime = .false.
     logical :: istopweaksink = .false.
@@ -314,6 +322,158 @@ module PrtPrpInputModule
     .false. & ! timeseries
     )
 
+  type(InputParamDefinitionType), parameter :: &
+    prtprp_track_release = InputParamDefinitionType &
+    ( &
+    'PRT', & ! component
+    'PRP', & ! subcomponent
+    'OPTIONS', & ! block
+    'TRACK_RELEASE', & ! tag name
+    'TRACK_RELEASE', & ! fortran variable
+    'KEYWORD', & ! type
+    '', & ! shape
+    'track release events', & ! longname
+    .false., & ! required
+    .false., & ! developmode
+    .false., & ! multi-record
+    .false., & ! preserve case
+    .false., & ! layered
+    .false. & ! timeseries
+    )
+
+  type(InputParamDefinitionType), parameter :: &
+    prtprp_track_exit = InputParamDefinitionType &
+    ( &
+    'PRT', & ! component
+    'PRP', & ! subcomponent
+    'OPTIONS', & ! block
+    'TRACK_EXIT', & ! tag name
+    'TRACK_EXIT', & ! fortran variable
+    'KEYWORD', & ! type
+    '', & ! shape
+    'track grid feature exit events', & ! longname
+    .false., & ! required
+    .false., & ! developmode
+    .false., & ! multi-record
+    .false., & ! preserve case
+    .false., & ! layered
+    .false. & ! timeseries
+    )
+
+  type(InputParamDefinitionType), parameter :: &
+    prtprp_track_subf_exit = InputParamDefinitionType &
+    ( &
+    'PRT', & ! component
+    'PRP', & ! subcomponent
+    'OPTIONS', & ! block
+    'TRACK_SUBFEATURE_EXIT', & ! tag name
+    'TRACK_SUBF_EXIT', & ! fortran variable
+    'KEYWORD', & ! type
+    '', & ! shape
+    'track sub-grid-scale feature exit events', & ! longname
+    .false., & ! required
+    .false., & ! developmode
+    .false., & ! multi-record
+    .false., & ! preserve case
+    .false., & ! layered
+    .false. & ! timeseries
+    )
+
+  type(InputParamDefinitionType), parameter :: &
+    prtprp_track_timestep = InputParamDefinitionType &
+    ( &
+    'PRT', & ! component
+    'PRP', & ! subcomponent
+    'OPTIONS', & ! block
+    'TRACK_TIMESTEP', & ! tag name
+    'TRACK_TIMESTEP', & ! fortran variable
+    'KEYWORD', & ! type
+    '', & ! shape
+    'track timestep end events', & ! longname
+    .false., & ! required
+    .false., & ! developmode
+    .false., & ! multi-record
+    .false., & ! preserve case
+    .false., & ! layered
+    .false. & ! timeseries
+    )
+
+  type(InputParamDefinitionType), parameter :: &
+    prtprp_track_terminate = InputParamDefinitionType &
+    ( &
+    'PRT', & ! component
+    'PRP', & ! subcomponent
+    'OPTIONS', & ! block
+    'TRACK_TERMINATE', & ! tag name
+    'TRACK_TERMINATE', & ! fortran variable
+    'KEYWORD', & ! type
+    '', & ! shape
+    'track termination events', & ! longname
+    .false., & ! required
+    .false., & ! developmode
+    .false., & ! multi-record
+    .false., & ! preserve case
+    .false., & ! layered
+    .false. & ! timeseries
+    )
+
+  type(InputParamDefinitionType), parameter :: &
+    prtprp_track_weaksink = InputParamDefinitionType &
+    ( &
+    'PRT', & ! component
+    'PRP', & ! subcomponent
+    'OPTIONS', & ! block
+    'TRACK_WEAKSINK', & ! tag name
+    'TRACK_WEAKSINK', & ! fortran variable
+    'KEYWORD', & ! type
+    '', & ! shape
+    'track weak sink exit events', & ! longname
+    .false., & ! required
+    .false., & ! developmode
+    .false., & ! multi-record
+    .false., & ! preserve case
+    .false., & ! layered
+    .false. & ! timeseries
+    )
+
+  type(InputParamDefinitionType), parameter :: &
+    prtprp_track_usertime = InputParamDefinitionType &
+    ( &
+    'PRT', & ! component
+    'PRP', & ! subcomponent
+    'OPTIONS', & ! block
+    'TRACK_USERTIME', & ! tag name
+    'TRACK_USERTIME', & ! fortran variable
+    'KEYWORD', & ! type
+    '', & ! shape
+    'track user-specified time events', & ! longname
+    .false., & ! required
+    .false., & ! developmode
+    .false., & ! multi-record
+    .false., & ! preserve case
+    .false., & ! layered
+    .false. & ! timeseries
+    )
+
+  type(InputParamDefinitionType), parameter :: &
+    prtprp_track_dropped = InputParamDefinitionType &
+    ( &
+    'PRT', & ! component
+    'PRP', & ! subcomponent
+    'OPTIONS', & ! block
+    'TRACK_DROPPED', & ! tag name
+    'TRACK_DROPPED', & ! fortran variable
+    'KEYWORD', & ! type
+    '', & ! shape
+    'track water table drop events', & ! longname
+    .false., & ! required
+    .false., & ! developmode
+    .false., & ! multi-record
+    .false., & ! preserve case
+    .false., & ! layered
+    .false. & ! timeseries
+    )
+
   type(InputParamDefinitionType), parameter :: &
     prtprp_stoptime = InputParamDefinitionType &
     ( &
@@ -938,6 +1098,14 @@ module PrtPrpInputModule
     prtprp_trackcsvfr, &
     prtprp_trackcsv, &
     prtprp_trackcsvfile, &
+    prtprp_track_release, &
+    prtprp_track_exit, &
+    prtprp_track_subf_exit, &
+    prtprp_track_timestep, &
+    prtprp_track_terminate, &
+    prtprp_track_weaksink, &
+    prtprp_track_usertime, &
+    prtprp_track_dropped, &
     prtprp_stoptime, &
     prtprp_stoptraveltime, &
     prtprp_istopweaksink, &

autotest/__snapshots__/test_prt_ats/test_mf6model[1-case1].npy

@@ -14,9 +14,11 @@ module PrtPrpModule
   use SimVariablesModule, only: errmsg, warnmsg
   use ParticleTracksModule, only: ParticleTracksType, &
                                   TRACKHEADER, TRACKDTYPES
+  use ParticleTrackEventBufferModule, only: ParticleTrackEventSelectionType
   use GeomUtilModule, only: point_in_polygon, get_ijk, get_jk
   use MemoryManagerModule, only: mem_allocate, mem_deallocate, &
                                  mem_reallocate
+  use MemoryManagerExtModule, only: mem_set_value
   use ParticleReleaseScheduleModule, only: ParticleReleaseScheduleType, &
                                            create_release_schedule
   use DisModule, only: DisType
@@ -48,6 +50,8 @@ module PrtPrpModule
     integer(I4B), pointer :: itrkout => null() !< binary track file
     integer(I4B), pointer :: itrkhdr => null() !< track header file
     integer(I4B), pointer :: itrkcsv => null() !< CSV track file
+    logical(LGP) :: prp_has_selection = .false. !< true if TRACK_* keywords were specified
+    type(ParticleTrackEventSelectionType) :: prp_selected !< per-PRP event selection
     integer(I4B), pointer :: irlstls => null() !< release time file
     integer(I4B), pointer :: iexmeth => null() !< method for iterative solution of particle exit location and time in generalized Pollock's method
     integer(I4B), pointer :: ichkmeth => null() !< method for checking particle release coordinates are in the specified cells, 0 = none, 1 = eager
@@ -879,6 +883,7 @@ subroutine prp_options(this)
       &[character(len=LENVARNAME) :: 'NONE', 'EAGER']
     character(len=LINELENGTH) :: trackfile, trackcsvfile, fname
     type(PrtPrpParamFoundType) :: found
+    integer(I4B), pointer :: evinput
     character(len=*), parameter :: fmtextolwrn = &
       "('WARNING: EXIT_SOLVE_TOLERANCE is set to ',g10.3,' &
       &which is much greater than the default value of ',g10.3,'. &
@@ -907,6 +912,60 @@ subroutine prp_options(this)
                        found%trackfile)
     call mem_set_value(trackcsvfile, 'TRACKCSVFILE', this%input_mempath, &
                        found%trackcsvfile)
+
+    ! per-PRP event selection keywords (same names as OC)
+    allocate (evinput)
+    call mem_set_value(evinput, 'TRACK_RELEASE', this%input_mempath, &
+                       found%track_release)
+    call mem_set_value(evinput, 'TRACK_EXIT', this%input_mempath, &
+                       found%track_exit)
+    call mem_set_value(evinput, 'TRACK_SUBF_EXIT', this%input_mempath, &
+                       found%track_subf_exit)
+    call mem_set_value(evinput, 'TRACK_TIMESTEP', this%input_mempath, &
+                       found%track_timestep)
+    call mem_set_value(evinput, 'TRACK_TERMINATE', this%input_mempath, &
+                       found%track_terminate)
+    call mem_set_value(evinput, 'TRACK_WEAKSINK', this%input_mempath, &
+                       found%track_weaksink)
+    call mem_set_value(evinput, 'TRACK_USERTIME', this%input_mempath, &
+                       found%track_usertime)
+    call mem_set_value(evinput, 'TRACK_DROPPED', this%input_mempath, &
+                       found%track_dropped)
+
+    if (found%track_release) then
+      this%prp_selected%release = .true.
+      this%prp_has_selection = .true.
+    end if
+    if (found%track_exit) then
+      this%prp_selected%featexit = .true.
+      this%prp_has_selection = .true.
+    end if
+    if (found%track_subf_exit) then
+      this%prp_selected%subfexit = .true.
+      this%prp_has_selection = .true.
+    end if
+    if (found%track_timestep) then
+      this%prp_selected%timestep = .true.
+      this%prp_has_selection = .true.
+    end if
+    if (found%track_terminate) then
+      this%prp_selected%terminate = .true.
+      this%prp_has_selection = .true.
+    end if
+    if (found%track_weaksink) then
+      this%prp_selected%weaksink = .true.
+      this%prp_has_selection = .true.
+    end if
+    if (found%track_usertime) then
+      this%prp_selected%usertime = .true.
+      this%prp_has_selection = .true.
+    end if
+    if (found%track_dropped) then
+      this%prp_selected%dropped = .true.
+      this%prp_has_selection = .true.
+    end if
+    deallocate (evinput)
+
     call mem_set_value(this%localz, 'LOCALZ', this%input_mempath, &
                        found%localz)
     call mem_set_value(this%extend, 'EXTEND', this%input_mempath, &

src/Idm/prt-prpidm.f90

@@ -22,6 +22,7 @@ module PrtModule
   use ParticleEventsModule, only: ParticleEventDispatcherType, handle_event
   use ParticleTracksModule, only: ParticleTracksType, &
                                   ParticleTrackFileType, &
+                                  ParticleTrackEventSelectionType, &
                                   add_particle_event
   use SimModule, only: count_errors, store_error, store_error_filename
   use MemoryManagerModule, only: mem_allocate
@@ -253,6 +254,7 @@ subroutine prt_ar(this)
     integer(I4B) :: ip, nprp
     class(BndType), pointer :: packobj
     class(*), pointer :: p
+    type(ParticleTrackEventSelectionType) :: model_sel, prp_sel
 
     ! Set up basic packages
     call this%fmi%fmi_ar(this%ibound)
@@ -265,16 +267,15 @@ subroutine prt_ar(this)
     ! 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, &
-      this%oc%trackfeatexit, &
-      this%oc%tracktimestep, &
-      this%oc%trackterminate, &
-      this%oc%trackweaksink, &
-      this%oc%trackusertime, &
-      this%oc%tracksubfexit, &
-      this%oc%trackdropped)
+    ! Build event selection from OC for model-level files
+    model_sel%release = this%oc%trackrelease
+    model_sel%featexit = this%oc%trackfeatexit
+    model_sel%subfexit = this%oc%tracksubfexit
+    model_sel%timestep = this%oc%tracktimestep
+    model_sel%terminate = this%oc%trackterminate
+    model_sel%weaksink = this%oc%trackweaksink
+    model_sel%usertime = this%oc%trackusertime
+    model_sel%dropped = this%oc%trackdropped
 
     ! Set up boundary pkgs and pkg-scoped track files
     nprp = 0
@@ -286,16 +287,24 @@ subroutine prt_ar(this)
         call packobj%prp_set_pointers(this%ibound, this%mip%izone)
         call packobj%bnd_ar()
         call packobj%bnd_ar()
+        ! Use per-PRP selection if specified, otherwise inherit OC selection
+        if (packobj%prp_has_selection) then
+          prp_sel = packobj%prp_selected
+        else
+          prp_sel = model_sel
+        end if
         if (packobj%itrkout > 0) then
           call this%tracks%init_file( &
             packobj%itrkout, &
-            iprp=nprp)
+            iprp=nprp, &
+            selected=prp_sel)
         end if
         if (packobj%itrkcsv > 0) then
           call this%tracks%init_file( &
             packobj%itrkcsv, &
             csv=.true., &
-            iprp=nprp)
+            iprp=nprp, &
+            selected=prp_sel)
         end if
       class default
         call packobj%bnd_ar()
@@ -304,9 +313,10 @@ subroutine prt_ar(this)
 
     ! Set up model-scoped track files
     if (this%oc%itrkout > 0) &
-      call this%tracks%init_file(this%oc%itrkout)
+      call this%tracks%init_file(this%oc%itrkout, selected=model_sel)
     if (this%oc%itrkcsv > 0) &
-      call this%tracks%init_file(this%oc%itrkcsv, csv=.true.)
+      call this%tracks%init_file(this%oc%itrkcsv, csv=.true., &
+                                 selected=model_sel)
 
     ! Initialize and select the tracking method based on discretization
     select type (dis => this%dis)

src/Model/ParticleTracking/prt-prp.f90

@@ -9,6 +9,7 @@ module ParticleEventModule
   public :: ParticleEventType
   public :: RELEASE
   public :: FEATEXIT
+  public :: SUBFEXIT
   public :: TIMESTEP
   public :: TERMINATE
   public :: WEAKSINK
@@ -28,6 +29,7 @@ module ParticleEventModule
     enumerator :: WEAKSINK = 4 !< particle entered a weak sink
     enumerator :: USERTIME = 5 !< user-specified tracking time
     enumerator :: DROPPED = 6 !< particle dropped to the water table
+    enumerator :: SUBFEXIT = 7 !< particle exited a sub-grid-scale feature
   end enum
 
   !> @brief Base type for particle events.

src/Model/ParticleTracking/prt.f90

@@ -3,7 +3,7 @@ module SubCellExitEventModule
   use ConstantsModule, only: LENHUGELINE
   use ErrorUtilModule, only: pstop
   use ParticleModule, only: ParticleType
-  use ParticleEventModule, only: FEATEXIT
+  use ParticleEventModule, only: SUBFEXIT
   use FeatExitEventModule, only: FeatExitEventType
   implicit none
 
@@ -24,7 +24,7 @@ module SubCellExitEventModule
   function get_code(this) result(code)
     class(SubCellExitEventType), intent(in) :: this
     integer(I4B) :: code
-    code = FEATEXIT
+    code = SUBFEXIT
   end function get_code
 
   function get_verb(this) result(verb)