![]() |
MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
|
Data Types | |
| type | particletype |
| Particle tracked by the PRT model. More... | |
| type | particlestoretype |
| Structure of arrays to store particles. More... | |
Enumerations | |
| enum | { active = 1 , term_boundary = 2 , term_weaksink = 3 , term_no_exits = 5 , term_stopzone = 6 , term_inactive = 7 , term_unreleased = 8 , term_no_exits_sub = 9 , term_timeout = 10 } |
| Particle status enumeration. More... | |
Functions/Subroutines | |
| subroutine | create_particle (particle) |
| Create a new particle. | |
| subroutine | create_particle_store (store, np, mempath) |
| Allocate particle store. | |
| subroutine | destroy (this, mempath) |
| Destroy particle store after use. | |
| subroutine | destroy_particle (particle) |
| Destroy a particle after use. | |
| subroutine | resize (this, np, mempath) |
| Reallocate particle storage to the given size. | |
| subroutine | get (this, particle, imdl, iprp, ip) |
| Load a particle from the particle store. | |
| subroutine | put (this, particle, ip) |
| Save a particle's state to the particle store. | |
| subroutine | copy_from (this, source) |
| Copy all particle state from source to this store. | |
| subroutine | transform_coords (this, xorigin, yorigin, zorigin, sinrot, cosrot, invert) |
| Transform particle coordinates. | |
| subroutine | reset_transform (this) |
| Reset particle coordinate transformation properties. | |
| subroutine | get_model_coords (this, x, y, z) |
| Return the particle's model coordinates, inverting any applied transformation if needed. The particle's state is not altered. | |
| integer function | num_stored (this) |
| Return the number of particles. | |
| character(len=:) function, allocatable | get_id (this) |
| Get a string identifier for the particle. | |
Variables | |
| integer, parameter | max_level = 4 |
| Tracking "levels" defined in method modules. Currently only 3 used. | |
| anonymous enum |
Particles begin in status 1 (active) at release time. Status may only increase over time. Status values greater than one imply termination. A particle may terminate for several reasons, all mutually exclusive. A particle's final tracking status will always be greater than one.
Status codes 1-3 and 5-8 correspond directly to MODPATH 7 status codes. Code 4 does not apply to PRT because PRT does not distinguish forwards from backwards tracking. Status code 9 provides more specific, subcell- level information about a particle which terminates due to no outflow. Code 10 distinguishes particles which have "timed out" upon reaching a user-specified stop time or the end of the simulation.
Definition at line 31 of file Particle.f90.
|
private |
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 367 of file Particle.f90.

| subroutine particlemodule::create_particle | ( | type(particletype), pointer | particle | ) |
Definition at line 165 of file Particle.f90.

|
private |
| [in] | np | number of particles |
| [in] | mempath | path to memory |
Definition at line 172 of file Particle.f90.

|
private |
| [in,out] | this | store |
| [in] | mempath | path to memory |
Definition at line 205 of file Particle.f90.
|
private |
Definition at line 236 of file Particle.f90.
|
private |
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 283 of file Particle.f90.
|
private |
Definition at line 485 of file Particle.f90.
|
private |
| [in] | this | particle |
| [out] | x | x coordinate |
| [out] | y | y coordinate |
| [out] | z | z coordinate |
Definition at line 460 of file Particle.f90.

|
private |
Definition at line 479 of file Particle.f90.
|
private |
| [in,out] | this | particle storage |
| [in] | ip | particle index |
Definition at line 324 of file Particle.f90.
|
private |
| [in,out] | this | particle |
Definition at line 445 of file Particle.f90.
|
private |
| [in,out] | this | particle store |
| [in] | np | number of particles |
| [in] | mempath | path to memory |
Definition at line 242 of file Particle.f90.
|
private |
Apply a translation and/or rotation to particle coordinates. No rescaling. It's also possible to invert a transformation. Be sure to reset the transformation after using it.
| [in,out] | this | particle |
| [in] | xorigin | x coordinate of origin |
| [in] | yorigin | y coordinate of origin |
| [in] | zorigin | z coordinate of origin |
| [in] | sinrot | sine of rotation angle |
| [in] | cosrot | cosine of rotation angle |
| [in] | invert | whether to invert |
Definition at line 415 of file Particle.f90.

| integer, parameter particlemodule::max_level = 4 |
Definition at line 15 of file Particle.f90.