MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
methoddismodule::methoddistype Type Referenceabstract
Inheritance diagram for methoddismodule::methoddistype:
Inheritance graph
Collaboration diagram for methoddismodule::methoddistype:
Collaboration graph

Public Member Functions

procedure, public apply (this, particle, tmax)
 apply the DIS tracking method
procedure, public deallocate (this)
 deallocate arrays and scalars
procedure, public load (this, particle)
 load the method
procedure get_top (this, iatop)
 get cell top elevation
procedure update_flowja (this, cell, particle)
 load intercell mass flows
procedure load_particle (this, cell, particle)
 load particle properties
procedure load_cell_properties (this, ic, defn)
 load basic cell properties
procedure load_cell_neighbors (this, defn)
 load cell face neighbors
procedure load_cell_flows (this, defn)
 load cell flows
procedure load_cell_boundary_flows (this, defn)
 load boundary flows to the cell definition
procedure load_cell_face_flows (this, defn)
 load face flows to the cell definition
procedure load_cell_defn (this, ic, defn)
 load cell definition from the grid
procedure load_cell (this, ic, cell)
 load cell geometry and flows
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(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(methodcellpollocktype), pointer method_cell_plck => null()

Detailed Description

Definition at line 25 of file MethodDis.f90.

Member Function/Subroutine Documentation

◆ apply() [1/2]

procedure, public methoddismodule::methoddistype::apply ( class(methoddistype), intent(inout) this,
type(particletype), intent(inout), pointer particle,
real(dp), intent(in) tmax )

Definition at line 30 of file MethodDis.f90.

◆ apply() [2/2]

procedure(apply), deferred methodmodule::methodtype::apply ( class(methodtype), intent(inout) this,
type(particletype), intent(inout), pointer particle,
real(dp), intent(in) tmax )
pure virtualinherited

Definition at line 71 of file Method.f90.

◆ assess() [1/2]

procedure, public methodmodelmodule::methodmodeltype::assess ( class(methodmodeltype), intent(inout) this,
type(particletype), intent(inout), pointer particle,
type(celldefntype), intent(inout), pointer cell_defn,
real(dp), intent(in) tmax )
inherited

Definition at line 18 of file MethodModel.f90.

◆ assess() [2/2]

procedure(assess), deferred methodmodule::methodtype::assess ( class(methodtype), intent(inout) this,
type(particletype), intent(inout), pointer particle,
type(celldefntype), intent(inout), pointer cell_defn,
real(dp), intent(in) tmax )
pure virtualinherited

Definition at line 72 of file Method.f90.

◆ cap_cell_wt_flow()

procedure methodmodelmodule::methodmodeltype::cap_cell_wt_flow ( class(methodmodeltype), intent(inout) this,
type(celldefntype), intent(inout), pointer defn )
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.

◆ deallocate() [1/2]

procedure, public methoddismodule::methoddistype::deallocate ( class(methoddistype), intent(inout) this)

Definition at line 31 of file MethodDis.f90.

◆ deallocate() [2/2]

procedure(deallocate), deferred methodmodule::methodtype::deallocate ( class(methodtype), intent(inout) this)
pure virtualinherited

Definition at line 73 of file Method.f90.

◆ dropped()

procedure methodmodule::methodtype::dropped ( class(methodtype), intent(inout) this,
type(particletype), intent(inout), pointer particle )
inherited

Definition at line 88 of file Method.f90.

◆ get_level() [1/2]

procedure, public methodmodelmodule::methodmodeltype::get_level ( class(methodmodeltype), intent(in) this)
inherited

Definition at line 19 of file MethodModel.f90.

◆ get_level() [2/2]

procedure methodmodule::methodtype::get_level ( class(methodtype), intent(in) this)
inherited

pass the particle to the next subdomain

Definition at line 74 of file Method.f90.

◆ get_top()

procedure methoddismodule::methoddistype::get_top ( class(methoddistype), intent(inout) this,
integer, intent(in) iatop )

Definition at line 34 of file MethodDis.f90.

◆ init()

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 )
inherited

Definition at line 79 of file Method.f90.

◆ load() [1/2]

procedure, public methoddismodule::methoddistype::load ( class(methoddistype), intent(inout) this,
type(particletype), intent(inout), pointer particle )

pass the particle to the next domain

Definition at line 32 of file MethodDis.f90.

◆ load() [2/2]

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 )
inherited

Definition at line 77 of file Method.f90.

◆ load_cell()

procedure methoddismodule::methoddistype::load_cell ( class(methoddistype), intent(inout) this,
integer(i4b), intent(in) ic,
type(cellrecttype), intent(inout) cell )

Definition at line 43 of file MethodDis.f90.

◆ load_cell_boundary_flows()

procedure methoddismodule::methoddistype::load_cell_boundary_flows ( class(methoddistype), intent(inout) this,
type(celldefntype), intent(inout), pointer defn )

Definition at line 40 of file MethodDis.f90.

◆ load_cell_defn()

procedure methoddismodule::methoddistype::load_cell_defn ( class(methoddistype), intent(inout) this,
integer(i4b), intent(in) ic,
type(celldefntype), intent(inout), pointer defn )

Definition at line 42 of file MethodDis.f90.

◆ load_cell_face_flows()

procedure methoddismodule::methoddistype::load_cell_face_flows ( class(methoddistype), intent(inout) this,
type(celldefntype), intent(inout), pointer defn )

Definition at line 41 of file MethodDis.f90.

◆ load_cell_flows()

procedure methoddismodule::methoddistype::load_cell_flows ( class(methoddistype), intent(inout) this,
type(celldefntype), intent(inout), pointer defn )

Definition at line 39 of file MethodDis.f90.

◆ load_cell_neighbors()

procedure methoddismodule::methoddistype::load_cell_neighbors ( class(methoddistype), intent(inout) this,
type(celldefntype), intent(inout), pointer defn )

Definition at line 38 of file MethodDis.f90.

◆ load_cell_no_exit_face()

procedure methodmodelmodule::methodmodeltype::load_cell_no_exit_face ( class(methodmodeltype), intent(inout) this,
type(celldefntype), intent(inout), pointer defn )
inherited

Definition at line 22 of file MethodModel.f90.

◆ load_cell_properties()

procedure methoddismodule::methoddistype::load_cell_properties ( class(methoddistype), intent(inout) this,
integer(i4b), intent(in) ic,
type(celldefntype), intent(inout), pointer defn )

Definition at line 37 of file MethodDis.f90.

◆ load_cell_saturation_status()

procedure methodmodelmodule::methodmodeltype::load_cell_saturation_status ( class(methodmodeltype), intent(inout) this,
type(celldefntype), intent(inout), pointer defn )
inherited

Definition at line 23 of file MethodModel.f90.

◆ load_particle()

procedure methoddismodule::methoddistype::load_particle ( class(methoddistype), intent(inout) this,
type(cellrecttype), intent(inout), pointer cell,
type(particletype), intent(inout), pointer particle )

Definition at line 36 of file MethodDis.f90.

◆ release()

procedure methodmodule::methodtype::release ( class(methodtype), intent(inout) this,
type(particletype), intent(inout), pointer particle )
inherited

Definition at line 83 of file Method.f90.

◆ terminate()

procedure methodmodule::methodtype::terminate ( class(methodtype), intent(inout) this,
type(particletype), intent(inout), pointer particle,
integer(i4b), intent(in), optional status )
inherited

Definition at line 84 of file Method.f90.

◆ timestep()

procedure methodmodule::methodtype::timestep ( class(methodtype), intent(inout) this,
type(particletype), intent(inout), pointer particle )
inherited

Definition at line 85 of file Method.f90.

◆ track()

procedure methodmodule::methodtype::track ( class(methodtype), intent(inout) this,
type(particletype), intent(inout), pointer particle,
integer(i4b) level,
real(dp), intent(in) tmax )
inherited

Definition at line 80 of file Method.f90.

◆ try_pass()

procedure methodmodule::methodtype::try_pass ( class(methodtype), intent(inout) this,
type(particletype), intent(inout), pointer particle,
integer(i4b) nextlevel,
logical(lgp) advancing )
inherited

Definition at line 81 of file Method.f90.

◆ update_flowja()

procedure methoddismodule::methoddistype::update_flowja ( class(methoddistype), intent(inout) this,
type(cellrecttype), intent(inout), pointer cell,
type(particletype), intent(inout), pointer particle )

Definition at line 35 of file MethodDis.f90.

◆ usertime()

procedure methodmodule::methodtype::usertime ( class(methodtype), intent(inout) this,
type(particletype), intent(inout), pointer particle )
inherited

Definition at line 87 of file Method.f90.

◆ weaksink()

procedure methodmodule::methodtype::weaksink ( class(methodtype), intent(inout) this,
type(particletype), intent(inout), pointer particle )
inherited

Definition at line 86 of file Method.f90.

Member Data Documentation

◆ cell

class(celltype), pointer, public methodmodule::methodtype::cell => null()
inherited

Definition at line 61 of file Method.f90.

◆ delegates

logical(lgp), public methodmodule::methodtype::delegates
inherited

Definition at line 59 of file Method.f90.

59 logical(LGP), public :: delegates !< whether the method delegates

◆ events

type(particleeventdispatchertype), pointer, public methodmodule::methodtype::events => null()
inherited

Definition at line 63 of file Method.f90.

◆ flowja

real(dp), dimension(:), pointer, public, contiguous methodmodule::methodtype::flowja => null()
inherited

Definition at line 66 of file Method.f90.

◆ fmi

type(prtfmitype), pointer, public methodmodule::methodtype::fmi => null()
inherited

Definition at line 60 of file Method.f90.

◆ izone

integer(i4b), dimension(:), pointer, public, contiguous methodmodule::methodtype::izone => null()
inherited

Definition at line 65 of file Method.f90.

◆ method_cell_plck

type(methodcellpollocktype), pointer methoddismodule::methoddistype::method_cell_plck => null()
private

Definition at line 27 of file MethodDis.f90.

◆ method_cell_ptb

type(methodcellpasstobottype), pointer methoddismodule::methoddistype::method_cell_ptb => null()

Definition at line 28 of file MethodDis.f90.

◆ name

character(len=40), pointer, public methodmodule::methodtype::name
inherited

Definition at line 58 of file Method.f90.

58 character(len=40), pointer, public :: name !< method name

◆ porosity

real(dp), dimension(:), pointer, public, contiguous methodmodule::methodtype::porosity => null()
inherited

Definition at line 67 of file Method.f90.

◆ retfactor

real(dp), dimension(:), pointer, public, contiguous methodmodule::methodtype::retfactor => null()
inherited

Definition at line 68 of file Method.f90.

◆ subcell

class(subcelltype), pointer, public methodmodule::methodtype::subcell => null()
inherited

Definition at line 62 of file Method.f90.

◆ tracktimes

type(timeselecttype), pointer, public methodmodule::methodtype::tracktimes => null()
inherited

Definition at line 64 of file Method.f90.


The documentation for this type was generated from the following file:
  • /home/runner/work/modflow6/modflow6/src/Solution/ParticleTracker/Method/MethodDis.f90