MODFLOW 6  version 6.8.0.dev0
USGS Modular Hydrologic Model
particletracksmodule::particletrackstype Type Reference

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

Collaboration diagram for particletracksmodule::particletrackstype:
Collaboration graph

Public Member Functions

procedure, public init_file
 
procedure, public init_buffer
 
procedure, public is_selected
 
procedure, public select_events
 
procedure, public buffer_event
 
procedure, public flush_buffer
 
procedure, public discard_buffer
 
procedure, public destroy
 
procedure expand_files
 

Public Attributes

integer(i4b), public iout = -1
 log file unit More...
 
integer(i4b), public ntrackfiles
 number of track files More...
 
type(particletrackfiletype), dimension(:), allocatable, public files
 track files More...
 
type(particletrackeventselectiontype), public selected
 event selection More...
 
class(particletrackeventbuffertype), allocatable buffer
 event buffer More...
 

Detailed Description

Definition at line 75 of file ParticleTracks.f90.

Member Function/Subroutine Documentation

◆ buffer_event()

procedure, public particletracksmodule::particletrackstype::buffer_event

Definition at line 87 of file ParticleTracks.f90.

◆ destroy()

procedure, public particletracksmodule::particletrackstype::destroy

Definition at line 90 of file ParticleTracks.f90.

◆ discard_buffer()

procedure, public particletracksmodule::particletrackstype::discard_buffer

Definition at line 89 of file ParticleTracks.f90.

◆ expand_files()

procedure particletracksmodule::particletrackstype::expand_files

Definition at line 91 of file ParticleTracks.f90.

◆ flush_buffer()

procedure, public particletracksmodule::particletrackstype::flush_buffer

Definition at line 88 of file ParticleTracks.f90.

◆ init_buffer()

procedure, public particletracksmodule::particletrackstype::init_buffer

Definition at line 84 of file ParticleTracks.f90.

◆ init_file()

procedure, public particletracksmodule::particletrackstype::init_file

Definition at line 83 of file ParticleTracks.f90.

◆ is_selected()

procedure, public particletracksmodule::particletrackstype::is_selected

Definition at line 85 of file ParticleTracks.f90.

◆ select_events()

procedure, public particletracksmodule::particletrackstype::select_events

Definition at line 86 of file ParticleTracks.f90.

Member Data Documentation

◆ buffer

class(particletrackeventbuffertype), allocatable particletracksmodule::particletrackstype::buffer

Definition at line 81 of file ParticleTracks.f90.

81  class(ParticleTrackEventBufferType), allocatable :: buffer !< event buffer

◆ files

type(particletrackfiletype), dimension(:), allocatable, public particletracksmodule::particletrackstype::files

Definition at line 79 of file ParticleTracks.f90.

79  type(ParticleTrackFileType), public, allocatable :: files(:) !< track files

◆ iout

integer(i4b), public particletracksmodule::particletrackstype::iout = -1

Definition at line 77 of file ParticleTracks.f90.

77  integer(I4B), public :: iout = -1 !< log file unit

◆ ntrackfiles

integer(i4b), public particletracksmodule::particletrackstype::ntrackfiles

Definition at line 78 of file ParticleTracks.f90.

78  integer(I4B), public :: ntrackfiles !< number of track files

◆ selected

type(particletrackeventselectiontype), public particletracksmodule::particletrackstype::selected

Definition at line 80 of file ParticleTracks.f90.

80  type(ParticleTrackEventSelectionType), public :: selected !< event selection

The documentation for this type was generated from the following file: