methodmodule Module Reference

Particle tracking strategies.

Data Types
type	methodtype
	Base type for particle tracking methods. More...
interface	apply
interface	destroy

Functions/Subroutines
subroutine	init (this, fmi, cell, subcell, trackfilectl, tracktimes, izone, flowja, porosity, retfactor)
recursive subroutine	track (this, particle, level, tmax)
	Track particle through subdomains. More...
subroutine	try_pass (this, particle, nextlevel, advancing)
	Try passing the particle to the next subdomain. More...
subroutine	load (this, particle, next_level, submethod)
	Load subdomain tracking method (submethod) More...
subroutine	pass (this, particle)
	Pass a particle to the next subdomain, internal use only. More...
subroutine	save (this, particle, reason)
	Save a particle's current state. More...
subroutine	update (this, particle, cell_defn)
	Update particle state and check termination conditions. More...
integer(i4b) function, public	get_iatop (ncpl, icu)
	Get the index corresponding to top elevation of a cell in the grid. This is -1 if the cell is in the top layer and 1 otherwise. More...

Function/Subroutine Documentation

get_iatop()

integer(i4b) function, public methodmodule::get_iatop	(	integer(i4b), intent(in)	ncpl,
		integer(i4b), intent(in)	icu
	)

Definition at line 230 of file Method.f90.

    integer(I4B), intent(in) :: ncpl, icu
    integer(I4B) :: iatop
 
    if (icu .le. ncpl) then
      iatop = -1
    else
      iatop = 1
    end if

Here is the caller graph for this function:

init()

subroutine methodmodule::init ( class(methodtype), intent(inout)  this, type(prtfmitype), intent(in), optional, pointer  fmi, class(celltype), intent(in), optional, pointer  cell, class(subcelltype), intent(in), optional, pointer  subcell, type(trackfilecontroltype), intent(in), optional, pointer  trackfilectl, type(timeselecttype), intent(in), optional, pointer  tracktimes, integer(i4b), dimension(:), intent(in), optional, pointer  izone, real(dp), dimension(:), intent(in), optional, pointer  flowja, real(dp), dimension(:), intent(in), optional, pointer  porosity, real(dp), dimension(:), intent(in), optional, pointer  retfactor  )

private

Definition at line 73 of file Method.f90.

    class(MethodType), intent(inout) :: this
    type(PrtFmiType), intent(in), pointer, optional :: fmi
    class(CellType), intent(in), pointer, optional :: cell
    class(SubcellType), intent(in), pointer, optional :: subcell
    type(TrackFileControlType), intent(in), pointer, optional :: trackfilectl
    type(TimeSelectType), intent(in), pointer, optional :: tracktimes
    integer(I4B), intent(in), pointer, optional :: izone(:)
    real(DP), intent(in), pointer, optional :: flowja(:)
    real(DP), intent(in), pointer, optional :: porosity(:)
    real(DP), intent(in), pointer, optional :: retfactor(:)
 
    if (present(fmi)) this%fmi => fmi
    if (present(cell)) this%cell => cell
    if (present(subcell)) this%subcell => subcell
    if (present(trackfilectl)) this%trackfilectl => trackfilectl
    if (present(tracktimes)) this%tracktimes => tracktimes
    if (present(izone)) this%izone => izone
    if (present(flowja)) this%flowja => flowja
    if (present(porosity)) this%porosity => porosity
    if (present(retfactor)) this%retfactor => retfactor

load()

subroutine methodmodule::load ( class(methodtype), intent(inout)  this, type(particletype), intent(inout), pointer  particle, integer, intent(in)  next_level, class(methodtype), intent(inout), pointer  submethod  )

private

Definition at line 140 of file Method.f90.

    class(MethodType), intent(inout) :: this
    type(ParticleType), pointer, intent(inout) :: particle
    integer, intent(in) :: next_level
    class(MethodType), pointer, intent(inout) :: submethod
    call pstop(1, "load must be overridden")

Here is the call graph for this function:

pass()

subroutine methodmodule::pass ( class(methodtype), intent(inout)  this, type(particletype), intent(inout), pointer  particle  )

private

Definition at line 149 of file Method.f90.

    class(MethodType), intent(inout) :: this
    type(ParticleType), pointer, intent(inout) :: particle
    call pstop(1, "pass must be overridden")

Here is the call graph for this function:

save()

subroutine methodmodule::save ( class(methodtype), intent(inout)  this, type(particletype), intent(inout), pointer  particle, integer(i4b), intent(in)  reason  )

private

Definition at line 156 of file Method.f90.

    use tdismodule, only: kper, kstp, totimc
    ! dummy
    class(MethodType), intent(inout) :: this
    type(ParticleType), pointer, intent(inout) :: particle
    integer(I4B), intent(in) :: reason
    ! local
    integer(I4B) :: per, stp
 
    per = kper
    stp = kstp
 
    ! If tracking time falls exactly on a boundary between time steps,
    ! report the previous time step for this datum. This is to follow
    ! MP7's behavior, and because the particle will have been tracked
    ! up to this instant under the previous time step's conditions, so
    ! the time step we're about to start shouldn't get "credit" for it.
    if (particle%ttrack == totimc .and. (per > 1 .or. stp > 1)) then
      if (stp > 1) then
        stp = stp - 1
      else if (per > 1) then
        per = per - 1
        stp = 1
      end if
    end if
 
    ! Save the particle's state to any registered tracking output files
    call this%trackfilectl%save(particle, kper=per, &
                                kstp=stp, reason=reason)

track()

recursive subroutine methodmodule::track ( class(methodtype), intent(inout)  this, type(particletype), intent(inout), pointer  particle, integer(i4b)  level, real(dp), intent(in)  tmax  )

private

Definition at line 98 of file Method.f90.

    ! dummy
    class(MethodType), intent(inout) :: this
    type(ParticleType), pointer, intent(inout) :: particle
    integer(I4B) :: level
    real(DP), intent(in) :: tmax
    ! local
    logical(LGP) :: advancing
    integer(I4B) :: nextlevel
    class(methodType), pointer :: submethod
 
    advancing = .true.
    nextlevel = level + 1
    do while (advancing)
      call this%load(particle, nextlevel, submethod)
      call submethod%apply(particle, tmax)
      call this%try_pass(particle, nextlevel, advancing)
    end do

try_pass()

subroutine methodmodule::try_pass ( class(methodtype), intent(inout)  this, type(particletype), intent(inout), pointer  particle, integer(i4b)  nextlevel, logical(lgp)  advancing  )

private

Definition at line 119 of file Method.f90.

    class(MethodType), intent(inout) :: this
    type(ParticleType), pointer, intent(inout) :: particle
    integer(I4B) :: nextlevel
    logical(LGP) :: advancing
 
    ! tracking submethod marked tracking complete?
    ! reset domain boundary flag and don't advance
    if (.not. particle%advancing) then
      particle%iboundary = 0
      advancing = .false.
    else
      ! otherwise pass particle to next subdomain
      ! and if it's on a boundary, stop advancing
      call this%pass(particle)
      if (particle%iboundary(nextlevel - 1) .ne. 0) &
        advancing = .false.
    end if

update()

subroutine methodmodule::update	(	class(methodtype), intent(inout)	this,
		type(particletype), intent(inout), pointer	particle,
		type(celldefntype), intent(inout), pointer	cell_defn
	)

Update the particle's properties (e.g. advancing flag, zone number, status). If any termination conditions apply, the particle's status will be set to the appropriate termination value. If any reporting conditions apply, save particle state with the proper reason code.

Definition at line 194 of file Method.f90.

    ! -- dummy
    class(MethodType), intent(inout) :: this
    type(ParticleType), pointer, intent(inout) :: particle
    type(CellDefnType), pointer, intent(inout) :: cell_defn
 
    particle%izone = cell_defn%izone
    if (cell_defn%izone .ne. 0) then
      if (particle%istopzone .eq. cell_defn%izone) then
        particle%advancing = .false.
        particle%istatus = 6
        call this%save(particle, reason=3) ! reason=3: termination
        return
      end if
    end if
    if (cell_defn%inoexitface .ne. 0) then
      particle%advancing = .false.
      particle%istatus = 5
      call this%save(particle, reason=3) ! reason=3: termination
      return
    end if
    if (cell_defn%iweaksink .ne. 0) then
      if (particle%istopweaksink .ne. 0) then
        particle%advancing = .false.
        particle%istatus = 3
        call this%save(particle, reason=3) ! reason=3: termination
        return
      else
        call this%save(particle, reason=4) ! reason=4: exited weak sink
        return
      end if
    end if