particleeventsmodule Module Reference

Data Types
type	particleeventconsumertype
type	particleeventdispatchertype
interface	handle_event

Functions/Subroutines
subroutine	subscribe (this, consumer)
	Subscribe a consumer to the dispatcher. More...
subroutine	unsubscribe (this)
	Unsubscribe the consumer from the dispatcher. More...
subroutine	dispatch (this, particle, event)
	Dispatch an event. Internal use only. More...
subroutine	destroy (this)
	Destroy the dispatcher. More...
subroutine	release (this, particle)
	Particle is released. More...
subroutine	cellexit (this, particle)
	Particle exits a cell. More...
subroutine	terminate (this, particle, status)
	Particle terminates. More...
subroutine	timestep (this, particle)
	Time step ends. More...
subroutine	weaksink (this, particle)
	Particle leaves a weak sink. More...
subroutine	usertime (this, particle)
	User-defined tracking time occurs. More...

Function/Subroutine Documentation

cellexit()

subroutine particleeventsmodule::cellexit ( class(particleeventdispatchertype), intent(inout)  this, type(particletype), intent(inout), pointer  particle  )

private

Definition at line 115 of file ParticleEvents.f90.

    class(ParticleEventDispatcherType), intent(inout) :: this
    type(ParticleType), pointer, intent(inout) :: particle
    class(ParticleEventType), pointer :: event
 
    allocate (cellexiteventtype :: event)
    call this%dispatch(particle, event)

destroy()

subroutine particleeventsmodule::destroy

(

class(particleeventdispatchertype), intent(inout)

this

)

Definition at line 98 of file ParticleEvents.f90.

    class(ParticleEventDispatcherType), intent(inout) :: this
    if (associated(this%consumer)) &
      deallocate (this%consumer)

dispatch()

subroutine particleeventsmodule::dispatch ( class(particleeventdispatchertype), intent(inout)  this, type(particletype), intent(inout), pointer  particle, class(particleeventtype), intent(inout), pointer  event  )

private

Definition at line 63 of file ParticleEvents.f90.

    use tdismodule, only: kper, kstp, totimc
    ! dummy
    class(ParticleEventDispatcherType), intent(inout) :: this
    type(ParticleType), pointer, intent(inout) :: particle
    class(ParticleEventType), pointer, intent(inout) :: event
    ! 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
 
    event%particle => particle
    event%time = particle%ttrack
    event%kper = per
    event%kstp = stp
    call this%consumer%handle_event(particle, event)
    deallocate (event)

release()

subroutine particleeventsmodule::release ( class(particleeventdispatchertype), intent(inout)  this, type(particletype), intent(inout), pointer  particle  )

private

Definition at line 105 of file ParticleEvents.f90.

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

subscribe()

subroutine particleeventsmodule::subscribe ( class(particleeventdispatchertype), intent(inout)  this, class(particleeventconsumertype), intent(inout), target  consumer  )

private

Definition at line 47 of file ParticleEvents.f90.

    class(ParticleEventDispatcherType), intent(inout) :: this
    class(ParticleEventConsumerType), target, intent(inout) :: consumer
    this%consumer => consumer

terminate()

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

private

Definition at line 125 of file ParticleEvents.f90.

    class(ParticleEventDispatcherType), 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%dispatch(particle, event)

timestep()

subroutine particleeventsmodule::timestep ( class(particleeventdispatchertype), intent(inout)  this, type(particletype), intent(inout), pointer  particle  )

private

Definition at line 138 of file ParticleEvents.f90.

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

unsubscribe()

subroutine particleeventsmodule::unsubscribe ( class(particleeventdispatchertype), intent(inout)  this )

private

Definition at line 54 of file ParticleEvents.f90.

    class(ParticleEventDispatcherType), intent(inout) :: this
    if (associated(this%consumer)) then
      deallocate (this%consumer)
      this%consumer => null()
    end if

usertime()

subroutine particleeventsmodule::usertime ( class(particleeventdispatchertype), intent(inout)  this, type(particletype), intent(inout), pointer  particle  )

private

Definition at line 158 of file ParticleEvents.f90.

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

weaksink()

subroutine particleeventsmodule::weaksink ( class(particleeventdispatchertype), intent(inout)  this, type(particletype), intent(inout), pointer  particle  )

private

Definition at line 148 of file ParticleEvents.f90.

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