![]() |
MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
|
Rectangular subcell tracking method. More...


Public Member Functions | |
| procedure, public | apply (this, particle, tmax) |
| Apply Pollock's method to a rectangular subcell. | |
| procedure, public | deallocate (this) |
| Deallocate the Pollock's subcell method. | |
| procedure, public | assess (this, particle, cell_defn, tmax) |
| Assess conditions before tracking. | |
| procedure, public | assess (this, particle, cell_defn, tmax) |
| Check reporting/terminating conditions before tracking the particle across the cell. | |
| procedure(assess), deferred | assess (this, particle, cell_defn, tmax) |
| assess conditions before tracking | |
| procedure, public | subcellexit (this, particle) |
| Particle exits a subcell. | |
| procedure, public | get_level (this) |
| Get the subcell method's level. | |
| procedure, public | get_level (this) |
| Get the cell method's level. | |
| procedure | get_level (this) |
| get the tracking method level | |
| procedure, public | cellexit (this, particle) |
| Particle exits a cell. | |
| procedure, public | forms_cycle (this, particle, event) |
| Check if the event forms a cycle in the particle path. | |
| procedure, public | store_event (this, particle, event) |
| Save the event in the particle's history. Acts like a queue, the oldest event is removed when the event count exceeds the maximum size. | |
| procedure, public | try_pass (this, particle, nextlevel, advancing) |
| Try passing the particle to the next subdomain. or to a boundary of this method's tracking domain. | |
| procedure | try_pass (this, particle, nextlevel, advancing) |
| Try passing the particle to the next subdomain. | |
| procedure | iboundary_to_icellface (this, iboundary) |
| Convert an iboundary number to an iface number. | |
| procedure(apply), deferred | apply (this, particle, tmax) |
| apply the method to the particle | |
| procedure(deallocate), deferred | deallocate (this) |
| deallocate the method object | |
| procedure | load (this, particle, next_level, submethod) |
| load the subdomain tracking method | |
| procedure | init (this, fmi, cell, subcell, events, tracktimes, izone, flowja, porosity, retfactor) |
| Initialize the method with pointers to model data. | |
| procedure | track (this, particle, level, tmax) |
| Track the particle over subdomains of the given. | |
| procedure | release (this, particle) |
| A particle is released. | |
| procedure | terminate (this, particle, status) |
| A particle terminates. | |
| procedure | timestep (this, particle) |
| A time step ends. | |
| procedure | weaksink (this, particle) |
| A particle leaves a weak sink. | |
| procedure | usertime (this, particle) |
| A user-defined tracking time occurs. | |
| procedure | dropped (this, particle) |
| A particle drops to the water table. | |
Public Attributes | |
| real(dp), dimension(:), allocatable, public | qextl1 |
| real(dp), dimension(:), allocatable, public | qextl2 |
| real(dp), dimension(:), allocatable, public | qintl |
| external and internal subcell flows | |
| character(len=40), pointer, public | name |
| method name | |
| logical(lgp), public | delegates |
| whether the method delegates | |
| type(prtfmitype), pointer, public | fmi => null() |
| ptr to fmi | |
| class(celltype), pointer, public | cell => null() |
| ptr to the current cell | |
| class(subcelltype), pointer, public | subcell => null() |
| ptr to the current subcell | |
| type(particleeventdispatchertype), pointer, public | events => null() |
| ptr to event dispatcher | |
| type(timeselecttype), pointer, public | tracktimes => null() |
| ptr to user-defined tracking times | |
| integer(i4b), dimension(:), pointer, public, contiguous | izone => null() |
| pointer to zone numbers | |
| real(dp), dimension(:), pointer, public, contiguous | flowja => null() |
| pointer to intercell flows | |
| real(dp), dimension(:), pointer, public, contiguous | porosity => null() |
| pointer to aquifer porosity | |
| real(dp), dimension(:), pointer, public, contiguous | retfactor => null() |
| pointer to retardation factor | |
Private Member Functions | |
| procedure, private | track_subcell (this, subcell, particle, tmax) |
| Track a particle across a rectangular subcell using Pollock's method. | |
Definition at line 26 of file MethodSubcellPollock.f90.
|
pure virtualinherited |
Definition at line 71 of file Method.f90.
| procedure, public methodsubcellpollockmodule::methodsubcellpollocktype::apply | ( | class(methodsubcellpollocktype), intent(inout) | this, |
| type(particletype), intent(inout), pointer | particle, | ||
| real(dp), intent(in) | tmax ) |
Definition at line 30 of file MethodSubcellPollock.f90.
|
inherited |
Check a number of conditions determining whether to continue tracking the particle or terminate it, as well as whether to record any output data as per selected reporting conditions.
Definition at line 20 of file MethodCell.f90.
|
pure virtualinherited |
Definition at line 72 of file Method.f90.
|
inherited |
Definition at line 17 of file MethodSubcell.f90.
|
inherited |
Definition at line 21 of file MethodCell.f90.
|
pure virtualinherited |
Definition at line 73 of file Method.f90.
| procedure, public methodsubcellpollockmodule::methodsubcellpollocktype::deallocate | ( | class(methodsubcellpollocktype), intent(inout) | this | ) |
Definition at line 31 of file MethodSubcellPollock.f90.
|
inherited |
Definition at line 88 of file Method.f90.
|
inherited |
Definition at line 22 of file MethodCell.f90.
|
inherited |
Definition at line 24 of file MethodCell.f90.
|
inherited |
pass the particle to the next subdomain
Definition at line 74 of file Method.f90.
|
inherited |
Definition at line 19 of file MethodSubcell.f90.
|
inherited |
Definition at line 26 of file MethodCell.f90.
|
inherited |
Definition at line 79 of file Method.f90.
|
inherited |
Definition at line 77 of file Method.f90.
|
inherited |
Definition at line 83 of file Method.f90.
|
inherited |
Definition at line 23 of file MethodCell.f90.
|
inherited |
Definition at line 18 of file MethodSubcell.f90.
|
inherited |
Definition at line 84 of file Method.f90.
|
inherited |
Definition at line 85 of file Method.f90.
|
inherited |
Definition at line 80 of file Method.f90.
|
private |
This subroutine consists partly of code written by David W. Pollock of the USGS for MODPATH 7. PRT's authors take responsibility for its application in this context and for any modifications or errors.
Definition at line 32 of file MethodSubcellPollock.f90.
|
inherited |
If the particle is not advancing, or if it's not at a boundary, nothing happens. Otherwise, raise a cell exit event. Then, if at a net outflow boundary face, or top face of a partially saturated cell, terminate.
Definition at line 25 of file MethodCell.f90.
|
inherited |
Definition at line 81 of file Method.f90.
|
inherited |
Definition at line 87 of file Method.f90.
|
inherited |
Definition at line 86 of file Method.f90.
|
inherited |
Definition at line 61 of file Method.f90.
|
inherited |
Definition at line 59 of file Method.f90.
|
inherited |
Definition at line 63 of file Method.f90.
|
inherited |
Definition at line 66 of file Method.f90.
|
inherited |
Definition at line 60 of file Method.f90.
|
inherited |
Definition at line 65 of file Method.f90.
|
inherited |
Definition at line 58 of file Method.f90.
|
inherited |
Definition at line 67 of file Method.f90.
| real(dp), dimension(:), allocatable, public methodsubcellpollockmodule::methodsubcellpollocktype::qextl1 |
Definition at line 28 of file MethodSubcellPollock.f90.
| real(dp), dimension(:), allocatable, public methodsubcellpollockmodule::methodsubcellpollocktype::qextl2 |
Definition at line 28 of file MethodSubcellPollock.f90.
| real(dp), dimension(:), allocatable, public methodsubcellpollockmodule::methodsubcellpollocktype::qintl |
Definition at line 28 of file MethodSubcellPollock.f90.
|
inherited |
Definition at line 68 of file Method.f90.
|
inherited |
Definition at line 62 of file Method.f90.
|
inherited |
Definition at line 64 of file Method.f90.