particleeventsmodule Module Reference

Data Types
type	particleeventsubscriptiontype
	Subscription to particle events: a procedure to handle the event with an unlimited pointer for storing arbitrary context the handling procedure may reference. More...
type	particleeventdispatchertype
	Dispatcher for particle events. Consumers subscribe handlers to the dispatcher. Events may be dispatched, with the first handler to handle the event stopping propagation, or broadcast, with all handlers receiving the event. More...
interface	handle_event
	Event handler interface. Handlers may signal to the dispatching caller whether they have handled the event, but the signal is ignored for broadcasts. More...

Functions/Subroutines
subroutine	subscribe (this, handler, context)
	Add a subscription to the dispatcher. More...
subroutine	prep_event (this, particle, event)
	Prepare an event for dispatching, loading it with the current state of the particle. For internal use only. More...
subroutine	dispatch (this, particle, event)
	Dispatch an event for handling. The first subscriber to handle the event stops propagation. More...
subroutine	broadcast (this, particle, event)
	Broadcast an event to all subscribers so all receive the event and a chance to handle it. More...
subroutine	destroy (this)
	Destroy the dispatcher. More...

Function/Subroutine Documentation

broadcast()

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

private

Definition at line 123 of file ParticleEvents.f90.

    class(ParticleEventDispatcherType), intent(inout) :: this
    type(ParticleType), pointer, intent(inout) :: particle
    class(ParticleEventType), pointer, intent(in) :: event
    ! local
    logical(LGP) :: handled
    integer(I4B) :: i
    class(*), pointer :: p
 
    call this%prep_event(particle, event)
 
    do i = 1, this%subscriptions%Count()
      p => this%subscriptions%GetItem(i)
      select type (subscription => p)
      type is (particleeventsubscriptiontype)
        handled = subscription%handler(subscription%context, particle, event)
      end select
    end do

destroy()

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

private

Definition at line 144 of file ParticleEvents.f90.

    class(ParticleEventDispatcherType), intent(inout) :: this
    call this%subscriptions%Clear(destroy=.true.)

dispatch()

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

Definition at line 97 of file ParticleEvents.f90.

    class(ParticleEventDispatcherType), intent(inout) :: this
    type(ParticleType), pointer, intent(inout) :: particle
    class(ParticleEventType), pointer, intent(in) :: event
    ! local
    logical(LGP) :: handled
    integer(I4B) :: i
    class(*), pointer :: p
 
    call this%prep_event(particle, event)
 
    do i = 1, this%subscriptions%Count()
      p => this%subscriptions%GetItem(i)
      select type (subscription => p)
      type is (particleeventsubscriptiontype)
        handled = subscription%handler( &
                  subscription%context, &
                  particle, &
                  event)
        if (handled) exit
      end select
    end do

prep_event()

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

private

Definition at line 64 of file ParticleEvents.f90.

    use tdismodule, only: kper, kstp
    ! dummy
    class(ParticleEventDispatcherType), intent(inout) :: this
    type(ParticleType), pointer, intent(inout) :: particle
    class(ParticleEventType), pointer, intent(in) :: event
    ! local
    real(DP) :: x, y, z
 
    x = particle%x
    y = particle%y
    z = particle%z
    ! switch to model coordinates if needed
    call particle%get_model_coords(x, y, z)
 
    event%kper = kper
    event%kstp = kstp
    event%imdl = particle%imdl
    event%iprp = particle%iprp
    event%irpt = particle%irpt
    event%ilay = particle%ilay
    event%icu = particle%icu
    event%izone = particle%izone
    event%trelease = particle%trelease
    event%ttrack = particle%ttrack
    event%x = x
    event%y = y
    event%z = z
    event%istatus = particle%istatus

subscribe()

subroutine particleeventsmodule::subscribe ( class(particleeventdispatchertype), intent(inout)  this, procedure(handle_event)  handler, class(*), pointer  context  )

private

Definition at line 47 of file ParticleEvents.f90.

    class(ParticleEventDispatcherType), intent(inout) :: this
    procedure(handle_event) :: handler
    class(*), pointer :: context
    ! local
    type(ParticleEventSubscriptionType), pointer :: subscription
    class(*), pointer :: p
 
    allocate (subscription)
    subscription%handler => handler
    subscription%context => context
    p => subscription
    call this%subscriptions%Add(p)