Abstract base type for subcell tracking methods. More...

Inheritance diagram for methodsubcellmodule::methodsubcelltype:

Collaboration diagram for methodsubcellmodule::methodsubcelltype:

Public Member Functions
procedure, public	assess

procedure, public	subcellexit

procedure, public	get_level

procedure, public	cellexit

procedure, public	forms_cycle

procedure, public	store_event

procedure, public	try_pass

Public Attributes
character(len=40), pointer, public	name
	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(particleeventdispatchertype), pointer, public	events => null()
	ptr to event dispatcher 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	iboundary_to_icellface

procedure(apply), deferred	apply
	apply the method to the particle More...

procedure(deallocate), deferred	deallocate
	deallocate the method object More...

procedure	load
	load the subdomain tracking method More...

procedure	find_exits
	find domain exit solutions More...

procedure	pick_exit

procedure	init

procedure	track

procedure	release

procedure	terminate

procedure	timestep

procedure	weaksink

procedure	usertime

procedure	dropped

Detailed Description

Definition at line 14 of file MethodSubcell.f90.

Member Function/Subroutine Documentation

◆ apply()

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

privateinherited

Definition at line 72 of file Method.f90.

◆ assess()

procedure, public methodsubcellmodule::methodsubcelltype::assess

Definition at line 16 of file MethodSubcell.f90.

◆ cellexit()

procedure, public methodcellmodule::methodcelltype::cellexit

inherited

Definition at line 20 of file MethodCell.f90.

◆ deallocate()

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

privateinherited

Definition at line 74 of file Method.f90.

◆ dropped()

procedure methodmodule::methodtype::dropped

privateinherited

Definition at line 91 of file Method.f90.

◆ find_exits()

procedure methodmodule::methodtype::find_exits

privateinherited

Definition at line 79 of file Method.f90.

◆ forms_cycle()

procedure, public methodcellmodule::methodcelltype::forms_cycle

inherited

Definition at line 21 of file MethodCell.f90.

◆ get_level()

procedure, public methodsubcellmodule::methodsubcelltype::get_level

Definition at line 18 of file MethodSubcell.f90.

◆ iboundary_to_icellface()

procedure methodcellmodule::methodcelltype::iboundary_to_icellface

privateinherited

Definition at line 25 of file MethodCell.f90.

◆ init()

procedure methodmodule::methodtype::init

privateinherited

Definition at line 82 of file Method.f90.

◆ load()

procedure methodmodule::methodtype::load

privateinherited

Definition at line 78 of file Method.f90.

◆ pick_exit()

procedure methodmodule::methodtype::pick_exit

privateinherited

Definition at line 80 of file Method.f90.

◆ release()

procedure methodmodule::methodtype::release

privateinherited

Definition at line 86 of file Method.f90.

◆ store_event()

procedure, public methodcellmodule::methodcelltype::store_event

inherited

Definition at line 22 of file MethodCell.f90.

◆ subcellexit()

procedure, public methodsubcellmodule::methodsubcelltype::subcellexit

Definition at line 17 of file MethodSubcell.f90.

◆ terminate()

procedure methodmodule::methodtype::terminate

privateinherited

Definition at line 87 of file Method.f90.

◆ timestep()

procedure methodmodule::methodtype::timestep

privateinherited

Definition at line 88 of file Method.f90.

◆ track()

procedure methodmodule::methodtype::track

privateinherited

Definition at line 83 of file Method.f90.

◆ try_pass()

procedure, public methodcellmodule::methodcelltype::try_pass

inherited

Definition at line 24 of file MethodCell.f90.

◆ usertime()

procedure methodmodule::methodtype::usertime

privateinherited

Definition at line 90 of file Method.f90.

◆ weaksink()

procedure methodmodule::methodtype::weaksink

privateinherited

Definition at line 89 of file Method.f90.

Member Data Documentation

◆ cell

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

inherited

Definition at line 62 of file Method.f90.

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

◆ delegates

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

inherited

Definition at line 60 of file Method.f90.

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

◆ events

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

inherited

Definition at line 64 of file Method.f90.

64 type(ParticleEventDispatcherType), pointer, public :: events => null() !< ptr to event dispatcher

◆ flowja

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

inherited

Definition at line 67 of file Method.f90.

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

◆ fmi

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

inherited

Definition at line 61 of file Method.f90.

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

◆ izone

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

inherited

Definition at line 66 of file Method.f90.

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

◆ name

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

inherited

Definition at line 59 of file Method.f90.

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

◆ porosity

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

inherited

Definition at line 68 of file Method.f90.

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

◆ retfactor

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

inherited

Definition at line 69 of file Method.f90.

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

◆ subcell

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

inherited

Definition at line 63 of file Method.f90.

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

◆ tracktimes

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

inherited

Definition at line 65 of file Method.f90.

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

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

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

Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Member Function/Subroutine Documentation

◆ apply()

◆ assess()

◆ cellexit()

◆ deallocate()

◆ dropped()

◆ find_exits()

◆ forms_cycle()

◆ get_level()

◆ iboundary_to_icellface()

◆ init()

◆ load()

◆ pick_exit()

◆ release()

◆ store_event()

◆ subcellexit()

◆ terminate()

◆ timestep()

◆ track()

◆ try_pass()

◆ usertime()

◆ weaksink()

Member Data Documentation

◆ cell

◆ delegates

◆ events

◆ flowja

◆ fmi

◆ izone

◆ name

◆ porosity

◆ retfactor

◆ subcell

◆ tracktimes