Data Types
type	trackfiletype
	Output file containing all or some particle pathlines. More...

type	trackfilecontroltype
	Manages particle track (i.e. pathline) files. More...

Functions/Subroutines
subroutine	init_track_file (this, iun, csv, iprp)
	Initialize a new track file. More...

subroutine	expand (this, increment)
	Expand the trackfile array, internal use only. More...

subroutine, private	save_record (iun, particle, kper, kstp, reason, csv)
	Save record to binary or CSV file, internal use only. More...

subroutine	save (this, particle, kper, kstp, reason, level)
	Save the particle's state to track output file(s). More...

subroutine	set_track_events (this, release, cellexit, timestep, terminate, weaksink, usertime)
	Configure particle events to track. More...

Variables
character(len= *), parameter, public	trackheader = 'kper,kstp,imdl,iprp,irpt,ilay,icell,izone,istatus,ireason,trelease,t,x,y,z,name'

character(len= *), parameter, public	trackdtypes = '<i4,<i4,<i4,<i4,<i4,<i4,<i4,<i4,<i4,<i4,<f8,<f8,<f8,<f8,<f8,\|S40'

Function/Subroutine Documentation

◆ expand()

subroutine trackmodule::expand	(	class(trackfilecontroltype)	this,
		integer(i4b), intent(in), optional	increment
	)

Definition at line 151 of file TrackData.f90.

     ! -- dummy
     class(TrackFileControlType) :: this
     integer(I4B), optional, intent(in) :: increment
     ! -- local
     integer(I4B) :: inclocal
     integer(I4B) :: isize
     integer(I4B) :: newsize
     type(TrackFileType), allocatable, dimension(:) :: temp
  
     ! -- initialize
     if (present(increment)) then
       inclocal = increment
     else
       inclocal = 1
     end if
  
     ! -- increase size of array
     if (allocated(this%trackfiles)) then
       isize = size(this%trackfiles)
       newsize = isize + inclocal
       allocate (temp(newsize))
       temp(1:isize) = this%trackfiles
       deallocate (this%trackfiles)
       call move_alloc(temp, this%trackfiles)
     else
       allocate (this%trackfiles(inclocal))
     end if
  

◆ init_track_file()

subroutine trackmodule::init_track_file	(	class(trackfilecontroltype)	this,
		integer(i4b), intent(in)	iun,
		logical(lgp), intent(in), optional	csv,
		integer(i4b), intent(in), optional	iprp
	)

Definition at line 122 of file TrackData.f90.

     ! -- dummy
     class(TrackFileControlType) :: this
     integer(I4B), intent(in) :: iun
     logical(LGP), intent(in), optional :: csv
     integer(I4B), intent(in), optional :: iprp
     ! -- local
     type(TrackFileType), pointer :: file
  
     ! -- allocate or expand array
     if (.not. allocated(this%trackfiles)) then
       allocate (this%trackfiles(1))
     else
       call this%expand(increment=1)
     end if
  
     ! -- setup new file
     allocate (file)
     file%iun = iun
     if (present(csv)) file%csv = csv
     if (present(iprp)) file%iprp = iprp
  
     ! -- update array and counter
     this%ntrackfiles = size(this%trackfiles)
     this%trackfiles(this%ntrackfiles) = file
  

◆ save()

subroutine trackmodule::save	(	class(trackfilecontroltype), intent(inout)	this,
		type(particletype), intent(in), pointer	particle,
		integer(i4b), intent(in)	kper,
		integer(i4b), intent(in)	kstp,
		integer(i4b), intent(in)	reason,
		integer(i4b), intent(in), optional	level
	)

A record is saved to all enabled model-level files and to any PRP-level files with PRP index matching the particle's PRP index.

Definition at line 253 of file TrackData.f90.

     ! -- dummy
     class(TrackFileControlType), intent(inout) :: this
     type(ParticleType), pointer, intent(in) :: particle
     integer(I4B), intent(in) :: kper
     integer(I4B), intent(in) :: kstp
     integer(I4B), intent(in) :: reason
     integer(I4B), intent(in), optional :: level
     ! -- local
     integer(I4B) :: i
     type(TrackFileType) :: file
  
     ! -- Only save if reporting is enabled for specified event.
     if (.not. ((this%trackrelease .and. reason == 0) .or. &
                (this%trackexit .and. reason == 1) .or. &
                (this%tracktimestep .and. reason == 2) .or. &
                (this%trackterminate .and. reason == 3) .or. &
                (this%trackweaksink .and. reason == 4) .or. &
                (this%trackusertime .and. reason == 5))) &
       return
  
     ! -- For now, only allow reporting from outside the tracking
     !    algorithm (e.g. release time), in which case level will
     !    not be provided, or if within the tracking solution, in
     !    subcells (level 3) only. This may change if the subcell
     !    ever delegates tracking to even smaller subcomponents.
     if (present(level)) then
       if (level .ne. 3) return
     end if
  
     ! -- Save to any enabled model-scoped or PRP-scoped files
     do i = 1, this%ntrackfiles
       file = this%trackfiles(i)
       if (file%iun > 0 .and. &
           (file%iprp == -1 .or. &
            file%iprp == particle%iprp)) &
         call save_record(file%iun, particle, &
                          kper, kstp, reason, csv=file%csv)
     end do
  

Here is the call graph for this function:

◆ save_record()

subroutine, private trackmodule::save_record	(	integer(i4b), intent(in)	iun,
		type(particletype), intent(in), pointer	particle,
		integer(i4b), intent(in)	kper,
		integer(i4b), intent(in)	kstp,
		integer(i4b), intent(in)	reason,
		logical(lgp), intent(in)	csv
	)

private

Definition at line 183 of file TrackData.f90.

     ! -- dummy
     integer(I4B), intent(in) :: iun
     type(ParticleType), pointer, intent(in) :: particle
     integer(I4B), intent(in) :: kper
     integer(I4B), intent(in) :: kstp
     integer(I4B), intent(in) :: reason
     logical(LGP), intent(in) :: csv
     ! -- local
     real(DP) :: x
     real(DP) :: y
     real(DP) :: z
     integer(I4B) :: status
  
     ! -- Get model (global) coordinates
     call particle%get_model_coords(x, y, z)
  
     ! -- Get status
     if (particle%istatus .lt. 0) then
       status = 1
     else
       status = particle%istatus
     end if
  
     if (csv) then
       write (iun, '(*(G0,:,","))') &
         kper, &
         kstp, &
         particle%imdl, &
         particle%iprp, &
         particle%irpt, &
         particle%ilay, &
         particle%icu, &
         particle%izone, &
         status, &
         reason, &
         particle%trelease, &
         particle%ttrack, &
         x, &
         y, &
         z, &
         trim(adjustl(particle%name))
     else
       write (iun) &
         kper, &
         kstp, &
         particle%imdl, &
         particle%iprp, &
         particle%irpt, &
         particle%ilay, &
         particle%icu, &
         particle%izone, &
         status, &
         reason, &
         particle%trelease, &
         particle%ttrack, &
         x, &
         y, &
         z, &
         particle%name
     end if
  

Here is the caller graph for this function:

◆ set_track_events()

subroutine trackmodule::set_track_events	(	class(trackfilecontroltype)	this,
		logical(lgp), intent(in)	release,
		logical(lgp), intent(in)	cellexit,
		logical(lgp), intent(in)	timestep,
		logical(lgp), intent(in)	terminate,
		logical(lgp), intent(in)	weaksink,
		logical(lgp), intent(in)	usertime
	)

Each tracking event corresponds to an "ireason" code as appears in each row of track output.

Definition at line 300 of file TrackData.f90.

     class(TrackFileControlType) :: this
     logical(LGP), intent(in) :: release
     logical(LGP), intent(in) :: cellexit
     logical(LGP), intent(in) :: timestep
     logical(LGP), intent(in) :: terminate
     logical(LGP), intent(in) :: weaksink
     logical(LGP), intent(in) :: usertime
     this%trackrelease = release
     this%trackexit = cellexit
     this%tracktimestep = timestep
     this%trackterminate = terminate
     this%trackweaksink = weaksink
     this%trackusertime = usertime

Variable Documentation

◆ trackdtypes

character(len=*), parameter, public trackmodule::trackdtypes = '<i4,<i4,<i4,<i4,<i4,<i4,<i4,<i4,<i4,<i4,<f8,<f8,<f8,<f8,<f8,|S40'

Definition at line 61 of file TrackData.f90.

   character(len=*), parameter, public :: TRACKDTYPES = &
     '<i4,<i4,<i4,<i4,<i4,<i4,<i4,<i4,&
     &<i4,<i4,<f8,<f8,<f8,<f8,<f8,|S40'

◆ trackheader

character(len=*), parameter, public trackmodule::trackheader = 'kper,kstp,imdl,iprp,irpt,ilay,icell,izone,istatus,ireason,trelease,t,x,y,z,name'

Definition at line 56 of file TrackData.f90.

   character(len=*), parameter, public :: TRACKHEADER = &
     'kper,kstp,imdl,iprp,irpt,ilay,icell,izone,&
     &istatus,ireason,trelease,t,x,y,z,name'

Data Types

Functions/Subroutines

Variables