![]() |
MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
|


Public Member Functions | |
| procedure, public | apply (this, particle, tmax) |
| apply the DISV tracking method | |
| procedure, public | deallocate (this) |
| deallocate arrays and scalars | |
| procedure, public | load (this, particle, next_level, submethod) |
| load the cell method | |
| procedure, public | load_cell_defn (this, particle) |
| load cell definition from the grid | |
| procedure | map_neighbor (this, defn, inface, z) |
| map a location on the cell face to the shared face of a neighbor | |
| procedure | update_flowja (this, cell, particle) |
| update intercell mass flows | |
| procedure | load_particle (this, cell, particle) |
| load particle properties | |
| procedure | load_cell_properties (this, ic, defn) |
| load cell properties | |
| procedure | load_cell_polygon (this, defn) |
| load cell polygon | |
| procedure | load_cell_neighbors (this, defn) |
| load cell face neighbors | |
| procedure | load_cell_flags (this, defn) |
| load cell 180-degree vertex indicator | |
| procedure | load_cell_flows (this, defn) |
| load the cell's flows | |
| procedure | load_cell_boundary_flows (this, defn) |
| load boundary flows to a polygonal cell definition | |
| procedure | load_cell_face_flows (this, defn) |
| load face flows to a polygonal cell definition | |
| procedure, public | assess (this, particle, cell_defn, tmax) |
| Check particle reporting/termination status. | |
| procedure(assess), deferred | assess (this, particle, cell_defn, tmax) |
| assess conditions before tracking | |
| procedure, public | get_level (this) |
| Get the model method's level. | |
| procedure | get_level (this) |
| get the tracking method level | |
| procedure | cap_cell_wt_flow (this, defn) |
| Prevent non-boundary upwards flow at the water table. | |
| procedure | load_cell_no_exit_face (this, defn) |
| Set flag indicating if the cell has any faces with outflow. Assumes cell properties and flows are already loaded. | |
| procedure | load_cell_saturation_status (this, defn) |
| Set the saturation status of a cell. See the status enumeration in CellDefnModule. | |
| 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 | try_pass (this, particle, nextlevel, advancing) |
| Try passing the particle to the next subdomain. | |
| 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 | |
| type(methodcellpollocktype), pointer | method_cell_plck => null() |
| type(methodcellpollockquadtype), pointer | method_cell_quad => null() |
| type(methodcellternarytype), pointer | method_cell_tern => null() |
| type(methodcellpasstobottype), pointer | method_cell_ptb => null() |
| 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 Attributes | |
| type(celldefntype), pointer | neighbor => null() |
| ptr to a neighbor defn | |
Definition at line 29 of file MethodDisv.f90.
| procedure, public methoddisvmodule::methoddisvtype::apply | ( | class(methoddisvtype), intent(inout) | this, |
| type(particletype), intent(inout), pointer | particle, | ||
| real(dp), intent(in) | tmax ) |
Definition at line 37 of file MethodDisv.f90.
|
pure virtualinherited |
Definition at line 71 of file Method.f90.
|
inherited |
Definition at line 18 of file MethodModel.f90.
|
pure virtualinherited |
Definition at line 72 of file Method.f90.
|
inherited |
Unless the top face is an assigned boundary with outflow, cells which contain a water table should not have upward flow through the top (i.e., the water table). Prevent it by capping the top face flow at zero in these conditions.
Assumes cell properties and flows are already loaded.
Definition at line 21 of file MethodModel.f90.
| procedure, public methoddisvmodule::methoddisvtype::deallocate | ( | class(methoddisvtype), intent(inout) | this | ) |
Definition at line 38 of file MethodDisv.f90.
|
pure virtualinherited |
Definition at line 73 of file Method.f90.
|
inherited |
Definition at line 88 of file Method.f90.
|
inherited |
Definition at line 19 of file MethodModel.f90.
|
inherited |
pass the particle to the next subdomain
Definition at line 74 of file Method.f90.
|
inherited |
Definition at line 79 of file Method.f90.
| procedure, public methoddisvmodule::methoddisvtype::load | ( | class(methoddisvtype), intent(inout) | this, |
| type(particletype), intent(inout), pointer | particle, | ||
| integer(i4b), intent(in) | next_level, | ||
| class(methodtype), intent(inout), pointer | submethod ) |
Definition at line 39 of file MethodDisv.f90.
|
inherited |
Definition at line 77 of file Method.f90.
| procedure methoddisvmodule::methoddisvtype::load_cell_boundary_flows | ( | class(methoddisvtype), intent(inout) | this, |
| type(celldefntype), intent(inout), pointer | defn ) |
Definition at line 50 of file MethodDisv.f90.
| procedure, public methoddisvmodule::methoddisvtype::load_cell_defn | ( | class(methoddisvtype), intent(inout) | this, |
| type(particletype), intent(inout), pointer | particle ) |
pass the particle to the next cell
Definition at line 40 of file MethodDisv.f90.
| procedure methoddisvmodule::methoddisvtype::load_cell_face_flows | ( | class(methoddisvtype), intent(inout) | this, |
| type(celldefntype), intent(inout), pointer | defn ) |
Definition at line 51 of file MethodDisv.f90.
| procedure methoddisvmodule::methoddisvtype::load_cell_flags | ( | class(methoddisvtype), intent(inout) | this, |
| type(celldefntype), intent(inout), pointer | defn ) |
Definition at line 48 of file MethodDisv.f90.
| procedure methoddisvmodule::methoddisvtype::load_cell_flows | ( | class(methoddisvtype), intent(inout) | this, |
| type(celldefntype), intent(inout), pointer | defn ) |
Definition at line 49 of file MethodDisv.f90.
| procedure methoddisvmodule::methoddisvtype::load_cell_neighbors | ( | class(methoddisvtype), intent(inout) | this, |
| type(celldefntype), intent(inout), pointer | defn ) |
Definition at line 47 of file MethodDisv.f90.
|
inherited |
Definition at line 22 of file MethodModel.f90.
| procedure methoddisvmodule::methoddisvtype::load_cell_polygon | ( | class(methoddisvtype), intent(inout) | this, |
| type(celldefntype), intent(inout), pointer | defn ) |
Definition at line 46 of file MethodDisv.f90.
| procedure methoddisvmodule::methoddisvtype::load_cell_properties | ( | class(methoddisvtype), intent(inout) | this, |
| integer(i4b), intent(in) | ic, | ||
| type(celldefntype), intent(inout), pointer | defn ) |
Definition at line 45 of file MethodDisv.f90.
|
inherited |
Definition at line 23 of file MethodModel.f90.
| procedure methoddisvmodule::methoddisvtype::load_particle | ( | class(methoddisvtype), intent(inout) | this, |
| type(cellpolytype), intent(inout), pointer | cell, | ||
| type(particletype), intent(inout), pointer | particle ) |
Definition at line 44 of file MethodDisv.f90.
| procedure methoddisvmodule::methoddisvtype::map_neighbor | ( | class(methoddisvtype), intent(inout) | this, |
| type(celldefntype), intent(inout), pointer | defn, | ||
| integer(i4b), intent(inout) | inface, | ||
| double precision, intent(inout) | z ) |
Definition at line 42 of file MethodDisv.f90.
|
inherited |
Definition at line 83 of file Method.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.
|
inherited |
Definition at line 81 of file Method.f90.
| procedure methoddisvmodule::methoddisvtype::update_flowja | ( | class(methoddisvtype), intent(inout) | this, |
| type(cellpolytype), intent(inout), pointer | cell, | ||
| type(particletype), intent(inout), pointer | particle ) |
Definition at line 43 of file MethodDisv.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.
| type(methodcellpollocktype), pointer methoddisvmodule::methoddisvtype::method_cell_plck => null() |
Definition at line 32 of file MethodDisv.f90.
| type(methodcellpasstobottype), pointer methoddisvmodule::methoddisvtype::method_cell_ptb => null() |
Definition at line 35 of file MethodDisv.f90.
| type(methodcellpollockquadtype), pointer methoddisvmodule::methoddisvtype::method_cell_quad => null() |
Definition at line 33 of file MethodDisv.f90.
| type(methodcellternarytype), pointer methoddisvmodule::methoddisvtype::method_cell_tern => null() |
Definition at line 34 of file MethodDisv.f90.
|
inherited |
Definition at line 58 of file Method.f90.
|
private |
Definition at line 31 of file MethodDisv.f90.
|
inherited |
Definition at line 67 of file Method.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.