chore(prt): tidy up fmi module (#2482)

argument validation for functions introduced in #2477, misc code/comment format cleanup

Author: wpbonelli

src/Model/ParticleTracking/prt-fmi.f90

@@ -45,21 +45,21 @@ subroutine fmi_cr(fmiobj, name_model, input_mempath, inunit, iout)
     character(len=*), intent(in) :: input_mempath
     integer(I4B), intent(inout) :: inunit
     integer(I4B), intent(in) :: iout
-    !
+
     ! Create the object
     allocate (fmiobj)
-    !
+
     ! create name and memory path
     call fmiobj%set_names(1, name_model, 'FMI', 'FMI', input_mempath)
     fmiobj%text = text
-    !
+
     ! Allocate scalars
     call fmiobj%allocate_scalars()
-    !
+
     ! Set variables
     fmiobj%inunit = inunit
     fmiobj%iout = iout
-    !
+
     ! Assign dependent variable label
     fmiobj%depvartype = 'TRACKS          '
 
@@ -78,41 +78,35 @@ subroutine fmi_ad(this)
      &"(/1X,'WARNING: DRY CELL ENCOUNTERED AT ',a,';  RESET AS INACTIVE')"
     character(len=*), parameter :: fmtrewet = &
      &"(/1X,'DRY CELL REACTIVATED AT ', a)"
-    !
+
     ! Set flag to indicated that flows are being updated.  For the case where
     ! flows may be reused (only when flows are read from a file) then set
     ! the flag to zero to indicated that flows were not updated
     this%iflowsupdated = 1
-    !
+
     ! If reading flows from a budget file, read the next set of records
-    if (this%iubud /= 0) then
-      call this%advance_bfr()
-    end if
-    !
+    if (this%iubud /= 0) call this%advance_bfr()
+
     ! If reading heads from a head file, read the next set of records
-    if (this%iuhds /= 0) then
-      call this%advance_hfr()
-    end if
-    !
+    if (this%iuhds /= 0) call this%advance_hfr()
+
     ! If mover flows are being read from file, read the next set of records
-    if (this%iumvr /= 0) then
+    if (this%iumvr /= 0) &
       call this%mvrbudobj%bfr_advance(this%dis, this%iout)
-    end if
-    !
+
     ! Accumulate flows
     call this%accumulate_flows()
-    !
+
     ! if flow cell is dry, then set this%ibound = 0
     do n = 1, this%dis%nodes
-      !
       ! Calculate the ibound-like array that has 0 if saturation
       ! is zero and 1 otherwise
       if (this%gwfsat(n) > DZERO) then
         this%ibdgwfsat0(n) = 1
       else
         this%ibdgwfsat0(n) = 0
       end if
-      !
+
       ! Check if active model cell is inactive for flow
       if (this%ibound(n) > 0) then
         if (this%gwfhead(n) == DHDRY) then
@@ -122,7 +116,7 @@ subroutine fmi_ad(this)
           write (this%iout, fmtdry) trim(nodestr)
         end if
       end if
-      !
+
       ! Convert dry model cell to active if flow has rewet
       if (this%ibound(n) == 0) then
         if (this%gwfhead(n) /= DHDRY) then
@@ -138,17 +132,12 @@ end subroutine fmi_ad
 
   !> @brief Define the flow model interface
   subroutine prtfmi_df(this, dis, idryinactive)
-    ! modules
-    use SimModule, only: store_error
-    ! dummy
     class(PrtFmiType) :: this
     class(DisBaseType), pointer, intent(in) :: dis
     integer(I4B), intent(in) :: idryinactive
-    !
-    ! Call parent class define
+
     call this%FlowModelInterfaceType%fmi_df(dis, idryinactive)
-    !
-    ! Allocate arrays
+
     this%max_faces = this%dis%get_max_npolyverts() + 2
     allocate (this%StorageFlows(this%dis%nodes))
     allocate (this%SourceFlows(this%dis%nodes))
@@ -160,7 +149,6 @@ end subroutine prtfmi_df
 
   !> @brief Accumulate flows
   subroutine accumulate_flows(this)
-    implicit none
     ! dummy
     class(PrtFmiType) :: this
     ! local
@@ -172,11 +160,9 @@ subroutine accumulate_flows(this)
 
     this%StorageFlows = DZERO
     if (this%igwfstrgss /= 0) &
-      this%StorageFlows = this%StorageFlows + &
-                          this%gwfstrgss
+      this%StorageFlows = this%StorageFlows + this%gwfstrgss
     if (this%igwfstrgsy /= 0) &
-      this%StorageFlows = this%StorageFlows + &
-                          this%gwfstrgsy
+      this%StorageFlows = this%StorageFlows + this%gwfstrgsy
 
     this%SourceFlows = DZERO
     this%SinkFlows = DZERO
@@ -196,8 +182,7 @@ subroutine accumulate_flows(this)
       end if
       do ib = 1, this%gwfpackages(ip)%nbound
         i = this%gwfpackages(ip)%nodelist(ib)
-        if (i <= 0) cycle
-        if (this%ibound(i) <= 0) cycle
+        if (i <= 0 .or. this%ibound(i) <= 0) cycle
         qbnd = this%gwfpackages(ip)%get_flow(ib)
         ! todo, after initial release: default iflowface values for different packages
         iflowface = 0 ! iflowface number
@@ -231,8 +216,16 @@ subroutine mark_boundary_face(this, ic, iface)
     ! local
     integer(I4B) :: bit_pos
 
-    if (ic <= 0 .or. ic > size(this%BoundaryFaces)) return
-    if (iface == 0) return
+    if (ic <= 0 .or. ic > this%dis%nodes) then
+      print *, 'Invalid cell number: ', ic
+      print *, 'Expected a value in range [1, ', this%dis%nodes, ']'
+      call pstop(1)
+    end if
+    if (iface <= 0) then
+      print *, 'Invalid face number: ', iface
+      print *, 'Expected a value in range [1, ', this%max_faces, ']'
+      call pstop(1)
+    end if
     bit_pos = iface - 1 ! bit position 0-based
     if (bit_pos < 0 .or. bit_pos > 31) then
       print *, 'Invalid bitmask position: ', iface
@@ -252,8 +245,16 @@ function is_boundary_face(this, ic, iface) result(is_boundary)
     integer(I4B) :: bit_pos
 
     is_boundary = .false.
-    if (ic <= 0 .or. ic > size(this%BoundaryFaces)) return
-    if (iface == 0) return
+    if (ic <= 0 .or. ic > this%dis%nodes) then
+      print *, 'Invalid cell number: ', ic
+      print *, 'Expected a value in range [1, ', this%dis%nodes, ']'
+      call pstop(1)
+    end if
+    if (iface <= 0) then
+      print *, 'Invalid face number: ', iface
+      print *, 'Expected a value in range [1, ', this%max_faces, ']'
+      call pstop(1)
+    end if
     bit_pos = iface - 1 ! bit position 0-based
     if (bit_pos < 0 .or. bit_pos > 31) then
       print *, 'Invalid bitmask position: ', iface