particletracksmodule Module Reference

Particle track output module. More...

Data Types
type	particletrackfiletype
	Output file containing all or some particle pathlines. More...
type	particletrackeventselectiontype
	Selection of particle events. More...
type	particletrackstype
	Manages particle track output (logging/writing). More...

Functions/Subroutines
subroutine	init_file (this, iun, csv, iprp)
	Initialize a binary or CSV file. More...
subroutine	destroy (this)
subroutine	expand_files (this, increment)
	Grow the array of track files. More...
subroutine	select_events (this, release, featexit, timestep, terminate, weaksink, usertime, subfexit)
	Pick events to track. More...
logical function	is_selected (this, event)
	Check if a given event code is selected for tracking. More...
logical function	should_save (this, particle, file)
	Check whether a particle belongs in a given file i.e. if the file is enabled and its group matches the particle's. More...
subroutine, private	save_event (iun, particle, event, csv)
	Save an event to a binary or CSV file. More...
logical function	should_log (this)
	Log output unit valid? More...
subroutine	handle_event (this, particle, event)
	Handle a particle event. 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'

Detailed Description

Each particle's track consists of events reported as the particle is advected through the model domain. Events are snapshots of particle state, along with optional metadata, at a particular moment in time.

Particles have no ID property. A particle can be uniquely identified by the unique combination of its release attributes (model, package, position, and time). This is possible because only one particle may be released from a given point at a given time.

This module consumes particle events and is responsible for writing them to one or more track files, binary or CSV, and for logging the events if requested. Each track file is associated with either a PRP package or with the full PRT model (there may only be 1 such latter).

Function/Subroutine Documentation

destroy()

subroutine particletracksmodule::destroy

(

class(particletrackstype)

this

)

Definition at line 121 of file ParticleTracks.f90.

    class(ParticleTracksType) :: this
    if (allocated(this%files)) deallocate (this%files)

expand_files()

subroutine particletracksmodule::expand_files	(	class(particletrackstype)	this,
		integer(i4b), intent(in), optional	increment
	)

Definition at line 127 of file ParticleTracks.f90.

    ! dummy
    class(ParticleTracksType) :: this
    integer(I4B), optional, intent(in) :: increment
    ! local
    integer(I4B) :: inclocal
    integer(I4B) :: isize
    integer(I4B) :: newsize
    type(ParticleTrackFileType), allocatable, dimension(:) :: temp
 
    if (present(increment)) then
      inclocal = increment
    else
      inclocal = 1
    end if
 
    if (allocated(this%files)) then
      isize = size(this%files)
      newsize = isize + inclocal
      allocate (temp(newsize))
      temp(1:isize) = this%files
      deallocate (this%files)
      call move_alloc(temp, this%files)
    else
      allocate (this%files(inclocal))
    end if

handle_event()

subroutine particletracksmodule::handle_event	(	class(particletrackstype), intent(inout)	this,
		type(particletype), intent(in), pointer	particle,
		class(particleeventtype), intent(in), pointer	event
	)

Definition at line 272 of file ParticleTracks.f90.

    ! dummy
    class(ParticleTracksType), intent(inout) :: this
    type(ParticleType), pointer, intent(in) :: particle
    class(ParticleEventType), pointer, intent(in) :: event
    ! local
    integer(I4B) :: i
    type(ParticleTrackFileType) :: file
 
    if (this%should_log()) &
      call event%log(this%iout)
 
    if (this%is_selected(event)) then
      do i = 1, this%ntrackfiles
        file = this%files(i)
        if (this%should_save(particle, file)) &
          call save_event(file%iun, particle, event, csv=file%csv)
      end do
    end if

Here is the call graph for this function:

init_file()

subroutine particletracksmodule::init_file	(	class(particletrackstype)	this,
		integer(i4b), intent(in)	iun,
		logical(lgp), intent(in), optional	csv,
		integer(i4b), intent(in), optional	iprp
	)

Definition at line 98 of file ParticleTracks.f90.

    ! dummy
    class(ParticleTracksType) :: this
    integer(I4B), intent(in) :: iun
    logical(LGP), intent(in), optional :: csv
    integer(I4B), intent(in), optional :: iprp
    ! local
    type(ParticleTrackFileType), pointer :: file
 
    if (.not. allocated(this%files)) then
      allocate (this%files(1))
    else
      call this%expand_files(increment=1)
    end if
 
    allocate (file)
    file%iun = iun
    if (present(csv)) file%csv = csv
    if (present(iprp)) file%iprp = iprp
    this%ntrackfiles = size(this%files)
    this%files(this%ntrackfiles) = file

is_selected()

logical function particletracksmodule::is_selected	(	class(particletrackstype), intent(inout)	this,
		class(particleeventtype), intent(in)	event
	)

Definition at line 182 of file ParticleTracks.f90.

    class(ParticleTracksType), intent(inout) :: this
    class(ParticleEventType), intent(in) :: event
 
    select type (event)
    type is (releaseeventtype)
      selected = this%selected%release
    type is (cellexiteventtype)
      selected = this%selected%featexit
    type is (subcellexiteventtype)
      selected = this%selected%subfexit
    type is (timestepeventtype)
      selected = this%selected%timestep
    type is (terminationeventtype)
      selected = this%selected%terminate
    type is (weaksinkeventtype)
      selected = this%selected%weaksink
    type is (usertimeeventtype)
      selected = this%selected%usertime
    class default
      call pstop(1, "unknown event type")
      selected = .false.
    end select
 

Here is the call graph for this function:

save_event()

subroutine, private particletracksmodule::save_event ( integer(i4b), intent(in)  iun, type(particletype), intent(in), pointer  particle, class(particleeventtype), intent(in), pointer  event, logical(lgp), intent(in)  csv  )

private

Definition at line 219 of file ParticleTracks.f90.

    ! dummy
    integer(I4B), intent(in) :: iun
    type(ParticleType), pointer, intent(in) :: particle
    class(ParticleEventType), pointer, intent(in) :: event
    logical(LGP), intent(in) :: csv
 
    if (csv) then
      write (iun, '(*(G0,:,","))') &
        event%kper, &
        event%kstp, &
        event%imdl, &
        event%iprp, &
        event%irpt, &
        event%ilay, &
        event%icu, &
        event%izone, &
        event%istatus, &
        event%get_code(), &
        event%trelease, &
        event%ttrack, &
        event%x, &
        event%y, &
        event%z, &
        trim(adjustl(particle%name))
    else
      write (iun) &
        event%kper, &
        event%kstp, &
        event%imdl, &
        event%iprp, &
        event%irpt, &
        event%ilay, &
        event%icu, &
        event%izone, &
        event%istatus, &
        event%get_code(), &
        event%trelease, &
        event%ttrack, &
        event%x, &
        event%y, &
        event%z, &
        particle%name
    end if

Here is the caller graph for this function:

select_events()

subroutine particletracksmodule::select_events	(	class(particletrackstype)	this,
		logical(lgp), intent(in)	release,
		logical(lgp), intent(in)	featexit,
		logical(lgp), intent(in)	timestep,
		logical(lgp), intent(in)	terminate,
		logical(lgp), intent(in)	weaksink,
		logical(lgp), intent(in)	usertime,
		logical(lgp), intent(in)	subfexit
	)

Definition at line 156 of file ParticleTracks.f90.

    class(ParticleTracksType) :: this
    logical(LGP), intent(in) :: release
    logical(LGP), intent(in) :: featexit
    logical(LGP), intent(in) :: timestep
    logical(LGP), intent(in) :: terminate
    logical(LGP), intent(in) :: weaksink
    logical(LGP), intent(in) :: usertime
    logical(LGP), intent(in) :: subfexit
    this%selected%release = release
    this%selected%featexit = featexit
    this%selected%timestep = timestep
    this%selected%terminate = terminate
    this%selected%weaksink = weaksink
    this%selected%usertime = usertime
    this%selected%subfexit = subfexit

should_log()

logical function particletracksmodule::should_log

(

class(particletrackstype), intent(inout)

this

)

Definition at line 266 of file ParticleTracks.f90.

    class(ParticleTracksType), intent(inout) :: this
    should_log = this%iout >= 0

should_save()

logical function particletracksmodule::should_save	(	class(particletrackstype), intent(inout)	this,
		type(particletype), intent(in), pointer	particle,
		type(particletrackfiletype), intent(in)	file
	)

Definition at line 210 of file ParticleTracks.f90.

    class(ParticleTracksType), intent(inout) :: this
    type(ParticleType), pointer, intent(in) :: particle
    type(ParticleTrackFileType), intent(in) :: file
    save = (file%iun > 0 .and. &
            (file%iprp == -1 .or. file%iprp == particle%iprp))

Variable Documentation

trackdtypes

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

Definition at line 46 of file ParticleTracks.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 particletracksmodule::trackheader = 'kper,kstp,imdl,iprp,irpt,ilay,icell,izone,istatus,ireason,trelease,t,x,y,z,name'

Definition at line 42 of file ParticleTracks.f90.

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