docstrings, more cleanup

MODFLOW-USGS · Dec 8, 2023 · ca9dd99 · ca9dd99
1 parent 7cf4ee2
commit ca9dd99
Show file tree

Hide file tree

Showing 4 changed files with 131 additions and 137 deletions.
diff --git a/src/Model/ModelUtilities/TrackData.f90 b/src/Model/ModelUtilities/TrackData.f90
@@ -16,9 +16,9 @@ module TrackModule
   !! or with an entire model.
   !<
   type :: TrackFileType
-    integer(I4B) :: iun = 0 ! file unit number
-    logical(LGP) :: csv = .false. ! whether the file is binary or CSV
-    integer(I4B) :: iprp = -1 ! -1 is model-level file, 0 is exchange PRP
+    integer(I4B) :: iun = 0 !< file unit number
+    logical(LGP) :: csv = .false. !< whether the file is binary or CSV
+    integer(I4B) :: iprp = -1 !< -1 is model-level file, 0 is exchange PRP
   end type TrackFileType
 
   !> @brief Manages particle track (i.e. pathline) files.
@@ -38,9 +38,9 @@ module TrackModule
   !<
   type :: TrackControlType
     private
-    type(TrackFileType), public, allocatable :: trackfiles(:) ! output files
-    integer(I4B), public :: ntrackfiles ! number of output files
-    integer(I4B), public :: itrackevent ! track event selection
+    type(TrackFileType), public, allocatable :: trackfiles(:) !< output files
+    integer(I4B), public :: ntrackfiles !< number of output files
+    integer(I4B), public :: itrackevent !< track event selection
   contains
     procedure :: expand
     procedure, public :: init_track_file

diff --git a/src/Model/ParticleTracking/prt1prp1.f90 b/src/Model/ParticleTracking/prt1prp1.f90
@@ -62,9 +62,9 @@ module PrtPrpModule
     logical(LGP), pointer :: rls_all => null() !< flag for release on all time steps in period
     logical(LGP), pointer :: rls_any => null() !< flag that indicates whether any release in period
     logical(LGP), pointer :: noperiodblocks => null() !< flag indicating if there are no period blocks in sim
-    integer(I4B), pointer :: itrkout => null()
-    integer(I4B), pointer :: itrkhdr => null()
-    integer(I4B), pointer :: itrkcsv => null()
+    integer(I4B), pointer :: itrkout => null() !< binary track file
+    integer(I4B), pointer :: itrkhdr => null() !< track header file
+    integer(I4B), pointer :: itrkcsv => null() !< CSV track file
   contains
     procedure :: prp_allocate_arrays
     procedure :: prp_allocate_scalars
@@ -84,7 +84,7 @@ module PrtPrpModule
 
 contains
 
-  !> @brief Create a new particle release package
+  !> @brief Create a new particle release point package
   subroutine prp_create(packobj, id, ibcnum, inunit, iout, namemodel, &
                         pakname, mempath, fmi)
     ! -- dummy
@@ -173,7 +173,7 @@ subroutine prp_da(this)
     call mem_deallocate(this%tstop)
     call mem_deallocate(this%rptname, 'RPTNAME', this%memoryPath)
     !
-    ! -- deallocate particle list
+    ! -- deallocate particle store
     call this%particles%deallocate_arrays(this%memoryPath)
     deallocate (this%particles)
     call mem_deallocate(this%massrls)
@@ -207,9 +207,6 @@ subroutine prp_allocate_arrays(this, nodelist, auxvar)
     ! -- local
     integer(I4B) :: nps
     !
-    ! ! -- call standard BndType allocate scalars
-    ! call this%BndType%allocate_arrays()
-    ! !
     ! -- Allocate
     call mem_allocate(this%noder, this%nreleasepts, 'NODER', this%memoryPath)
     call mem_allocate(this%x, this%nreleasepts, 'X', this%memoryPath)
@@ -219,7 +216,7 @@ subroutine prp_allocate_arrays(this, nodelist, auxvar)
     call mem_allocate(this%rptname, LENBOUNDNAME, this%nreleasepts, &
                       'RPTNAME', this%memoryPath)
 
-    ! -- Allocate particle list
+    ! -- Allocate particle store
     allocate (this%particles)
     call this%particles%allocate_arrays(this%npartmax, &
                                         levelMin, levelMax, &
@@ -233,11 +230,11 @@ subroutine prp_allocate_arrays(this, nodelist, auxvar)
       this%massrls(nps) = DZERO
     end do
     !
-    ! -- The following array is allocatable (not a pointer) so it can be resized using
+    ! -- The following array is allocatable (not a pointer) so resize
     if (allocated(this%kstp_list_rls)) deallocate (this%kstp_list_rls)
     allocate (this%kstp_list_rls(0))
     !
-    ! -- The following array is allocatable (not a pointer) so it can be resized using
+    ! -- The following array is allocatable (not a pointer) so resize
     if (allocated(this%frac_list_rls)) deallocate (this%frac_list_rls)
     allocate (this%frac_list_rls(1))