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...
enum	{   release = 0 , exit = 1 , timestep = 2 , terminate = 3 ,   weaksink = 4 , usertime = 5 }
	Particle event 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	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...

Variables
integer, parameter	max_level = 4
	Tracking "levels" (1: model, 2: cell, 3: subcell). A level identifies the domain through which a tracking method is responsible for moving a particle. Methods each operate on a particular level, delegating among more methods as appropriate for finer-grained levels. 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 31 of file Particle.f90.

anonymous enum

anonymous enum

A number of events may occur to particles, each of which may (or may not) be of interest to the user. The user selects among events to be reported. A corresponding event code is reported with each record to identify the record's cause.

Records may be identical except for their event code, reflecting the fact that multiple events of interest may occur at any given moment.

Enumerator
release	particle was released
exit	particle exited a cell
timestep	time step ended
terminate	particle terminated
weaksink	particle entered a weak sink cell
usertime	user-specified tracking time

Definition at line 53 of file Particle.f90.

Function/Subroutine Documentation

create_particle()

subroutine particlemodule::create_particle

(

type(particletype), pointer

particle

)

Definition at line 163 of file Particle.f90.

    type(ParticleType), pointer :: particle !< particle
    allocate (particle)
    allocate (particle%idomain(max_level))
    allocate (particle%iboundary(max_level))

create_particle_store()

subroutine particlemodule::create_particle_store	(	type(particlestoretype), pointer	store,
		integer(i4b), intent(in)	np,
		character(*), intent(in)	mempath
	)

Parameters

[in]	np	number of particles
[in]	mempath	path to memory

Definition at line 171 of file Particle.f90.

    type(ParticleStoreType), pointer :: store !< store
    integer(I4B), intent(in) :: np !< number of particles
    character(*), intent(in) :: mempath !< path to memory
 
    allocate (store)
    call mem_allocate(store%imdl, np, 'PLIMDL', mempath)
    call mem_allocate(store%irpt, np, 'PLIRPT', mempath)
    call mem_allocate(store%iprp, np, 'PLIPRP', mempath)
    call mem_allocate(store%name, lenboundname, np, 'PLNAME', mempath)
    call mem_allocate(store%icu, np, 'PLICU', mempath)
    call mem_allocate(store%ilay, np, 'PLILAY', mempath)
    call mem_allocate(store%izone, np, 'PLIZONE', mempath)
    call mem_allocate(store%izp, np, 'PLIZP', mempath)
    call mem_allocate(store%istatus, np, 'PLISTATUS', mempath)
    call mem_allocate(store%x, np, 'PLX', mempath)
    call mem_allocate(store%y, np, 'PLY', mempath)
    call mem_allocate(store%z, np, 'PLZ', mempath)
    call mem_allocate(store%trelease, np, 'PLTRELEASE', mempath)
    call mem_allocate(store%tstop, np, 'PLTSTOP', mempath)
    call mem_allocate(store%ttrack, np, 'PLTTRACK', mempath)
    call mem_allocate(store%istopweaksink, np, 'PLISTOPWEAKSINK', mempath)
    call mem_allocate(store%istopzone, np, 'PLISTOPZONE', mempath)
    call mem_allocate(store%idrymeth, np, 'PLIDRYMETH', mempath)
    call mem_allocate(store%ifrctrn, np, 'PLIFRCTRN', mempath)
    call mem_allocate(store%iexmeth, np, 'PLIEXMETH', mempath)
    call mem_allocate(store%extol, np, 'PLEXTOL', mempath)
    call mem_allocate(store%extend, np, 'PLIEXTEND', mempath)
    call mem_allocate(store%idomain, np, max_level, 'PLIDOMAIN', mempath)
    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]	this	store
[in]	mempath	path to memory

Definition at line 204 of file Particle.f90.

    class(ParticleStoreType), intent(inout) :: this !< store
    character(*), intent(in) :: mempath !< path to memory
 
    call mem_deallocate(this%imdl, 'PLIMDL', mempath)
    call mem_deallocate(this%iprp, 'PLIPRP', mempath)
    call mem_deallocate(this%irpt, 'PLIRPT', mempath)
    call mem_deallocate(this%name, 'PLNAME', mempath)
    call mem_deallocate(this%icu, 'PLICU', mempath)
    call mem_deallocate(this%ilay, 'PLILAY', mempath)
    call mem_deallocate(this%izone, 'PLIZONE', mempath)
    call mem_deallocate(this%izp, 'PLIZP', mempath)
    call mem_deallocate(this%istatus, 'PLISTATUS', mempath)
    call mem_deallocate(this%x, 'PLX', mempath)
    call mem_deallocate(this%y, 'PLY', mempath)
    call mem_deallocate(this%z, 'PLZ', mempath)
    call mem_deallocate(this%trelease, 'PLTRELEASE', mempath)
    call mem_deallocate(this%tstop, 'PLTSTOP', mempath)
    call mem_deallocate(this%ttrack, 'PLTTRACK', mempath)
    call mem_deallocate(this%istopweaksink, 'PLISTOPWEAKSINK', mempath)
    call mem_deallocate(this%istopzone, 'PLISTOPZONE', mempath)
    call mem_deallocate(this%idrymeth, 'PLIDRYMETH', mempath)
    call mem_deallocate(this%ifrctrn, 'PLIFRCTRN', mempath)
    call mem_deallocate(this%iexmeth, 'PLIEXMETH', mempath)
    call mem_deallocate(this%extol, 'PLEXTOL', mempath)
    call mem_deallocate(this%extend, 'PLIEXTEND', mempath)
    call mem_deallocate(this%idomain, 'PLIDOMAIN', mempath)
    call mem_deallocate(this%iboundary, 'PLIBOUNDARY', mempath)

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]	this	particle store
[in]	imdl	index of model particle originated in
[in]	iprp	index of particle release package particle originated in
[in]	ip	index into the particle list

Definition at line 273 of file Particle.f90.

    class(ParticleStoreType), intent(inout) :: this !< particle store
    class(ParticleType), intent(inout) :: particle !< particle
    integer(I4B), intent(in) :: imdl !< index of model particle originated in
    integer(I4B), intent(in) :: iprp !< index of particle release package particle originated in
    integer(I4B), intent(in) :: ip !< index into the particle list
 
    call particle%reset_transform()
    particle%imdl = imdl
    particle%iprp = iprp
    particle%irpt = this%irpt(ip)
    particle%ip = ip
    particle%name = this%name(ip)
    particle%istopweaksink = this%istopweaksink(ip)
    particle%istopzone = this%istopzone(ip)
    particle%idrymeth = this%idrymeth(ip)
    particle%icp = 0
    particle%icu = this%icu(ip)
    particle%ilay = this%ilay(ip)
    particle%izone = this%izone(ip)
    particle%izp = this%izp(ip)
    particle%istatus = this%istatus(ip)
    particle%x = this%x(ip)
    particle%y = this%y(ip)
    particle%z = this%z(ip)
    particle%trelease = this%trelease(ip)
    particle%tstop = this%tstop(ip)
    particle%ttrack = this%ttrack(ip)
    particle%advancing = .true.
    particle%idomain(1:max_level) = &
      this%idomain(ip, 1:max_level)
    particle%idomain(1) = imdl
    particle%iboundary(1:max_level) = &
      this%iboundary(ip, 1:max_level)
    particle%ifrctrn = this%ifrctrn(ip)
    particle%iexmeth = this%iexmeth(ip)
    particle%extol = this%extol(ip)
    particle%iextend = this%extend(ip)

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]	this	particle
[out]	x	x coordinate
[out]	y	y coordinate
[out]	z	z coordinate

Definition at line 397 of file Particle.f90.

    use geomutilmodule, only: transform, compose
    class(ParticleType), intent(in) :: this !< particle
    real(DP), intent(out) :: x !< x coordinate
    real(DP), intent(out) :: y !< y coordinate
    real(DP), intent(out) :: z !< z coordinate
 
    if (this%transformed) then
      call transform(this%x, this%y, this%z, x, y, z, &
                     this%xorigin, this%yorigin, this%zorigin, &
                     this%sinrot, this%cosrot, invert=.true.)
    else
      x = this%x
      y = this%y
      z = this%z
    end if

Here is the call graph for this function:

num_stored()

integer function particlemodule::num_stored

(

class(particlestoretype)

this

)

Definition at line 416 of file Particle.f90.

    class(ParticleStoreType) :: this
    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]	this	particle storage
[in]	ip	particle index

Definition at line 314 of file Particle.f90.

    class(ParticleStoreType), intent(inout) :: this !< particle storage
    class(ParticleType), intent(in) :: particle !< particle
    integer(I4B), intent(in) :: ip !< particle index
 
    this%imdl(ip) = particle%imdl
    this%iprp(ip) = particle%iprp
    this%irpt(ip) = particle%irpt
    this%name(ip) = particle%name
    this%istopweaksink(ip) = particle%istopweaksink
    this%istopzone(ip) = particle%istopzone
    this%idrymeth(ip) = particle%idrymeth
    this%icu(ip) = particle%icu
    this%ilay(ip) = particle%ilay
    this%izone(ip) = particle%izone
    this%izp(ip) = particle%izp
    this%istatus(ip) = particle%istatus
    this%x(ip) = particle%x
    this%y(ip) = particle%y
    this%z(ip) = particle%z
    this%trelease(ip) = particle%trelease
    this%tstop(ip) = particle%tstop
    this%ttrack(ip) = particle%ttrack
    this%idomain( &
      ip, &
      1:max_level) = &
      particle%idomain(1:max_level)
    this%iboundary( &
      ip, &
      1:max_level) = &
      particle%iboundary(1:max_level)
    this%ifrctrn(ip) = particle%ifrctrn
    this%iexmeth(ip) = particle%iexmeth
    this%extol(ip) = particle%extol
    this%extend(ip) = particle%iextend

reset_transform()

subroutine particlemodule::reset_transform

(

class(particletype), intent(inout)

this

)

Parameters

[in,out]

this

particle

Definition at line 382 of file Particle.f90.

    class(ParticleType), intent(inout) :: this !< particle
 
    this%xorigin = dzero
    this%yorigin = dzero
    this%zorigin = dzero
    this%sinrot = dzero
    this%cosrot = done
    this%cosrot = done
    this%transformed = .false.

resize()

subroutine particlemodule::resize	(	class(particlestoretype), intent(inout)	this,
		integer(i4b), intent(in)	np,
		character(*), intent(in)	mempath
	)

Parameters

[in,out]	this	particle store
[in]	np	number of particles
[in]	mempath	path to memory

Definition at line 235 of file Particle.f90.

    ! dummy
    class(ParticleStoreType), intent(inout) :: this !< particle store
    integer(I4B), intent(in) :: np !< number of particles
    character(*), intent(in) :: mempath !< path to memory
 
    ! resize arrays
    call mem_reallocate(this%imdl, np, 'PLIMDL', mempath)
    call mem_reallocate(this%iprp, np, 'PLIPRP', mempath)
    call mem_reallocate(this%irpt, np, 'PLIRPT', mempath)
    call mem_reallocate(this%name, lenboundname, np, 'PLNAME', mempath)
    call mem_reallocate(this%icu, np, 'PLICU', mempath)
    call mem_reallocate(this%ilay, np, 'PLILAY', mempath)
    call mem_reallocate(this%izone, np, 'PLIZONE', mempath)
    call mem_reallocate(this%izp, np, 'PLIZP', mempath)
    call mem_reallocate(this%istatus, np, 'PLISTATUS', mempath)
    call mem_reallocate(this%x, np, 'PLX', mempath)
    call mem_reallocate(this%y, np, 'PLY', mempath)
    call mem_reallocate(this%z, np, 'PLZ', mempath)
    call mem_reallocate(this%trelease, np, 'PLTRELEASE', mempath)
    call mem_reallocate(this%tstop, np, 'PLTSTOP', mempath)
    call mem_reallocate(this%ttrack, np, 'PLTTRACK', mempath)
    call mem_reallocate(this%istopweaksink, np, 'PLISTOPWEAKSINK', mempath)
    call mem_reallocate(this%istopzone, np, 'PLISTOPZONE', mempath)
    call mem_reallocate(this%idrymeth, np, 'PLIDRYMETH', mempath)
    call mem_reallocate(this%ifrctrn, np, 'PLIFRCTRN', mempath)
    call mem_reallocate(this%iexmeth, np, 'PLIEXMETH', mempath)
    call mem_reallocate(this%extol, np, 'PLEXTOL', mempath)
    call mem_reallocate(this%extend, np, 'PLIEXTEND', mempath)
    call mem_reallocate(this%idomain, np, max_level, 'PLIDOMAIN', mempath)
    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]	this	particle
[in]	xorigin	x coordinate of origin
[in]	yorigin	y coordinate of origin
[in]	zorigin	z coordinate of origin
[in]	sinrot	sine of rotation angle
[in]	cosrot	cosine of rotation angle
[in]	invert	whether to invert

Definition at line 357 of file Particle.f90.

    use geomutilmodule, only: transform, compose
    class(ParticleType), intent(inout) :: this !< particle
    real(DP), intent(in), optional :: xorigin !< x coordinate of origin
    real(DP), intent(in), optional :: yorigin !< y coordinate of origin
    real(DP), intent(in), optional :: zorigin !< z coordinate of origin
    real(DP), intent(in), optional :: sinrot !< sine of rotation angle
    real(DP), intent(in), optional :: cosrot !< cosine of rotation angle
    logical(LGP), intent(in), optional :: invert !< whether to invert
 
    call transform(this%x, this%y, this%z, &
                   this%x, this%y, this%z, &
                   xorigin, yorigin, zorigin, &
                   sinrot, cosrot, invert)
 
    call compose(this%xorigin, this%yorigin, this%zorigin, &
                 this%sinrot, this%cosrot, &
                 xorigin, yorigin, zorigin, &
                 sinrot, cosrot, invert)
 
    this%transformed = .true.

Here is the call graph for this function:

Variable Documentation

max_level

integer, parameter particlemodule::max_level = 4

Definition at line 15 of file Particle.f90.

  integer, parameter :: MAX_LEVEL = 4