methodmodule::methodtype Type Reference

Base type for particle tracking methods. More...

Inheritance diagram for methodmodule::methodtype:

Collaboration diagram for methodmodule::methodtype:

Public Attributes
character(len=40), pointer, public	type
	method name More...
logical(lgp), public	delegates
	whether the method delegates More...
type(prtfmitype), pointer, public	fmi => null()
	ptr to fmi More...
class(celltype), pointer, public	cell => null()
	ptr to the current cell More...
class(subcelltype), pointer, public	subcell => null()
	ptr to the current subcell More...
type(trackcontroltype), pointer, public	trackctl => null()
	ptr to track file control More...
type(timeselecttype), pointer, public	tracktimes => null()
	ptr to user-defined tracking times More...
integer(i4b), dimension(:), pointer, public, contiguous	izone => null()
	pointer to zone numbers More...
real(dp), dimension(:), pointer, public, contiguous	flowja => null()
	pointer to intercell flows More...
real(dp), dimension(:), pointer, public, contiguous	porosity => null()
	pointer to aquifer porosity More...
real(dp), dimension(:), pointer, public, contiguous	retfactor => null()
	pointer to retardation factor More...

Private Member Functions
procedure(apply), deferred	apply
procedure(deallocate), deferred	deallocate
procedure	load
procedure	init
procedure	track
procedure	try_pass
procedure	update

Detailed Description

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 29 of file Method.f90.

Member Function/Subroutine Documentation

apply()

procedure(apply), deferred methodmodule::methodtype::apply

private

Definition at line 43 of file Method.f90.

deallocate()

procedure(deallocate), deferred methodmodule::methodtype::deallocate

private

Definition at line 44 of file Method.f90.

init()

procedure methodmodule::methodtype::init

private

Definition at line 49 of file Method.f90.

load()

procedure methodmodule::methodtype::load

private

Definition at line 47 of file Method.f90.

track()

procedure methodmodule::methodtype::track

private

Definition at line 51 of file Method.f90.

try_pass()

procedure methodmodule::methodtype::try_pass

private

Definition at line 52 of file Method.f90.

update()

procedure methodmodule::methodtype::update

private

Definition at line 53 of file Method.f90.

Member Data Documentation

cell

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

Definition at line 33 of file Method.f90.

    class(CellType), pointer, public :: cell => null() !< ptr to the current cell

delegates

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

Definition at line 31 of file Method.f90.

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

flowja

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

Definition at line 38 of file Method.f90.

    real(DP), dimension(:), pointer, contiguous, public :: flowja => null() !< pointer to intercell flows

fmi

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

Definition at line 32 of file Method.f90.

    type(PrtFmiType), pointer, public :: fmi => null() !< ptr to fmi

izone

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

Definition at line 37 of file Method.f90.

    integer(I4B), dimension(:), pointer, contiguous, public :: izone => null() !< pointer to zone numbers

porosity

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

Definition at line 39 of file Method.f90.

    real(DP), dimension(:), pointer, contiguous, public :: porosity => null() !< pointer to aquifer porosity

retfactor

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

Definition at line 40 of file Method.f90.

    real(DP), dimension(:), pointer, contiguous, public :: retfactor => null() !< pointer to retardation factor

subcell

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

Definition at line 34 of file Method.f90.

    class(SubcellType), pointer, public :: subcell => null() !< ptr to the current subcell

trackctl

type(trackcontroltype), pointer, public methodmodule::methodtype::trackctl => null()

Definition at line 35 of file Method.f90.

    type(TrackControlType), pointer, public :: trackctl => null() !< ptr to track file control

tracktimes

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

Definition at line 36 of file Method.f90.

    type(TimeSelectType), pointer, public :: tracktimes => null() !< ptr to user-defined tracking times

type

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

Definition at line 30 of file Method.f90.

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

---

The documentation for this type was generated from the following file:

• /home/runner/work/modflow6/modflow6/src/Solution/ParticleTracker/Method.f90