![]() |
MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
|
Particle track output manager. Handles printing as well as writing to files. One output unit can be configured for printing. Multiple files can be configured for writing, with each file optionally associated with a PRP package or with the full model. Events can be filtered by type, so that only certain event types are printed or written to files. Particle events are buffered in memory or in a scratch file, flushed to disk only when the time step is successfully solved for the last time (there may be multiple solves per time step, depending on ATS and Picard options). More...

Public Member Functions | |
| procedure, public | init_file (this, iun, csv, iprp) |
| Initialize a binary or CSV output file. | |
| procedure, public | init_buffer (this, scratch) |
| Initialize the event buffer strategy. | |
| procedure, public | is_selected (this, event) |
| Check if a given event code is selected for tracking. | |
| procedure, public | select_events (this, release, featexit, timestep, terminate, weaksink, usertime, subfexit, dropped) |
| Pick events to track. | |
| procedure, public | buffer_event (this, particle, event) |
| Buffer an event for deferred write. | |
| procedure, public | flush_buffer (this) |
| Flush the event buffer to disk. | |
| procedure, public | discard_buffer (this) |
| Discard buffered events without writing. | |
| procedure, public | destroy (this) |
| Destroy the particle track manager. | |
| procedure | expand_files (this, increment) |
| Grow the array of track files. | |
Public Attributes | |
| integer(i4b), public | iout = -1 |
| log file unit | |
| integer(i4b), public | ntrackfiles = 0 |
| number of track files | |
| type(particletrackfiletype), dimension(:), allocatable, public | files |
| track files | |
| type(particletrackeventselectiontype), public | selected |
| event selection | |
| class(particletrackeventbuffertype), allocatable | buffer |
| event buffer | |
Definition at line 75 of file ParticleTracks.f90.
| procedure, public particletracksmodule::particletrackstype::buffer_event | ( | class(particletrackstype) | this, |
| type(particletype), intent(in), pointer | particle, | ||
| class(particleeventtype), intent(in), pointer | event ) |
Definition at line 87 of file ParticleTracks.f90.
| procedure, public particletracksmodule::particletrackstype::destroy | ( | class(particletrackstype) | this | ) |
Definition at line 90 of file ParticleTracks.f90.
| procedure, public particletracksmodule::particletrackstype::discard_buffer | ( | class(particletrackstype) | this | ) |
Definition at line 89 of file ParticleTracks.f90.
| procedure particletracksmodule::particletrackstype::expand_files | ( | class(particletrackstype) | this, |
| integer(i4b), intent(in), optional | increment ) |
Definition at line 91 of file ParticleTracks.f90.
| procedure, public particletracksmodule::particletrackstype::flush_buffer | ( | class(particletrackstype) | this | ) |
Definition at line 88 of file ParticleTracks.f90.
| procedure, public particletracksmodule::particletrackstype::init_buffer | ( | class(particletrackstype) | this, |
| logical(lgp), intent(in) | scratch ) |
Definition at line 84 of file ParticleTracks.f90.
| procedure, public particletracksmodule::particletrackstype::init_file | ( | class(particletrackstype) | this, |
| integer(i4b), intent(in) | iun, | ||
| logical(lgp), intent(in), optional | csv, | ||
| integer(i4b), intent(in), optional | iprp ) |
Definition at line 83 of file ParticleTracks.f90.
| procedure, public particletracksmodule::particletrackstype::is_selected | ( | class(particletrackstype), intent(inout) | this, |
| class(particleeventtype), intent(in) | event ) |
Definition at line 85 of file ParticleTracks.f90.
| procedure, public particletracksmodule::particletrackstype::select_events | ( | class(particletrackstype) | this, |
| logical(lgp), intent(in) | release, | ||
| logical(lgp), intent(in) | featexit, | ||
| logical(lgp), intent(in) | timestep, | ||
| logical(lgp), intent(in) | terminate, | ||
| logical(lgp), intent(in) | weaksink, | ||
| logical(lgp), intent(in) | usertime, | ||
| logical(lgp), intent(in) | subfexit, | ||
| logical(lgp), intent(in) | dropped ) |
Definition at line 86 of file ParticleTracks.f90.
| class(particletrackeventbuffertype), allocatable particletracksmodule::particletrackstype::buffer |
Definition at line 81 of file ParticleTracks.f90.
| type(particletrackfiletype), dimension(:), allocatable, public particletracksmodule::particletrackstype::files |
Definition at line 79 of file ParticleTracks.f90.
| integer(i4b), public particletracksmodule::particletrackstype::iout = -1 |
Definition at line 77 of file ParticleTracks.f90.
| integer(i4b), public particletracksmodule::particletrackstype::ntrackfiles = 0 |
Definition at line 78 of file ParticleTracks.f90.
| type(particletrackeventselectiontype), public particletracksmodule::particletrackstype::selected |
Definition at line 80 of file ParticleTracks.f90.