MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
particleeventsmodule::particleeventdispatchertype Type Reference

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...

Collaboration diagram for particleeventsmodule::particleeventdispatchertype:
Collaboration graph

Public Member Functions

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

Public Attributes

type(listtype) subscriptions

Detailed Description

Definition at line 23 of file ParticleEvents.f90.

Member Function/Subroutine Documentation

◆ broadcast()

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

Definition at line 28 of file ParticleEvents.f90.

◆ destroy()

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

Definition at line 30 of file ParticleEvents.f90.

◆ dispatch()

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

Definition at line 27 of file ParticleEvents.f90.

◆ prep_event()

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

Definition at line 29 of file ParticleEvents.f90.

◆ subscribe()

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

Definition at line 26 of file ParticleEvents.f90.

Member Data Documentation

◆ subscriptions

type(listtype) particleeventsmodule::particleeventdispatchertype::subscriptions

Definition at line 24 of file ParticleEvents.f90.

24 type(ListType) :: subscriptions

The documentation for this type was generated from the following file:
  • /home/runner/work/modflow6/modflow6/src/Solution/ParticleTracker/Particle/Events/ParticleEvents.f90