![]() |
MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
|
Base type for particle tracking methods. More...


Public Member Functions | |
| procedure(apply), deferred | apply (this, particle, tmax) |
| apply the method to the particle | |
| procedure(assess), deferred | assess (this, particle, cell_defn, tmax) |
| assess conditions before tracking | |
| procedure(deallocate), deferred | deallocate (this) |
| deallocate the method object | |
| procedure | get_level (this) |
| get the tracking method level | |
| 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 | |
| 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 | |
The PRT tracking algorithm invokes a "tracking method" for each domain. A domain can be a model, cell in a model, or subcell in a cell. Tracking proceeds recursively, delegating to a possibly arbitrary number of subdomains (currently, only the three above are recognized). A tracking method is responsible for advancing a particle through a domain, delegating to subdomains as needed depending on cell geometry (implementing the strategy pattern).
Definition at line 57 of file Method.f90.
|
pure virtual |
Definition at line 71 of file Method.f90.
|
pure virtual |
Definition at line 72 of file Method.f90.
|
pure virtual |
Definition at line 73 of file Method.f90.
| procedure methodmodule::methodtype::dropped | ( | class(methodtype), intent(inout) | this, |
| type(particletype), intent(inout), pointer | particle ) |
Definition at line 88 of file Method.f90.
| procedure methodmodule::methodtype::get_level | ( | class(methodtype), intent(in) | this | ) |
pass the particle to the next subdomain
Definition at line 74 of file Method.f90.
| procedure methodmodule::methodtype::init | ( | class(methodtype), intent(inout) | this, |
| type(prtfmitype), intent(in), optional, pointer | fmi, | ||
| class(celltype), intent(in), optional, pointer | cell, | ||
| class(subcelltype), intent(in), optional, pointer | subcell, | ||
| type(particleeventdispatchertype), intent(in), optional, pointer | events, | ||
| type(timeselecttype), intent(in), optional, pointer | tracktimes, | ||
| integer(i4b), dimension(:), intent(in), optional, pointer | izone, | ||
| real(dp), dimension(:), intent(in), optional, pointer | flowja, | ||
| real(dp), dimension(:), intent(in), optional, pointer | porosity, | ||
| real(dp), dimension(:), intent(in), optional, pointer | retfactor ) |
Definition at line 79 of file Method.f90.
| procedure methodmodule::methodtype::load | ( | class(methodtype), intent(inout) | this, |
| type(particletype), intent(inout), pointer | particle, | ||
| integer, intent(in) | next_level, | ||
| class(methodtype), intent(inout), pointer | submethod ) |
Definition at line 77 of file Method.f90.
| procedure methodmodule::methodtype::release | ( | class(methodtype), intent(inout) | this, |
| type(particletype), intent(inout), pointer | particle ) |
Definition at line 83 of file Method.f90.
| procedure methodmodule::methodtype::terminate | ( | class(methodtype), intent(inout) | this, |
| type(particletype), intent(inout), pointer | particle, | ||
| integer(i4b), intent(in), optional | status ) |
Definition at line 84 of file Method.f90.
| procedure methodmodule::methodtype::timestep | ( | class(methodtype), intent(inout) | this, |
| type(particletype), intent(inout), pointer | particle ) |
Definition at line 85 of file Method.f90.
| procedure methodmodule::methodtype::track | ( | class(methodtype), intent(inout) | this, |
| type(particletype), intent(inout), pointer | particle, | ||
| integer(i4b) | level, | ||
| real(dp), intent(in) | tmax ) |
Definition at line 80 of file Method.f90.
| procedure methodmodule::methodtype::try_pass | ( | class(methodtype), intent(inout) | this, |
| type(particletype), intent(inout), pointer | particle, | ||
| integer(i4b) | nextlevel, | ||
| logical(lgp) | advancing ) |
Definition at line 81 of file Method.f90.
| procedure methodmodule::methodtype::usertime | ( | class(methodtype), intent(inout) | this, |
| type(particletype), intent(inout), pointer | particle ) |
Definition at line 87 of file Method.f90.
| procedure methodmodule::methodtype::weaksink | ( | class(methodtype), intent(inout) | this, |
| type(particletype), intent(inout), pointer | particle ) |
Definition at line 86 of file Method.f90.
| class(celltype), pointer, public methodmodule::methodtype::cell => null() |
Definition at line 61 of file Method.f90.
| logical(lgp), public methodmodule::methodtype::delegates |
Definition at line 59 of file Method.f90.
| type(particleeventdispatchertype), pointer, public methodmodule::methodtype::events => null() |
Definition at line 63 of file Method.f90.
| real(dp), dimension(:), pointer, public, contiguous methodmodule::methodtype::flowja => null() |
Definition at line 66 of file Method.f90.
| type(prtfmitype), pointer, public methodmodule::methodtype::fmi => null() |
Definition at line 60 of file Method.f90.
| integer(i4b), dimension(:), pointer, public, contiguous methodmodule::methodtype::izone => null() |
Definition at line 65 of file Method.f90.
| character(len=40), pointer, public methodmodule::methodtype::name |
Definition at line 58 of file Method.f90.
| real(dp), dimension(:), pointer, public, contiguous methodmodule::methodtype::porosity => null() |
Definition at line 67 of file Method.f90.
| real(dp), dimension(:), pointer, public, contiguous methodmodule::methodtype::retfactor => null() |
Definition at line 68 of file Method.f90.
| class(subcelltype), pointer, public methodmodule::methodtype::subcell => null() |
Definition at line 62 of file Method.f90.
| type(timeselecttype), pointer, public methodmodule::methodtype::tracktimes => null() |
Definition at line 64 of file Method.f90.