![]() |
MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
|
Particle release scheduling utility. More...

Public Member Functions | |
| procedure | advance (this, lines) |
| Refresh the schedule for the current time step. | |
| procedure | any (this) |
| Check if any releases are scheduled. | |
| procedure | count (this) |
| Return the number of releases scheduled. | |
| procedure | destroy (this) |
| Deallocate the release schedule. | |
| procedure | log (this, iout) |
| Write the release schedule to the given output unit. | |
| procedure | schedule (this, trelease) |
| Add a release time to the schedule. | |
Public Attributes | |
| real(dp), dimension(:), allocatable | times |
| release times | |
| real(dp) | tolerance |
| release time coincidence tolerance | |
| type(timeselecttype), pointer | time_select |
| time selection | |
| type(timestepselecttype), pointer | step_select |
| time step selection | |
The release schedule composes a time selection object for any explicitly specified release times, and a time step selection object for release times specified in period/time step terms.
Release time coincidence is computed within a given tolerance; times closer than the tolerance are merged into a single time.
The release schedule must be refreshed each time step. This is achieved by calling advance(). After this, the times array is a debounced/consolidated schedule for the current time step.
Definition at line 29 of file ParticleReleaseSchedule.f90.
| procedure particlereleaseschedulemodule::particlereleasescheduletype::advance | ( | class(particlereleasescheduletype), intent(inout) | this, |
| character(len=linelength), dimension(:), intent(in), optional | lines ) |
This involves several tasks: first, advance the time selection. Then, if period-block release setting lines are provided, reinitialize the time step selection for the given period. Finally, refresh the schedule array, deduplicating any times closer than the set tolerance.
Definition at line 35 of file ParticleReleaseSchedule.f90.
| procedure particlereleaseschedulemodule::particlereleasescheduletype::any | ( | class(particlereleasescheduletype) | this | ) |
Note: be sure to call advance() before calling this function, or the result may still be associated with a prior time step.
Definition at line 36 of file ParticleReleaseSchedule.f90.
| procedure particlereleaseschedulemodule::particlereleasescheduletype::count | ( | class(particlereleasescheduletype) | this | ) |
Note: be sure to call advance() before calling this function, or the result may still be associated with a prior time step.
Definition at line 37 of file ParticleReleaseSchedule.f90.
| procedure particlereleaseschedulemodule::particlereleasescheduletype::destroy | ( | class(particlereleasescheduletype), intent(inout) | this | ) |
| [in,out] | this | this instance |
Definition at line 38 of file ParticleReleaseSchedule.f90.
| procedure particlereleaseschedulemodule::particlereleasescheduletype::log | ( | class(particlereleasescheduletype), intent(inout) | this, |
| integer(i4b), intent(in) | iout ) |
| [in,out] | this | this instance |
| [in] | iout | output unit |
Definition at line 39 of file ParticleReleaseSchedule.f90.
| procedure particlereleaseschedulemodule::particlereleasescheduletype::schedule | ( | class(particlereleasescheduletype), intent(inout) | this, |
| real(dp), intent(in) | trelease ) |
To schedule multiple release times at once, expand and populate the time selection object by hand. DO NOT attempt to manipulate the times array; this is a read-only property which the schedule maintains.
Definition at line 40 of file ParticleReleaseSchedule.f90.
| type(timestepselecttype), pointer particlereleaseschedulemodule::particlereleasescheduletype::step_select |
Definition at line 33 of file ParticleReleaseSchedule.f90.
| type(timeselecttype), pointer particlereleaseschedulemodule::particlereleasescheduletype::time_select |
Definition at line 32 of file ParticleReleaseSchedule.f90.
| real(dp), dimension(:), allocatable particlereleaseschedulemodule::particlereleasescheduletype::times |
Definition at line 30 of file ParticleReleaseSchedule.f90.
| real(dp) particlereleaseschedulemodule::particlereleasescheduletype::tolerance |
Definition at line 31 of file ParticleReleaseSchedule.f90.