![]() |
MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
|
Data Types | |
| type | prtprptype |
| Particle release point (PRP) package. More... | |
| type | exgprtprptype |
| Exchange PRP package. A variant of the normal PRP package that doesn't read from input files but instead receives particle transfers from coupled models while preserving the pattern where PRP packages own particles. Call it "Particle Registry Package"? More... | |
Functions/Subroutines | |
| subroutine, public | prp_create (packobj, id, ibcnum, inunit, iout, namemodel, pakname, fmi, input_mempath) |
| Create a new particle release point package. | |
| subroutine | prp_da (this) |
| Deallocate memory. | |
| subroutine | prp_set_pointers (this, ibound, izone) |
| Set pointers to model variables. | |
| subroutine | prp_allocate_arrays (this, nodelist, auxvar) |
| Allocate arrays. | |
| subroutine | prp_allocate_scalars (this) |
| Allocate scalars. | |
| subroutine | prp_ar (this) |
| Allocate and read period data. | |
| subroutine | exg_prp_allocate_scalars (this) |
| Allocate scalars for exchange PRP. | |
| subroutine | exg_prp_allocate_arrays (this, nodelist, auxvar) |
| Allocate arrays for exchange PRP. | |
| subroutine | exg_prp_ar (this) |
| No-op AR method override for exchange PRP. | |
| subroutine | prp_ad (this) |
| Advance a time step and release particles if scheduled. | |
| subroutine | prp_commit (this) |
| Commit staged particle state to the "final" store. | |
| subroutine | exg_prp_ad (this) |
| No-op AD method override for exchange PRP. | |
| subroutine | exg_prp_cq_simrate (this, hnew, flowja, imover) |
| No-op flow calculation for exchange PRP. | |
| subroutine | exg_prp_bd (this, model_budget) |
| No-op budget method for exchange PRP. Likewise about the STORAGE term accounting. | |
| subroutine | exg_prp_ot_model_flows (this, icbcfl, ibudfl, icbcun, imap) |
| No-op flow output method for exchange PRP. No contribution to budget, no need to write output. | |
| subroutine | log_release (this) |
| Log the release scheduled for this time step. | |
| subroutine | validate_release_point (this, ic, x, y, z) |
| Verify that the release point is in the cell. | |
| subroutine | release (this, ip, trelease) |
| Release a particle at the specified time. | |
| subroutine | initialize_particle (this, particle, ip, trelease) |
| subroutine | prp_rp (this) |
| Read and prepare period data for particle input. | |
| subroutine | exg_prp_rp (this) |
| No-op RP method override for exchange PRP. | |
| subroutine | prp_cq_simrate (this, hnew, flowja, imover) |
| Calculate flow between package and model. | |
| subroutine | define_listlabel (this) |
| logical function | prp_obs_supported (this) |
| Indicates whether observations are supported. | |
| subroutine | prp_df_obs (this) |
| Store supported observations. | |
| subroutine | prp_options (this) |
| Set options specific to PrtPrpType. | |
| subroutine | exg_prp_options (this) |
| No-op options method override for exchange PRP. Just creates an empty release schedule. | |
| subroutine | prp_log_options (this, found, trackfile, trackcsvfile) |
| Log options specific to PrtPrpType. | |
| subroutine | prp_dimensions (this) |
| Set dimensions specific to PrtPrpType. | |
| subroutine | exg_prp_dimensions (this) |
| Dimensions method override for exchange PRP. Just set all dimensions to zero and allocate arrays. | |
| subroutine | prp_packagedata (this) |
| Load package data (release points). | |
| subroutine | prp_releasetimes (this) |
| Load explicitly specified release times. | |
| subroutine | prp_load_default_release (this) |
| Release once at t=0 if the input configures no releases. | |
| subroutine | prp_check_releases (this) |
| Warn if the input configures releases but none will happen. | |
| subroutine | prp_load_releasetimefrequency (this) |
| Load regularly spaced release times if configured. | |
Variables | |
| character(len=lenftype) | ftype = 'PRP' |
| character(len=16) | text = ' PRP' |
| real(dp), parameter | default_exit_solve_tolerance = DEM5 |
|
private |
Definition at line 808 of file prt-prp.f90.
|
private |
Definition at line 504 of file prt-prp.f90.
|
private |
BndExtType expects certain array variables to exist in the input context (CELLID, NODEULIST, BOUNDNAME, AUXVAR). This method manually creates zero-sized arrays before calling the parent's allocate_arrays.
Definition at line 402 of file prt-prp.f90.
|
private |
The exchange PRP is a headless package (no input file) but BndExtType expects certain variables to exist in the input context (IPER, IONPER, HASPERIODBLOCKS) so we need to manually create them before calling the parent procedure.
Definition at line 376 of file prt-prp.f90.
|
private |
Definition at line 424 of file prt-prp.f90.
|
private |
Definition at line 521 of file prt-prp.f90.
|
private |
Exchange PRP particles are transferred from other models and already active, so their mass is already accounted for in the STORAGE term.
Definition at line 512 of file prt-prp.f90.
|
private |
Definition at line 1062 of file prt-prp.f90.
|
private |
Definition at line 987 of file prt-prp.f90.

|
private |
Definition at line 529 of file prt-prp.f90.
|
private |
Definition at line 769 of file prt-prp.f90.
|
private |
| [in,out] | this | this instance |
| [in,out] | particle | the particle |
| [in] | ip | particle index |
| [in] | trelease | release time |
Definition at line 624 of file prt-prp.f90.

|
private |
| [in,out] | this | prp |
Definition at line 538 of file prt-prp.f90.
|
private |
Definition at line 429 of file prt-prp.f90.
|
private |
Definition at line 258 of file prt-prp.f90.

|
private |
Definition at line 294 of file prt-prp.f90.
|
private |
Definition at line 354 of file prt-prp.f90.
|
private |
Call after release times, the release time frequency and the default are loaded. Then an empty time selection means no time-based releases, and IONPER still holds the first period block's number, or nper + 1 if there is no block to load.
Definition at line 1322 of file prt-prp.f90.

|
private |
Definition at line 495 of file prt-prp.f90.
|
private |
| [in,out] | flowja | flow between package and model |
| [in] | imover | flag indicating if the mover package is active |
Definition at line 774 of file prt-prp.f90.
| subroutine, public prtprpmodule::prp_create | ( | class(bndtype), pointer | packobj, |
| integer(i4b), intent(in) | id, | ||
| integer(i4b), intent(in) | ibcnum, | ||
| integer(i4b), intent(in) | inunit, | ||
| integer(i4b), intent(in) | iout, | ||
| character(len=*), intent(in) | namemodel, | ||
| character(len=*), intent(in) | pakname, | ||
| type(prtfmitype), pointer | fmi, | ||
| character(len=*), intent(in), optional | input_mempath ) |
Creates either a standard PRP (reads from input file) or an exchange PRP (programmatically populated). The type is determined by whether input_mempath is provided: if present, standard; if absent, exchange.
Definition at line 129 of file prt-prp.f90.
|
private |
Definition at line 196 of file prt-prp.f90.
|
private |
Definition at line 820 of file prt-prp.f90.

|
private |
Definition at line 1029 of file prt-prp.f90.
|
private |
The default depends on the input only: no explicit release times, no release time frequency, and no period blocks. It doesn't depend on the schedule, which only holds the times that will be used, so explicit times that are all dropped don't trigger the default.
The exchange PRP doesn't get this default, on purpose: it carries particles between models and never calls prp_dimensions.
Definition at line 1294 of file prt-prp.f90.
|
private |
Definition at line 1359 of file prt-prp.f90.

|
private |
Definition at line 993 of file prt-prp.f90.
|
private |
Definition at line 814 of file prt-prp.f90.


|
private |
Definition at line 835 of file prt-prp.f90.

|
private |
Definition at line 1074 of file prt-prp.f90.

|
private |
Definition at line 1217 of file prt-prp.f90.

|
private |
Definition at line 739 of file prt-prp.f90.
|
private |
Definition at line 248 of file prt-prp.f90.
|
private |
Releasing a particle entails validating the particle's coordinates and settings, transforming its coordinates if needed, initializing the particle's initial tracking time to the given release time, storing the particle in the particle store (from which the PRT model will later retrieve it, apply the tracking method, and check it in again), and accumulating the particle's mass (the total mass released from each release point is calculated for budget reporting).
| [in,out] | this | this instance |
| [in] | ip | particle index |
| [in] | trelease | release time |
Definition at line 606 of file prt-prp.f90.
|
private |
Terminate with an error if the release point lies outside the given cell, or if the point is above or below the grid top or bottom, respectively.
| [in,out] | this | this instance |
| [in] | ic | cell index |
| [in] | z | release point |
Definition at line 553 of file prt-prp.f90.

|
private |
Definition at line 36 of file prt-prp.f90.
|
private |
Definition at line 34 of file prt-prp.f90.
|
private |
Definition at line 35 of file prt-prp.f90.