![]() |
MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
|
Structure of arrays to store particles. More...

Public Member Functions | |
| procedure, public | destroy (this, mempath) |
| Destroy particle store after use. | |
| procedure, public | num_stored (this) |
| Return the number of particles. | |
| procedure, public | resize (this, np, mempath) |
| Reallocate particle storage to the given size. | |
| procedure, public | get (this, particle, imdl, iprp, ip) |
| Load a particle from the particle store. | |
| procedure, public | put (this, particle, ip) |
| Save a particle's state to the particle store. | |
| procedure, public | copy_from (this, source) |
| Copy all particle state from source to this store. | |
Public Attributes | |
| character(len=lenboundname), dimension(:), pointer, public, contiguous | name |
| optional particle label | |
| integer(i4b), dimension(:), pointer, public, contiguous | imdl |
| index of model particle originated in | |
| integer(i4b), dimension(:), pointer, public, contiguous | iprp |
| index of release package the particle originated in | |
| integer(i4b), dimension(:), pointer, public, contiguous | irpt |
| index of release point in the particle release package the particle originated in | |
| logical(lgp), dimension(:), pointer, public, contiguous | extend |
| whether to extend tracking beyond the end of the simulation | |
| logical(lgp), dimension(:), pointer, public, contiguous | frctrn |
| force ternary method | |
| integer(i4b), dimension(:), pointer, public, contiguous | istopweaksink |
| weak sink option: 0 = do not stop, 1 = stop | |
| integer(i4b), dimension(:), pointer, public, contiguous | istopzone |
| stop zone number | |
| integer(i4b), dimension(:), pointer, public, contiguous | idrymeth |
| stop in dry cells | |
| integer(i4b), dimension(:), pointer, public, contiguous | iexmeth |
| method for iterative solution of particle exit location and time in generalized Pollock's method | |
| integer(i4b), dimension(:), pointer, public, contiguous | icycwin |
| cycle detection window size | |
| real(dp), dimension(:), pointer, public, contiguous | extol |
| tolerance for iterative solution of particle exit location and time in generalized Pollock's method | |
| integer(i4b), dimension(:, :), pointer, public, contiguous | itrdomain |
| array of indices for domains in the tracking domain hierarchy | |
| integer(i4b), dimension(:, :), pointer, public, contiguous | iboundary |
| array of indices for tracking domain boundaries | |
| integer(i4b), dimension(:), pointer, public, contiguous | icu |
| cell number (user) | |
| integer(i4b), dimension(:), pointer, public, contiguous | ilay |
| layer | |
| integer(i4b), dimension(:), pointer, public, contiguous | izone |
| current zone number | |
| integer(i4b), dimension(:), pointer, public, contiguous | istatus |
| particle status | |
| real(dp), dimension(:), pointer, public, contiguous | x |
| model x coord of particle | |
| real(dp), dimension(:), pointer, public, contiguous | y |
| model y coord of particle | |
| real(dp), dimension(:), pointer, public, contiguous | z |
| model z coord of particle | |
| real(dp), dimension(:), pointer, public, contiguous | trelease |
| particle release time | |
| real(dp), dimension(:), pointer, public, contiguous | tstop |
| particle stop time | |
| real(dp), dimension(:), pointer, public, contiguous | ttrack |
| current tracking time | |
Arrays are registered with the memory manager (PL*) and can be accessed through the API. They are reallocated as particles are added, so API users must re-fetch pointers after each time step.
PRP packages keep two stores. The committed store holds the particle state as of the last finalized time step, and is the one to use through the API. The staging store (memory path suffix -STAGING) holds the state of the current solve attempt. It is internal: it is reset from the committed store at the start of each attempt, and its layout and timing may change.
Definition at line 124 of file Particle.f90.
| procedure, public particlemodule::particlestoretype::copy_from | ( | class(particlestoretype), intent(inout) | this, |
| class(particlestoretype), intent(in) | source ) |
This store must be at least as large as the source. Particles are copied to the first sourcenum_stored() slots. Any slots after that are left as they are.
Definition at line 159 of file Particle.f90.
| procedure, public particlemodule::particlestoretype::destroy | ( | class(particlestoretype), intent(inout) | this, |
| character(*), intent(in) | mempath ) |
| [in,out] | this | store |
| [in] | mempath | path to memory |
Definition at line 154 of file Particle.f90.
| procedure, public particlemodule::particlestoretype::get | ( | class(particlestoretype), intent(inout) | this, |
| class(particletype), intent(inout) | particle, | ||
| integer(i4b), intent(in) | imdl, | ||
| integer(i4b), intent(in) | iprp, | ||
| integer(i4b), intent(in) | ip ) |
This routine is used to initialize a particle for tracking. The advancing flag and coordinate transformation are reset.
| [in,out] | this | particle store |
| [in] | imdl | index of model particle originated in |
| [in] | iprp | index of particle release package particle originated in |
| [in] | ip | index into the particle list |
Definition at line 157 of file Particle.f90.
| procedure, public particlemodule::particlestoretype::num_stored | ( | class(particlestoretype) | this | ) |
Definition at line 155 of file Particle.f90.
| procedure, public particlemodule::particlestoretype::put | ( | class(particlestoretype), intent(inout) | this, |
| class(particletype), intent(in) | particle, | ||
| integer(i4b), intent(in) | ip ) |
| [in,out] | this | particle storage |
| [in] | ip | particle index |
Definition at line 158 of file Particle.f90.
| procedure, public particlemodule::particlestoretype::resize | ( | class(particlestoretype), intent(inout) | this, |
| integer(i4b), intent(in) | np, | ||
| character(*), intent(in) | mempath ) |
| [in,out] | this | particle store |
| [in] | np | number of particles |
| [in] | mempath | path to memory |
Definition at line 156 of file Particle.f90.
| logical(lgp), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::extend |
Definition at line 132 of file Particle.f90.
| real(dp), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::extol |
Definition at line 139 of file Particle.f90.
| logical(lgp), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::frctrn |
Definition at line 133 of file Particle.f90.
| integer(i4b), dimension(:, :), pointer, public, contiguous particlemodule::particlestoretype::iboundary |
Definition at line 142 of file Particle.f90.
| integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::icu |
Definition at line 143 of file Particle.f90.
| integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::icycwin |
Definition at line 138 of file Particle.f90.
| integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::idrymeth |
Definition at line 136 of file Particle.f90.
| integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::iexmeth |
Definition at line 137 of file Particle.f90.
| integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::ilay |
Definition at line 144 of file Particle.f90.
| integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::imdl |
Definition at line 128 of file Particle.f90.
| integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::iprp |
Definition at line 129 of file Particle.f90.
| integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::irpt |
Definition at line 130 of file Particle.f90.
| integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::istatus |
Definition at line 146 of file Particle.f90.
| integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::istopweaksink |
Definition at line 134 of file Particle.f90.
| integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::istopzone |
Definition at line 135 of file Particle.f90.
| integer(i4b), dimension(:, :), pointer, public, contiguous particlemodule::particlestoretype::itrdomain |
Definition at line 141 of file Particle.f90.
| integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::izone |
Definition at line 145 of file Particle.f90.
| character(len=lenboundname), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::name |
Definition at line 127 of file Particle.f90.
| real(dp), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::trelease |
Definition at line 150 of file Particle.f90.
| real(dp), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::tstop |
Definition at line 151 of file Particle.f90.
| real(dp), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::ttrack |
Definition at line 152 of file Particle.f90.
| real(dp), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::x |
Definition at line 147 of file Particle.f90.
| real(dp), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::y |
Definition at line 148 of file Particle.f90.
| real(dp), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::z |
Definition at line 149 of file Particle.f90.