MODFLOW 6  version 6.7.0.dev2
USGS Modular Hydrologic Model
particleeventmodule Module Reference

Data Types

type  particleeventtype
 Base type for particle events. More...
 
interface  get_int
 
interface  get_str
 

Enumerations

enum  
 Particle event enumeration. More...
 

Functions/Subroutines

subroutine log (this, iun)
 

Variables

@, public release = 0
 particle was released More...
 
@, public featexit = 1
 particle exited a grid feature More...
 
@, public timestep = 2
 time step ended More...
 
@, public terminate = 3
 particle terminated More...
 
@, public weaksink = 4
 particle entered a weak sink More...
 
@, public usertime = 5
 user-specified tracking time More...
 

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
private

A number of events may occur to particles, each of which may (or may not) be of interest to the user. The user selects events to report.

Definition at line 22 of file ParticleEvent.f90.

Function/Subroutine Documentation

◆ log()

subroutine particleeventmodule::log ( class(particleeventtype), intent(inout)  this,
integer(i4b), intent(in)  iun 
)
private

Definition at line 67 of file ParticleEvent.f90.

68  class(ParticleEventType), intent(inout) :: this
69  integer(I4B), intent(in) :: iun
70  if (iun >= 0) write (iun, '(*(G0))') this%get_text()

Variable Documentation

◆ featexit

@, public particleeventmodule::featexit = 1

Definition at line 24 of file ParticleEvent.f90.

24  enumerator :: FEATEXIT = 1 !< particle exited a grid feature

◆ release

@, public particleeventmodule::release = 0

Definition at line 23 of file ParticleEvent.f90.

23  enumerator :: RELEASE = 0 !< particle was released

◆ terminate

@, public particleeventmodule::terminate = 3

Definition at line 26 of file ParticleEvent.f90.

26  enumerator :: TERMINATE = 3 !< particle terminated

◆ timestep

@, public particleeventmodule::timestep = 2

Definition at line 25 of file ParticleEvent.f90.

25  enumerator :: TIMESTEP = 2 !< time step ended

◆ usertime

@, public particleeventmodule::usertime = 5

Definition at line 28 of file ParticleEvent.f90.

28  enumerator :: USERTIME = 5 !< user-specified tracking time

◆ weaksink

@, public particleeventmodule::weaksink = 4

Definition at line 27 of file ParticleEvent.f90.

27  enumerator :: WEAKSINK = 4 !< particle entered a weak sink