Structure of arrays to store particles. More...

Collaboration diagram for particlemodule::particlestoretype:

Public Member Functions
procedure, public	destroy

procedure, public	num_stored

procedure, public	resize

procedure, public	get

procedure, public	put

Public Attributes
character(len=lenboundname), dimension(:), pointer, public, contiguous	name
	optional particle label More...

integer(i4b), dimension(:), pointer, public, contiguous	imdl
	index of model particle originated in More...

integer(i4b), dimension(:), pointer, public, contiguous	iprp
	index of release package the particle originated in More...

integer(i4b), dimension(:), pointer, public, contiguous	irpt
	index of release point in the particle release package the particle originated in More...

integer(i4b), dimension(:), pointer, public, contiguous	istopweaksink
	weak sink option: 0 = do not stop, 1 = stop More...

integer(i4b), dimension(:), pointer, public, contiguous	istopzone
	stop zone number More...

integer(i4b), dimension(:), pointer, public, contiguous	idrymeth
	stop in dry cells More...

integer(i4b), dimension(:, :), pointer, public, contiguous	itrdomain
	array of indices for domains in the tracking domain hierarchy More...

integer(i4b), dimension(:, :), pointer, public, contiguous	iboundary
	array of indices for tracking domain boundaries More...

integer(i4b), dimension(:), pointer, public, contiguous	icu
	cell number (user) More...

integer(i4b), dimension(:), pointer, public, contiguous	ilay
	layer More...

integer(i4b), dimension(:), pointer, public, contiguous	izone
	current zone number More...

integer(i4b), dimension(:), pointer, public, contiguous	izp
	previous zone number More...

integer(i4b), dimension(:), pointer, public, contiguous	istatus
	particle status More...

real(dp), dimension(:), pointer, public, contiguous	x
	model x coord of particle More...

real(dp), dimension(:), pointer, public, contiguous	y
	model y coord of particle More...

real(dp), dimension(:), pointer, public, contiguous	z
	model z coord of particle More...

real(dp), dimension(:), pointer, public, contiguous	trelease
	particle release time More...

real(dp), dimension(:), pointer, public, contiguous	tstop
	particle stop time More...

real(dp), dimension(:), pointer, public, contiguous	ttrack
	current tracking time More...

integer(i4b), dimension(:), pointer, public, contiguous	ifrctrn
	force ternary method More...

integer(i4b), dimension(:), pointer, public, contiguous	iexmeth
	method for iterative solution of particle exit location and time in generalized Pollock's method More...

real(dp), dimension(:), pointer, public, contiguous	extol
	tolerance for iterative solution of particle exit location and time in generalized Pollock's method More...

integer(lgp), dimension(:), pointer, public, contiguous	extend
	whether to extend tracking beyond the end of the simulation More...

integer(i4b), dimension(:), pointer, public, contiguous	icycwin
	cycle detection window size More...

Detailed Description

Definition at line 104 of file Particle.f90.

Member Function/Subroutine Documentation

◆ destroy()

procedure, public particlemodule::particlestoretype::destroy

Definition at line 135 of file Particle.f90.

◆ get()

procedure, public particlemodule::particlestoretype::get

Definition at line 138 of file Particle.f90.

◆ num_stored()

procedure, public particlemodule::particlestoretype::num_stored

Definition at line 136 of file Particle.f90.

◆ put()

procedure, public particlemodule::particlestoretype::put

Definition at line 139 of file Particle.f90.

◆ resize()

procedure, public particlemodule::particlestoretype::resize

Definition at line 137 of file Particle.f90.

Member Data Documentation

◆ extend

integer(lgp), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::extend

Definition at line 132 of file Particle.f90.

132 integer(LGP), dimension(:), pointer, public, contiguous :: extend !< whether to extend tracking beyond the end of the simulation

◆ extol

real(dp), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::extol

Definition at line 131 of file Particle.f90.

131 real(DP), dimension(:), pointer, public, contiguous :: extol !< tolerance for iterative solution of particle exit location and time in generalized Pollock's method

◆ iboundary

integer(i4b), dimension(:, :), pointer, public, contiguous particlemodule::particlestoretype::iboundary

Definition at line 117 of file Particle.f90.

117 integer(I4B), dimension(:, :), pointer, public, contiguous :: iboundary !< array of indices for tracking domain boundaries

◆ icu

integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::icu

Definition at line 118 of file Particle.f90.

118 integer(I4B), dimension(:), pointer, public, contiguous :: icu !< cell number (user)

◆ icycwin

integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::icycwin

Definition at line 133 of file Particle.f90.

133 integer(I4B), dimension(:), pointer, public, contiguous :: icycwin !< cycle detection window size

◆ idrymeth

integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::idrymeth

Definition at line 114 of file Particle.f90.

114 integer(I4B), dimension(:), pointer, public, contiguous :: idrymeth !< stop in dry cells

◆ iexmeth

integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::iexmeth

Definition at line 130 of file Particle.f90.

130 integer(I4B), dimension(:), pointer, public, contiguous :: iexmeth !< method for iterative solution of particle exit location and time in generalized Pollock's method

◆ ifrctrn

integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::ifrctrn

Definition at line 129 of file Particle.f90.

129 integer(I4B), dimension(:), pointer, public, contiguous :: ifrctrn !< force ternary method

◆ ilay

integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::ilay

Definition at line 119 of file Particle.f90.

119 integer(I4B), dimension(:), pointer, public, contiguous :: ilay !< layer

◆ imdl

integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::imdl

Definition at line 108 of file Particle.f90.

108 integer(I4B), dimension(:), pointer, public, contiguous :: imdl !< index of model particle originated in

◆ iprp

integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::iprp

Definition at line 109 of file Particle.f90.

109 integer(I4B), dimension(:), pointer, public, contiguous :: iprp !< index of release package the particle originated in

◆ irpt

integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::irpt

Definition at line 110 of file Particle.f90.

110 integer(I4B), dimension(:), pointer, public, contiguous :: irpt !< index of release point in the particle release package the particle originated in

◆ istatus

integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::istatus

Definition at line 122 of file Particle.f90.

122 integer(I4B), dimension(:), pointer, public, contiguous :: istatus !< particle status

◆ istopweaksink

integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::istopweaksink

Definition at line 112 of file Particle.f90.

112 integer(I4B), dimension(:), pointer, public, contiguous :: istopweaksink !< weak sink option: 0 = do not stop, 1 = stop

◆ istopzone

integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::istopzone

Definition at line 113 of file Particle.f90.

113 integer(I4B), dimension(:), pointer, public, contiguous :: istopzone !< stop zone number

◆ itrdomain

integer(i4b), dimension(:, :), pointer, public, contiguous particlemodule::particlestoretype::itrdomain

Definition at line 116 of file Particle.f90.

116 integer(I4B), dimension(:, :), pointer, public, contiguous :: itrdomain !< array of indices for domains in the tracking domain hierarchy

◆ izone

integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::izone

Definition at line 120 of file Particle.f90.

120 integer(I4B), dimension(:), pointer, public, contiguous :: izone !< current zone number

◆ izp

integer(i4b), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::izp

Definition at line 121 of file Particle.f90.

121 integer(I4B), dimension(:), pointer, public, contiguous :: izp !< previous zone number

◆ name

character(len=lenboundname), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::name

Definition at line 107 of file Particle.f90.

107 character(len=LENBOUNDNAME), dimension(:), pointer, public, contiguous :: name !< optional particle label

◆ trelease

real(dp), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::trelease

Definition at line 126 of file Particle.f90.

126 real(DP), dimension(:), pointer, public, contiguous :: trelease !< particle release time

◆ tstop

real(dp), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::tstop

Definition at line 127 of file Particle.f90.

127 real(DP), dimension(:), pointer, public, contiguous :: tstop !< particle stop time

◆ ttrack

real(dp), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::ttrack

Definition at line 128 of file Particle.f90.

128 real(DP), dimension(:), pointer, public, contiguous :: ttrack !< current tracking time

◆ x

real(dp), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::x

Definition at line 123 of file Particle.f90.

123 real(DP), dimension(:), pointer, public, contiguous :: x !< model x coord of particle

◆ y

real(dp), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::y

Definition at line 124 of file Particle.f90.

124 real(DP), dimension(:), pointer, public, contiguous :: y !< model y coord of particle

◆ z

real(dp), dimension(:), pointer, public, contiguous particlemodule::particlestoretype::z

Definition at line 125 of file Particle.f90.

125 real(DP), dimension(:), pointer, public, contiguous :: z !< model z coord of particle

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

/home/runner/work/modflow6/modflow6/src/Solution/ParticleTracker/Particle/Particle.f90

Public Member Functions

Public Attributes