refactor(prt): rename particle idomain -> itrdomain (#2457)

Disambiguate particle tracking domain index from the existing grid-related term idomain by renaming to itrdomain

Author: wpbonelli

src/Model/ParticleTracking/prt-prp.f90

@@ -535,11 +535,11 @@ subroutine initialize_particle(this, particle, ip, trelease)
     end if
 
     particle%ttrack = particle%trelease
-    particle%idomain(1) = 0
+    particle%itrdomain(1) = 0
     particle%iboundary(1) = 0
-    particle%idomain(2) = ic
+    particle%itrdomain(2) = ic
     particle%iboundary(2) = 0
-    particle%idomain(3) = 0
+    particle%itrdomain(3) = 0
     particle%iboundary(3) = 0
     particle%ifrctrn = this%ifrctrn
     particle%iexmeth = this%iexmeth

src/Model/ParticleTracking/prt.f90

@@ -464,7 +464,7 @@ subroutine prt_cq_sto(this)
           istatus = packobj%particles%istatus(np)
           ! this may need to change if istatus flags change
           if ((istatus > 0) .and. (istatus /= 8)) then
-            n = packobj%particles%idomain(np, 2)
+            n = packobj%particles%itrdomain(np, 2)
             ! Each particle currently assigned unit mass
             this%masssto(n) = this%masssto(n) + DONE
           end if

src/Solution/ParticleTracker/Method/MethodCellPollock.f90

@@ -69,7 +69,7 @@ subroutine load_mcp(this, particle, next_level, submethod)
       events=this%events, &
       tracktimes=this%tracktimes)
     submethod => method_subcell_plck
-    particle%idomain(next_level) = 1
+    particle%itrdomain(next_level) = 1
   end subroutine load_mcp
 
   !> @brief Having exited the lone subcell, pass the particle to the cell face

src/Solution/ParticleTracker/Method/MethodCellPollockQuad.f90

@@ -81,7 +81,7 @@ subroutine pass_mcpq(this, particle)
     select type (cell => this%cell)
     type is (CellRectQuadType)
       exitFace = particle%iboundary(3)
-      isc = particle%idomain(3)
+      isc = particle%itrdomain(3)
       npolyverts = cell%defn%npolyverts
 
       ! exitFace uses MODPATH 7 iface convention here
@@ -93,12 +93,12 @@ subroutine pass_mcpq(this, particle)
         select case (isc)
         case (1)
           ! W face, subcell 1 --> E face, subcell 4  (cell interior)
-          particle%idomain(3) = 4
+          particle%itrdomain(3) = 4
           particle%iboundary(3) = 2
           inface = 0 ! want Domain(2) unchanged; Boundary(2) = 0
         case (2)
           ! W face, subcell 2 --> E face, subcell 3 (cell interior)
-          particle%idomain(3) = 3
+          particle%itrdomain(3) = 3
           particle%iboundary(3) = 2
           inface = 0 ! want Domain(2) unchanged; Boundary(2) = 0
         case (3)
@@ -122,20 +122,20 @@ subroutine pass_mcpq(this, particle)
           infaceoff = -1
         case (3)
           ! E face, subcell 3 --> W face, subcell 2 (cell interior)
-          particle%idomain(3) = 2
+          particle%itrdomain(3) = 2
           particle%iboundary(3) = 1
           inface = 0 ! want Domain(2) unchanged; Boundary(2) = 0
         case (4)
           ! E face, subcell 4 --> W face subcell 1 (cell interior)
-          particle%idomain(3) = 1
+          particle%itrdomain(3) = 1
           particle%iboundary(3) = 1
           inface = 0 ! want Domain(2) unchanged; Boundary(2) = 0
         end select
       case (3)
         select case (isc)
         case (1)
           ! S face, subcell 1 --> N face, subcell 2 (cell interior)
-          particle%idomain(3) = 2
+          particle%itrdomain(3) = 2
           particle%iboundary(3) = 4
           inface = 0 ! want Domain(2) unchanged; Boundary(2) = 0
         case (2)
@@ -148,7 +148,7 @@ subroutine pass_mcpq(this, particle)
           infaceoff = -1
         case (4)
           ! S face, subcell 4 --> N face, subcell 3 (cell interior)
-          particle%idomain(3) = 3
+          particle%itrdomain(3) = 3
           particle%iboundary(3) = 4
           inface = 0 ! want Domain(2) unchanged; Boundary(2) = 0
         end select
@@ -160,12 +160,12 @@ subroutine pass_mcpq(this, particle)
           infaceoff = -1
         case (2)
           ! N face, subcell 2 --> S face, subcell 1 (cell interior)
-          particle%idomain(3) = 1
+          particle%itrdomain(3) = 1
           particle%iboundary(3) = 3
           inface = 0 ! want Domain(2) unchanged; Boundary(2) = 0
         case (3)
           ! N face, subcell 3 --> S face, subcell 4 (cell interior)
-          particle%idomain(3) = 4
+          particle%itrdomain(3) = 4
           particle%iboundary(3) = 3
           inface = 0 ! want Domain(2) unchanged; Boundary(2) = 0
         case (4)
@@ -251,7 +251,7 @@ subroutine load_subcell(this, particle, subcell)
       factor = factor / cell%defn%porosity
       npolyverts = cell%defn%npolyverts
 
-      isc = particle%idomain(3)
+      isc = particle%itrdomain(3)
       ! Subcells 1, 2, 3, and 4 are Pollock's subcells A, B, C, and D,
       ! respectively
 
@@ -277,7 +277,7 @@ subroutine load_subcell(this, particle, subcell)
         end if
 
         subcell%isubcell = isc
-        particle%idomain(3) = isc
+        particle%itrdomain(3) = isc
       end if
       dx = 5d-1 * dx
       dy = 5d-1 * dy

src/Solution/ParticleTracker/Method/MethodCellTernary.f90

@@ -109,7 +109,7 @@ subroutine pass_mct(this, particle)
     integer(I4B) :: inface
 
     exitFace = particle%iboundary(3)
-    isc = particle%idomain(3)
+    isc = particle%itrdomain(3)
 
     select case (exitFace)
     case (0)
@@ -123,14 +123,14 @@ subroutine pass_mct(this, particle)
       ! Subcell face --> next subcell in "cycle" (cell interior)
       isc = isc + 1
       if (isc .gt. this%nverts) isc = 1
-      particle%idomain(3) = isc
+      particle%itrdomain(3) = isc
       particle%iboundary(3) = 3
       inface = 0
     case (3)
       ! Subcell face --> preceding subcell in "cycle" (cell interior)
       isc = isc - 1
       if (isc .lt. 1) isc = this%nverts
-      particle%idomain(3) = isc
+      particle%itrdomain(3) = isc
       particle%iboundary(3) = 2
       inface = 0
     case (4)
@@ -280,7 +280,7 @@ subroutine load_subcell(this, particle, subcell)
     type is (CellPolyType)
       ic = cell%defn%icell
       subcell%icell = ic
-      isc = particle%idomain(3)
+      isc = particle%itrdomain(3)
       if (isc .le. 0) then
         xi = particle%x
         yi = particle%y
@@ -315,7 +315,7 @@ subroutine load_subcell(this, particle, subcell)
 
           call pstop(1)
         else
-          particle%idomain(3) = isc
+          particle%itrdomain(3) = isc
         end if
       end if
       subcell%isubcell = isc

src/Solution/ParticleTracker/Method/MethodDis.f90

@@ -145,7 +145,7 @@ subroutine load_dis(this, particle, next_level, submethod)
 
     select type (cell => this%cell)
     type is (CellRectType)
-      ic = particle%idomain(next_level)
+      ic = particle%itrdomain(next_level)
       call this%load_celldefn(ic, cell%defn)
       call this%load_cell(ic, cell)
       if (this%fmi%ibdgwfsat0(ic) == 0) then
@@ -211,18 +211,18 @@ subroutine load_particle(this, cell, particle)
       ! as can occur e.g. in wells. terminate
       ! in the previous cell.
       if (ic == particle%icp .and. inface == 7 .and. ilay < particle%ilay) then
-        particle%idomain(2) = particle%icp
+        particle%itrdomain(2) = particle%icp
         particle%izone = particle%izp
         call this%terminate(particle, &
                             status=TERM_BOUNDARY)
         return
       else
-        particle%icp = particle%idomain(2)
+        particle%icp = particle%itrdomain(2)
         particle%izp = particle%izone
       end if
 
       ! update node numbers and layer
-      particle%idomain(2) = ic
+      particle%itrdomain(2) = ic
       particle%icu = icu
       particle%ilay = ilay
 

src/Solution/ParticleTracker/Method/MethodDisv.f90

@@ -86,7 +86,7 @@ subroutine load_disv(this, particle, next_level, submethod)
 
     select type (cell => this%cell)
     type is (CellPolyType)
-      ic = particle%idomain(next_level)
+      ic = particle%itrdomain(next_level)
       call this%load_cell_defn(ic, cell%defn)
       if (this%fmi%ibdgwfsat0(ic) == 0) then
         ! Cell is active but dry, so select and initialize pass-to-bottom
@@ -175,25 +175,25 @@ subroutine load_particle(this, cell, particle)
       ! as can occur e.g. in wells. terminate
       ! in the previous cell.
       if (ic == particle%icp .and. inface == 7 .and. ilay < particle%ilay) then
-        particle%idomain(2) = particle%icp
+        particle%itrdomain(2) = particle%icp
         particle%izone = particle%izp
         call this%terminate(particle, &
                             status=TERM_BOUNDARY)
         return
       else
-        particle%icp = particle%idomain(2)
+        particle%icp = particle%itrdomain(2)
         particle%izp = particle%izone
       end if
 
-      particle%idomain(2) = ic
+      particle%itrdomain(2) = ic
       particle%icu = icu
       particle%ilay = ilay
 
       z = particle%z
       call this%map_neighbor(cell%defn, inface, z)
 
       particle%iboundary(2) = inface
-      particle%idomain(3:) = 0
+      particle%itrdomain(3:) = 0
       particle%iboundary(3:) = 0
       particle%z = z
     end select

src/Solution/ParticleTracker/Method/MethodSubcell.f90

@@ -35,7 +35,7 @@ subroutine subcellexit(this, particle)
     allocate (SubCellExitEventType :: event)
     select type (event)
     type is (SubCellExitEventType)
-      event%isc = particle%idomain(3)
+      event%isc = particle%itrdomain(3)
       event%exit_face = particle%iboundary(3)
     end select
     call this%events%dispatch(particle, event)

src/Solution/ParticleTracker/Particle/Particle.f90

@@ -70,8 +70,8 @@ module ParticleModule
     integer(I4B), public :: istopzone !< stop zone number
     integer(I4B), public :: idrymeth !< dry tracking method
     ! state
-    integer(I4B), allocatable, public :: idomain(:) !< tracking domain hierarchy ! TODO: rename to itdomain? idomain
-    integer(I4B), allocatable, public :: iboundary(:) !< tracking domain boundaries
+    integer(I4B), public :: itrdomain(MAX_LEVEL) !< tracking domain indices
+    integer(I4B), public :: iboundary(MAX_LEVEL) !< tracking domain boundary indices
     integer(I4B), public :: icp !< previous cell number (reduced)
     integer(I4B), public :: icu !< user cell number
     integer(I4B), public :: ilay !< grid layer
@@ -117,7 +117,7 @@ module ParticleModule
     integer(I4B), dimension(:), pointer, public, contiguous :: istopzone !< stop zone number
     integer(I4B), dimension(:), pointer, public, contiguous :: idrymeth !< stop in dry cells
     ! state
-    integer(I4B), dimension(:, :), pointer, public, contiguous :: idomain !< array of indices for domains in the tracking domain hierarchy
+    integer(I4B), dimension(:, :), pointer, public, contiguous :: itrdomain !< array of indices for domains in the tracking domain hierarchy
     integer(I4B), dimension(:, :), pointer, public, contiguous :: iboundary !< array of indices for tracking domain boundaries
     integer(I4B), dimension(:), pointer, public, contiguous :: icu !< cell number (user)
     integer(I4B), dimension(:), pointer, public, contiguous :: ilay !< layer
@@ -150,8 +150,6 @@ subroutine create_particle(particle)
     type(ParticleType), pointer :: particle !< particle
     allocate (particle)
     allocate (particle%history)
-    allocate (particle%idomain(MAX_LEVEL))
-    allocate (particle%iboundary(MAX_LEVEL))
   end subroutine create_particle
 
   !> @brief Allocate particle store
@@ -184,7 +182,7 @@ subroutine create_particle_store(store, np, mempath)
     call mem_allocate(store%extol, np, 'PLEXTOL', mempath)
     call mem_allocate(store%extend, np, 'PLIEXTEND', mempath)
     call mem_allocate(store%icycwin, np, 'PLICYCWIN', mempath)
-    call mem_allocate(store%idomain, np, MAX_LEVEL, 'PLIDOMAIN', mempath)
+    call mem_allocate(store%itrdomain, np, MAX_LEVEL, 'PLIDOMAIN', mempath)
     call mem_allocate(store%iboundary, np, MAX_LEVEL, 'PLIBOUNDARY', mempath)
   end subroutine create_particle_store
 
@@ -216,16 +214,14 @@ subroutine destroy(this, mempath)
     call mem_deallocate(this%extol, 'PLEXTOL', mempath)
     call mem_deallocate(this%extend, 'PLIEXTEND', mempath)
     call mem_deallocate(this%icycwin, 'PLICYCWIN', mempath)
-    call mem_deallocate(this%idomain, 'PLIDOMAIN', mempath)
+    call mem_deallocate(this%itrdomain, 'PLIDOMAIN', mempath)
     call mem_deallocate(this%iboundary, 'PLIBOUNDARY', mempath)
   end subroutine destroy
 
   !> @brief Destroy a particle after use.
   subroutine destroy_particle(particle)
     class(ParticleType), intent(inout) :: particle !< particle
     deallocate (particle%history)
-    deallocate (particle%idomain)
-    deallocate (particle%iboundary)
   end subroutine destroy_particle
 
   !> @brief Reallocate particle storage to the given size.
@@ -259,7 +255,7 @@ subroutine resize(this, np, mempath)
     call mem_reallocate(this%extol, np, 'PLEXTOL', mempath)
     call mem_reallocate(this%extend, np, 'PLIEXTEND', mempath)
     call mem_reallocate(this%icycwin, np, 'PLICYCWIN', mempath)
-    call mem_reallocate(this%idomain, np, MAX_LEVEL, 'PLIDOMAIN', mempath)
+    call mem_reallocate(this%itrdomain, np, MAX_LEVEL, 'PLIDOMAIN', mempath)
     call mem_reallocate(this%iboundary, np, MAX_LEVEL, 'PLIBOUNDARY', mempath)
   end subroutine resize
 
@@ -298,9 +294,9 @@ subroutine get(this, particle, imdl, iprp, ip)
     particle%tstop = this%tstop(ip)
     particle%ttrack = this%ttrack(ip)
     particle%advancing = .true.
-    particle%idomain(1:MAX_LEVEL) = &
-      this%idomain(ip, 1:MAX_LEVEL)
-    particle%idomain(1) = imdl
+    particle%itrdomain(1:MAX_LEVEL) = &
+      this%itrdomain(ip, 1:MAX_LEVEL)
+    particle%itrdomain(1) = imdl
     particle%iboundary(1:MAX_LEVEL) = &
       this%iboundary(ip, 1:MAX_LEVEL)
     particle%ifrctrn = this%ifrctrn(ip)
@@ -334,10 +330,10 @@ subroutine put(this, particle, ip)
     this%trelease(ip) = particle%trelease
     this%tstop(ip) = particle%tstop
     this%ttrack(ip) = particle%ttrack
-    this%idomain( &
+    this%itrdomain( &
       ip, &
       1:MAX_LEVEL) = &
-      particle%idomain(1:MAX_LEVEL)
+      particle%itrdomain(1:MAX_LEVEL)
     this%iboundary( &
       ip, &
       1:MAX_LEVEL) = &