MODFLOW 6  version 6.7.0.dev3
USGS Modular Hydrologic Model
Data Types | Enumerations | Functions/Subroutines | Variables
particlemodule Module Reference

Data Types

type  particletype
 Particle tracked by the PRT model. More...
 
type  particlestoretype
 Structure of arrays to store particles. More...
 

Enumerations

enum  {
  active = 1 , term_boundary = 2 , term_weaksink = 3 , term_no_exits = 5 ,
  term_stopzone = 6 , term_inactive = 7 , term_unreleased = 8 , term_no_exits_sub = 9 ,
  term_timeout = 10
}
 Particle status enumeration. More...
 

Functions/Subroutines

subroutine create_particle (particle)
 Create a new particle. More...
 
subroutine create_particle_store (store, np, mempath)
 Allocate particle store. More...
 
subroutine destroy (this, mempath)
 Destroy particle store after use. More...
 
subroutine destroy_particle (particle)
 Destroy a particle after use. More...
 
subroutine resize (this, np, mempath)
 Reallocate particle storage to the given size. More...
 
subroutine get (this, particle, imdl, iprp, ip)
 Load a particle from the particle store. More...
 
subroutine put (this, particle, ip)
 Save a particle's state to the particle store. More...
 
subroutine transform_coords (this, xorigin, yorigin, zorigin, sinrot, cosrot, invert)
 Transform particle coordinates. More...
 
subroutine reset_transform (this)
 Reset particle coordinate transformation properties. More...
 
subroutine get_model_coords (this, x, y, z)
 Return the particle's model coordinates, inverting any applied transformation if needed. The particle's state is not altered. More...
 
integer function num_stored (this)
 Return the number of particles. More...
 
character(len=:) function, allocatable get_id (this)
 Get a string identifier for the particle. More...
 

Variables

integer, parameter max_level = 4
 Tracking "levels" defined in method modules. Currently only 3 used. More...
 

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Particles begin in status 1 (active) at release time. Status may only increase over time. Status values greater than one imply termination. A particle may terminate for several reasons, all mutually exclusive. A particle's final tracking status will always be greater than one.

Status codes 0-3 and 5-8 correspond directly to MODPATH 7 status codes. Code 4 does not apply to PRT because PRT does not distinguish forwards from backwards tracking. Status code 9 provides more specific, subcell- level information about a particle which terminates due to no outflow. Code 10 distinguishes particles which have "timed out" upon reaching a user-specified stop time or the end of the simulation.

Enumerator
active 
term_boundary 

terminated at a boundary face

term_weaksink 

terminated in a weak sink cell

term_no_exits 

terminated in a cell with no exit face

term_stopzone 

terminated in a cell with a stop zone number

term_inactive 

terminated in an inactive cell

term_unreleased 

terminated permanently unreleased

term_no_exits_sub 

terminated in a subcell with no exit face

term_timeout 

terminated at stop time or end of simulation

Definition at line 29 of file Particle.f90.

Function/Subroutine Documentation

◆ create_particle()

subroutine particlemodule::create_particle ( type(particletype), pointer  particle)

Definition at line 144 of file Particle.f90.

145  type(ParticleType), pointer :: particle !< particle
146  allocate (particle)
147  allocate (particle%history)
Here is the caller graph for this function:

◆ create_particle_store()

subroutine particlemodule::create_particle_store ( type(particlestoretype), pointer  store,
integer(i4b), intent(in)  np,
character(*), intent(in)  mempath 
)
Parameters
[in]npnumber of particles
[in]mempathpath to memory

Definition at line 151 of file Particle.f90.

152  type(ParticleStoreType), pointer :: store !< store
153  integer(I4B), intent(in) :: np !< number of particles
154  character(*), intent(in) :: mempath !< path to memory
155 
156  allocate (store)
157  call mem_allocate(store%imdl, np, 'PLIMDL', mempath)
158  call mem_allocate(store%irpt, np, 'PLIRPT', mempath)
159  call mem_allocate(store%iprp, np, 'PLIPRP', mempath)
160  call mem_allocate(store%name, lenboundname, np, 'PLNAME', mempath)
161  call mem_allocate(store%icu, np, 'PLICU', mempath)
162  call mem_allocate(store%ilay, np, 'PLILAY', mempath)
163  call mem_allocate(store%izone, np, 'PLIZONE', mempath)
164  call mem_allocate(store%istatus, np, 'PLISTATUS', mempath)
165  call mem_allocate(store%x, np, 'PLX', mempath)
166  call mem_allocate(store%y, np, 'PLY', mempath)
167  call mem_allocate(store%z, np, 'PLZ', mempath)
168  call mem_allocate(store%trelease, np, 'PLTRELEASE', mempath)
169  call mem_allocate(store%tstop, np, 'PLTSTOP', mempath)
170  call mem_allocate(store%ttrack, np, 'PLTTRACK', mempath)
171  call mem_allocate(store%istopweaksink, np, 'PLISTOPWEAKSINK', mempath)
172  call mem_allocate(store%istopzone, np, 'PLISTOPZONE', mempath)
173  call mem_allocate(store%idrymeth, np, 'PLIDRYMETH', mempath)
174  call mem_allocate(store%frctrn, np, 'PLFRCTRN', mempath)
175  call mem_allocate(store%iexmeth, np, 'PLIEXMETH', mempath)
176  call mem_allocate(store%extol, np, 'PLEXTOL', mempath)
177  call mem_allocate(store%extend, np, 'PLEXTEND', mempath)
178  call mem_allocate(store%icycwin, np, 'PLICYCWIN', mempath)
179  call mem_allocate(store%itrdomain, np, max_level, 'PLIDOMAIN', mempath)
180  call mem_allocate(store%iboundary, np, max_level, 'PLIBOUNDARY', mempath)
Here is the caller graph for this function:

◆ destroy()

subroutine particlemodule::destroy ( class(particlestoretype), intent(inout)  this,
character(*), intent(in)  mempath 
)
Parameters
[in,out]thisstore
[in]mempathpath to memory

Definition at line 184 of file Particle.f90.

185  class(ParticleStoreType), intent(inout) :: this !< store
186  character(*), intent(in) :: mempath !< path to memory
187 
188  call mem_deallocate(this%imdl, 'PLIMDL', mempath)
189  call mem_deallocate(this%iprp, 'PLIPRP', mempath)
190  call mem_deallocate(this%irpt, 'PLIRPT', mempath)
191  call mem_deallocate(this%name, 'PLNAME', mempath)
192  call mem_deallocate(this%icu, 'PLICU', mempath)
193  call mem_deallocate(this%ilay, 'PLILAY', mempath)
194  call mem_deallocate(this%izone, 'PLIZONE', mempath)
195  call mem_deallocate(this%istatus, 'PLISTATUS', mempath)
196  call mem_deallocate(this%x, 'PLX', mempath)
197  call mem_deallocate(this%y, 'PLY', mempath)
198  call mem_deallocate(this%z, 'PLZ', mempath)
199  call mem_deallocate(this%trelease, 'PLTRELEASE', mempath)
200  call mem_deallocate(this%tstop, 'PLTSTOP', mempath)
201  call mem_deallocate(this%ttrack, 'PLTTRACK', mempath)
202  call mem_deallocate(this%istopweaksink, 'PLISTOPWEAKSINK', mempath)
203  call mem_deallocate(this%istopzone, 'PLISTOPZONE', mempath)
204  call mem_deallocate(this%idrymeth, 'PLIDRYMETH', mempath)
205  call mem_deallocate(this%frctrn, 'PLFRCTRN', mempath)
206  call mem_deallocate(this%iexmeth, 'PLIEXMETH', mempath)
207  call mem_deallocate(this%extol, 'PLEXTOL', mempath)
208  call mem_deallocate(this%extend, 'PLEXTEND', mempath)
209  call mem_deallocate(this%icycwin, 'PLICYCWIN', mempath)
210  call mem_deallocate(this%itrdomain, 'PLIDOMAIN', mempath)
211  call mem_deallocate(this%iboundary, 'PLIBOUNDARY', mempath)

◆ destroy_particle()

subroutine particlemodule::destroy_particle ( class(particletype), intent(inout)  particle)

Definition at line 215 of file Particle.f90.

216  class(ParticleType), intent(inout) :: particle !< particle
217  deallocate (particle%history)

◆ get()

subroutine particlemodule::get ( class(particlestoretype), intent(inout)  this,
class(particletype), intent(inout)  particle,
integer(i4b), intent(in)  imdl,
integer(i4b), intent(in)  iprp,
integer(i4b), intent(in)  ip 
)

This routine is used to initialize a particle for tracking. The advancing flag and coordinate transformation are reset.

Parameters
[in,out]thisparticle store
[in]imdlindex of model particle originated in
[in]iprpindex of particle release package particle originated in
[in]ipindex into the particle list

Definition at line 259 of file Particle.f90.

260  class(ParticleStoreType), intent(inout) :: this !< particle store
261  class(ParticleType), intent(inout) :: particle !< particle
262  integer(I4B), intent(in) :: imdl !< index of model particle originated in
263  integer(I4B), intent(in) :: iprp !< index of particle release package particle originated in
264  integer(I4B), intent(in) :: ip !< index into the particle list
265 
266  call particle%reset_transform()
267  call particle%history%Clear()
268  particle%imdl = imdl
269  particle%iprp = iprp
270  particle%irpt = this%irpt(ip)
271  particle%ip = ip
272  particle%name = this%name(ip)
273  particle%istopweaksink = this%istopweaksink(ip)
274  particle%istopzone = this%istopzone(ip)
275  particle%idrymeth = this%idrymeth(ip)
276  particle%icu = this%icu(ip)
277  particle%ilay = this%ilay(ip)
278  particle%izone = this%izone(ip)
279  particle%istatus = this%istatus(ip)
280  particle%x = this%x(ip)
281  particle%y = this%y(ip)
282  particle%z = this%z(ip)
283  particle%trelease = this%trelease(ip)
284  particle%tstop = this%tstop(ip)
285  particle%ttrack = this%ttrack(ip)
286  particle%advancing = .true.
287  particle%itrdomain(1:max_level) = &
288  this%itrdomain(ip, 1:max_level)
289  particle%itrdomain(1) = imdl
290  particle%iboundary(1:max_level) = &
291  this%iboundary(ip, 1:max_level)
292  particle%frctrn = this%frctrn(ip)
293  particle%iexmeth = this%iexmeth(ip)
294  particle%extol = this%extol(ip)
295  particle%extend = this%extend(ip)
296  particle%icycwin = this%icycwin(ip)

◆ get_id()

character(len=:) function, allocatable particlemodule::get_id ( class(particletype), intent(in)  this)

Definition at line 408 of file Particle.f90.

409  class(ParticleType), intent(in) :: this
410  character(len=:), allocatable :: str
411  ! local
412  character(len=LINELENGTH) :: temp
413 
414  write (temp, '(I0,1a,I0,1a,I0,1a,G0)') &
415  this%imdl, this%iprp, this%irpt, this%trelease
416  str = trim(adjustl(temp))

◆ get_model_coords()

subroutine particlemodule::get_model_coords ( class(particletype), intent(in)  this,
real(dp), intent(out)  x,
real(dp), intent(out)  y,
real(dp), intent(out)  z 
)
Parameters
[in]thisparticle
[out]xx coordinate
[out]yy coordinate
[out]zz coordinate

Definition at line 383 of file Particle.f90.

384  use geomutilmodule, only: transform, compose
385  class(ParticleType), intent(in) :: this !< particle
386  real(DP), intent(out) :: x !< x coordinate
387  real(DP), intent(out) :: y !< y coordinate
388  real(DP), intent(out) :: z !< z coordinate
389 
390  if (this%transformed) then
391  call transform(this%x, this%y, this%z, x, y, z, &
392  this%xorigin, this%yorigin, this%zorigin, &
393  this%sinrot, this%cosrot, invert=.true.)
394  else
395  x = this%x
396  y = this%y
397  z = this%z
398  end if
geomutilmodule::transform
subroutine, public transform(xin, yin, zin, xout, yout, zout, xorigin, yorigin, zorigin, sinrot, cosrot, invert)
Apply a 3D translation and optional 2D rotation to coordinates.
Definition: GeomUtil.f90:183
geomutilmodule::compose
subroutine, public compose(xorigin, yorigin, zorigin, sinrot, cosrot, xorigin_new, yorigin_new, zorigin_new, sinrot_new, cosrot_new, invert)
Apply a 3D translation and 2D rotation to an existing transformation.
Definition: GeomUtil.f90:243
Here is the call graph for this function:

◆ num_stored()

integer function particlemodule::num_stored ( class(particlestoretype)  this)

Definition at line 402 of file Particle.f90.

403  class(ParticleStoreType) :: this
404  n = size(this%imdl)

◆ put()

subroutine particlemodule::put ( class(particlestoretype), intent(inout)  this,
class(particletype), intent(in)  particle,
integer(i4b), intent(in)  ip 
)
Parameters
[in,out]thisparticle storage
[in]ipparticle index

Definition at line 300 of file Particle.f90.

301  class(ParticleStoreType), intent(inout) :: this !< particle storage
302  class(ParticleType), intent(in) :: particle !< particle
303  integer(I4B), intent(in) :: ip !< particle index
304 
305  this%imdl(ip) = particle%imdl
306  this%iprp(ip) = particle%iprp
307  this%irpt(ip) = particle%irpt
308  this%name(ip) = particle%name
309  this%istopweaksink(ip) = particle%istopweaksink
310  this%istopzone(ip) = particle%istopzone
311  this%idrymeth(ip) = particle%idrymeth
312  this%icu(ip) = particle%icu
313  this%ilay(ip) = particle%ilay
314  this%izone(ip) = particle%izone
315  this%istatus(ip) = particle%istatus
316  this%x(ip) = particle%x
317  this%y(ip) = particle%y
318  this%z(ip) = particle%z
319  this%trelease(ip) = particle%trelease
320  this%tstop(ip) = particle%tstop
321  this%ttrack(ip) = particle%ttrack
322  this%itrdomain( &
323  ip, &
324  1:max_level) = &
325  particle%itrdomain(1:max_level)
326  this%iboundary( &
327  ip, &
328  1:max_level) = &
329  particle%iboundary(1:max_level)
330  this%frctrn(ip) = particle%frctrn
331  this%iexmeth(ip) = particle%iexmeth
332  this%extol(ip) = particle%extol
333  this%extend(ip) = particle%extend
334  this%icycwin(ip) = particle%icycwin

◆ reset_transform()

subroutine particlemodule::reset_transform ( class(particletype), intent(inout)  this)
Parameters
[in,out]thisparticle

Definition at line 368 of file Particle.f90.

369  class(ParticleType), intent(inout) :: this !< particle
370 
371  this%xorigin = dzero
372  this%yorigin = dzero
373  this%zorigin = dzero
374  this%sinrot = dzero
375  this%cosrot = done
376  this%cosrot = done
377  this%transformed = .false.

◆ resize()

subroutine particlemodule::resize ( class(particlestoretype), intent(inout)  this,
integer(i4b), intent(in)  np,
character(*), intent(in)  mempath 
)
Parameters
[in,out]thisparticle store
[in]npnumber of particles
[in]mempathpath to memory

Definition at line 221 of file Particle.f90.

222  ! dummy
223  class(ParticleStoreType), intent(inout) :: this !< particle store
224  integer(I4B), intent(in) :: np !< number of particles
225  character(*), intent(in) :: mempath !< path to memory
226 
227  ! resize arrays
228  call mem_reallocate(this%imdl, np, 'PLIMDL', mempath)
229  call mem_reallocate(this%iprp, np, 'PLIPRP', mempath)
230  call mem_reallocate(this%irpt, np, 'PLIRPT', mempath)
231  call mem_reallocate(this%name, lenboundname, np, 'PLNAME', mempath)
232  call mem_reallocate(this%icu, np, 'PLICU', mempath)
233  call mem_reallocate(this%ilay, np, 'PLILAY', mempath)
234  call mem_reallocate(this%izone, np, 'PLIZONE', mempath)
235  call mem_reallocate(this%istatus, np, 'PLISTATUS', mempath)
236  call mem_reallocate(this%x, np, 'PLX', mempath)
237  call mem_reallocate(this%y, np, 'PLY', mempath)
238  call mem_reallocate(this%z, np, 'PLZ', mempath)
239  call mem_reallocate(this%trelease, np, 'PLTRELEASE', mempath)
240  call mem_reallocate(this%tstop, np, 'PLTSTOP', mempath)
241  call mem_reallocate(this%ttrack, np, 'PLTTRACK', mempath)
242  call mem_reallocate(this%istopweaksink, np, 'PLISTOPWEAKSINK', mempath)
243  call mem_reallocate(this%istopzone, np, 'PLISTOPZONE', mempath)
244  call mem_reallocate(this%idrymeth, np, 'PLIDRYMETH', mempath)
245  call mem_reallocate(this%frctrn, np, 'PLFRCTRN', mempath)
246  call mem_reallocate(this%iexmeth, np, 'PLIEXMETH', mempath)
247  call mem_reallocate(this%extol, np, 'PLEXTOL', mempath)
248  call mem_reallocate(this%extend, np, 'PLEXTEND', mempath)
249  call mem_reallocate(this%icycwin, np, 'PLICYCWIN', mempath)
250  call mem_reallocate(this%itrdomain, np, max_level, 'PLIDOMAIN', mempath)
251  call mem_reallocate(this%iboundary, np, max_level, 'PLIBOUNDARY', mempath)

◆ transform_coords()

subroutine particlemodule::transform_coords ( class(particletype), intent(inout)  this,
real(dp), intent(in), optional  xorigin,
real(dp), intent(in), optional  yorigin,
real(dp), intent(in), optional  zorigin,
real(dp), intent(in), optional  sinrot,
real(dp), intent(in), optional  cosrot,
logical(lgp), intent(in), optional  invert 
)

Apply a translation and/or rotation to particle coordinates. No rescaling. It's also possible to invert a transformation. Be sure to reset the transformation after using it.

Parameters
[in,out]thisparticle
[in]xoriginx coordinate of origin
[in]yoriginy coordinate of origin
[in]zoriginz coordinate of origin
[in]sinrotsine of rotation angle
[in]cosrotcosine of rotation angle
[in]invertwhether to invert

Definition at line 343 of file Particle.f90.

345  use geomutilmodule, only: transform, compose
346  class(ParticleType), intent(inout) :: this !< particle
347  real(DP), intent(in), optional :: xorigin !< x coordinate of origin
348  real(DP), intent(in), optional :: yorigin !< y coordinate of origin
349  real(DP), intent(in), optional :: zorigin !< z coordinate of origin
350  real(DP), intent(in), optional :: sinrot !< sine of rotation angle
351  real(DP), intent(in), optional :: cosrot !< cosine of rotation angle
352  logical(LGP), intent(in), optional :: invert !< whether to invert
353 
354  call transform(this%x, this%y, this%z, &
355  this%x, this%y, this%z, &
356  xorigin, yorigin, zorigin, &
357  sinrot, cosrot, invert)
358 
359  call compose(this%xorigin, this%yorigin, this%zorigin, &
360  this%sinrot, this%cosrot, &
361  xorigin, yorigin, zorigin, &
362  sinrot, cosrot, invert)
363 
364  this%transformed = .true.
Here is the call graph for this function:

Variable Documentation

◆ max_level

integer, parameter particlemodule::max_level = 4

Definition at line 13 of file Particle.f90.

13  integer, parameter :: MAX_LEVEL = 4