methodmodule Module Reference

Particle tracking strategies.

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

Functions/Subroutines
subroutine	init (this, fmi, cell, subcell, trackctl, tracktimes, izone, flowja, porosity, retfactor)
recursive subroutine	track (this, particle, level, tmax)
	Track the particle over domains of the given. 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 the subdomain tracking method (submethod). More...
subroutine	pass (this, particle)
	Pass the particle to the next subdomain. More...
subroutine	save (this, particle, reason)
	Save the particle's state to output files. More...

Function/Subroutine Documentation

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(trackcontroltype), intent(in), optional, pointer  trackctl, 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 74 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(TrackControlType), intent(in), pointer, optional :: trackctl
    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(trackctl)) this%trackctl => trackctl
    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 142 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 151 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 158 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
 
    call this%trackctl%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 100 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
 
    ! Advance the particle over subdomains
    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 122 of file Method.f90.

    class(MethodType), intent(inout) :: this
    type(ParticleType), pointer, intent(inout) :: particle
    integer(I4B) :: nextlevel
    logical(LGP) :: advancing
 
    ! if the particle is done advancing, reset the domain boundary flag.
    if (.not. particle%advancing) then
      particle%iboundary = 0
      advancing = .false.
    else
      ! otherwise pass the particle to the next subdomain.
      ! if that leaves it on a boundary, stop advancing.
      call this%pass(particle)
      if (particle%iboundary(nextlevel - 1) .ne. 0) &
        advancing = .false.
    end if