Particle tracking strategies.

Data Types
type	methodtype
	Base type for particle tracking methods. More...

interface	apply

interface	assess

interface	deallocate

Enumerations
enum
	Tracking method level enumeration. More...

Functions/Subroutines
subroutine	init (this, fmi, cell, subcell, events, tracktimes, izone, flowja, porosity, retfactor)
	Initialize the method with pointers to model data. More...

recursive subroutine	track (this, particle, level, tmax)
	Track the particle over subdomains of the given. More...

subroutine	try_pass (this, particle, nextlevel, advancing)
	Try passing the particle to the next subdomain. More...

integer(i4b) function	get_level (this)
	Get tracking method level. More...

subroutine	load (this, particle, next_level, submethod)
	Load subdomain tracking method (submethod). More...

subroutine	pass (this, particle)
	Pass particle to the next subdomain or to a domain boundary. More...

subroutine	find_exits (this, particle, domain)
	Compute candidate exit solutions. More...

integer(i4b) function	pick_exit (this, particle)
	Choose an exit solution among candidates. More...

subroutine	release (this, particle)
	A particle is released. More...

subroutine	terminate (this, particle, status)
	A particle terminates. More...

subroutine	timestep (this, particle)
	A time step ends. More...

subroutine	weaksink (this, particle)
	A particle leaves a weak sink. More...

subroutine	usertime (this, particle)
	A user-defined tracking time occurs. More...

subroutine	dropped (this, particle)
	A particle drops to the water table. More...

Variables
@, public	level_model = 1

@, public	level_feature = 2

@, public	level_subfeature = 3

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Tracking levels: 1: model, 2: grid feature, 3: grid subfeature. A tracking level identifies the domain through which a tracking method is responsible for moving a particle. Methods operate on a particular level and delegate to submethods for levels higher than (i.e. below the scope of) their own.

Definition at line 39 of file Method.f90.

Function/Subroutine Documentation

◆ dropped()

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

private

Definition at line 288 of file Method.f90.

     class(MethodType), intent(inout) :: this
     type(ParticleType), pointer, intent(inout) :: particle
     class(ParticleEventType), pointer :: event
     allocate (droppedeventtype :: event)
     call this%events%dispatch(particle, event)
     deallocate (event)

◆ find_exits()

subroutine methodmodule::find_exits	(	class(methodtype), intent(inout)	this,
		type(particletype), intent(inout), pointer	particle,
		class(domaintype), intent(in)	domain
	)

private

Definition at line 214 of file Method.f90.

     class(MethodType), intent(inout) :: this
     type(ParticleType), pointer, intent(inout) :: particle
     class(DomainType), intent(in) :: domain
     if (.not. this%delegates) &
       call pstop(1, "find_exits called on non-delegating method")
     call pstop(1, "find_exits must be overridden in delegating methods")

Here is the call graph for this function:

◆ get_level()

integer(i4b) function methodmodule::get_level ( class(methodtype), intent(in) this )

private

Definition at line 190 of file Method.f90.

     class(MethodType), intent(in) :: this
     integer(I4B) :: level
     level = -1 ! suppress compiler warning
     call pstop(1, "get_level must be overridden")

Here is the call 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(particleeventdispatchertype), intent(in), optional, pointer	events,
		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 122 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(ParticleEventDispatcherType), intent(in), pointer, optional :: events
     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(events)) this%events => events
     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 198 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 207 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:

◆ pick_exit()

integer(i4b) function methodmodule::pick_exit	(	class(methodtype), intent(inout)	this,
		type(particletype), intent(inout), pointer	particle
	)

private

Definition at line 224 of file Method.f90.

     class(MethodType), intent(inout) :: this
     type(ParticleType), pointer, intent(inout) :: particle
     integer(I4B) :: exit_soln
     exit_soln = 0 ! suppress compiler warning
     if (.not. this%delegates) &
       call pstop(1, "pick_exit called on non-delegating method")
     call pstop(1, "pick_exit must be overridden in delegating methods")

Here is the call graph for this function:

◆ release()

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

private

Definition at line 235 of file Method.f90.

     class(MethodType), intent(inout) :: this
     type(ParticleType), pointer, intent(inout) :: particle
     class(ParticleEventType), pointer :: event
     allocate (releaseeventtype :: event)
     call this%events%dispatch(particle, event)
     deallocate (event)

◆ terminate()

subroutine methodmodule::terminate	(	class(methodtype), intent(inout)	this,
		type(particletype), intent(inout), pointer	particle,
		integer(i4b), intent(in), optional	status
	)

private

Definition at line 245 of file Method.f90.

     class(MethodType), intent(inout) :: this
     type(ParticleType), pointer, intent(inout) :: particle
     integer(I4B), intent(in), optional :: status
     class(ParticleEventType), pointer :: event
     particle%advancing = .false.
     if (present(status)) particle%istatus = status
     allocate (terminationeventtype :: event)
     call this%events%dispatch(particle, event)
     deallocate (event)

◆ timestep()

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

private

Definition at line 258 of file Method.f90.

     class(MethodType), intent(inout) :: this
     type(ParticleType), pointer, intent(inout) :: particle
     class(ParticleEventType), pointer :: event
     allocate (timestepeventtype :: event)
     call this%events%dispatch(particle, event)
     deallocate (event)

◆ 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 148 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 169 of file Method.f90.

     class(MethodType), intent(inout) :: this
     type(ParticleType), pointer, intent(inout) :: particle
     integer(I4B) :: nextlevel
     logical(LGP) :: advancing
  
     if (particle%advancing) then
       ! if still advancing, pass to the next subdomain.
       ! if that puts us on a boundary, then we're done.
       call this%pass(particle)
       if (particle%iboundary(nextlevel - 1) .ne. 0) &
         advancing = .false.
     else
       ! otherwise we're already done so
       ! reset the domain boundary value.
       advancing = .false.
       particle%iboundary = 0
     end if

◆ usertime()

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

private

Definition at line 278 of file Method.f90.

     class(MethodType), intent(inout) :: this
     type(ParticleType), pointer, intent(inout) :: particle
     class(ParticleEventType), pointer :: event
     allocate (usertimeeventtype :: event)
     call this%events%dispatch(particle, event)
     deallocate (event)

◆ weaksink()

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

private

Definition at line 268 of file Method.f90.

     class(MethodType), intent(inout) :: this
     type(ParticleType), pointer, intent(inout) :: particle
     class(ParticleEventType), pointer :: event
     allocate (weaksinkeventtype :: event)
     call this%events%dispatch(particle, event)
     deallocate (event)

Variable Documentation

◆ level_feature

@, public methodmodule::level_feature = 2

Definition at line 41 of file Method.f90.

41 enumerator :: LEVEL_FEATURE = 2

◆ level_model

@, public methodmodule::level_model = 1

Definition at line 40 of file Method.f90.

40 enumerator :: LEVEL_MODEL = 1

◆ level_subfeature

@, public methodmodule::level_subfeature = 3

Definition at line 42 of file Method.f90.

42 enumerator :: LEVEL_SUBFEATURE = 3

Data Types

Enumerations

Functions/Subroutines

Variables

Enumeration Type Documentation

◆ anonymous enum

Function/Subroutine Documentation

◆ dropped()

◆ find_exits()

◆ get_level()

◆ init()

◆ load()

◆ pass()

◆ pick_exit()

◆ release()

◆ terminate()

◆ timestep()

◆ track()

◆ try_pass()

◆ usertime()

◆ weaksink()

Variable Documentation

◆ level_feature

◆ level_model

◆ level_subfeature