particlemodule Module Reference

Data Types
type	particletype
	A particle tracked by the PRT model. More...
type	particlestoretype
	Structure of arrays to store particles. More...

Functions/Subroutines
subroutine, public	create_particle (particle)
	Create a new particle. More...
subroutine	destroy_particle (this)
	Destroy a particle. More...
subroutine, public	create_particle_store (this, np, mempath)
	Create a new particle store. More...
subroutine	destroy_store (this, mempath)
	Deallocate particle arrays. More...
subroutine	resize_store (this, np, mempath)
	Reallocate particle arrays. More...
subroutine	load_from_store (this, store, imdl, iprp, ip)
	Initialize particle from particle list. More...
subroutine	load_from_particle (this, particle, ip)
	Update particle store from particle. More...
subroutine	transform_coords (this, xorigin, yorigin, zorigin, sinrot, cosrot, invert, reset)
	Apply the given global-to-local transformation to the particle. More...
subroutine	get_model_coords (this, x, y, z)
	Return the particle's model (global) coordinates. More...
pure character(len=lenmempath) function, public	get_particle_id (particle)
	Return the particle's composite ID. More...

Variables
integer, parameter, public	levelmin = 0
integer, parameter, public	levelmax = 4

Function/Subroutine Documentation

create_particle()

subroutine, public particlemodule::create_particle

(

type(particletype), pointer

particle

)

Definition at line 102 of file Particle.f90.

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

Here is the caller graph for this function:

create_particle_store()

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

Parameters

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

Definition at line 117 of file Particle.f90.

    type(ParticleStoreType), pointer :: this !< store
    integer(I4B), intent(in) :: np !< number of particles
    character(*), intent(in) :: mempath !< path to memory
 
    allocate (this)
    call mem_allocate(this%imdl, np, 'PLIMDL', mempath)
    call mem_allocate(this%irpt, np, 'PLIRPT', mempath)
    call mem_allocate(this%iprp, np, 'PLIPRP', mempath)
    call mem_allocate(this%name, lenboundname, np, 'PLNAME', mempath)
    ! -- kluge todo: update mem_allocate to allow custom range of indices?
    !    e.g. here we want to allocate 0-4 for trackdomain levels, not 1-5
    allocate (this%idomain(np, levelmin:levelmax))
    allocate (this%iboundary(np, levelmin:levelmax))
    call mem_allocate(this%icu, np, 'PLICU', mempath)
    call mem_allocate(this%ilay, np, 'PLILAY', mempath)
    call mem_allocate(this%izone, np, 'PLIZONE', mempath)
    call mem_allocate(this%istatus, np, 'PLISTATUS', mempath)
    call mem_allocate(this%x, np, 'PLX', mempath)
    call mem_allocate(this%y, np, 'PLY', mempath)
    call mem_allocate(this%z, np, 'PLZ', mempath)
    call mem_allocate(this%trelease, np, 'PLTRELEASE', mempath)
    call mem_allocate(this%tstop, np, 'PLTSTOP', mempath)
    call mem_allocate(this%ttrack, np, 'PLTTRACK', mempath)
    call mem_allocate(this%istopweaksink, np, 'PLISTOPWEAKSINK', mempath)
    call mem_allocate(this%istopzone, np, 'PLISTOPZONE', mempath)

Here is the caller graph for this function:

destroy_particle()

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

private

Parameters

[in,out]

this

particle

Definition at line 110 of file Particle.f90.

    class(ParticleType), intent(inout) :: this !< particle
    deallocate (this%idomain)
    deallocate (this%iboundary)

destroy_store()

subroutine particlemodule::destroy_store ( class(particlestoretype), intent(inout)  this, character(*), intent(in)  mempath  )

private

Parameters

[in,out]	this	store
[in]	mempath	path to memory

Definition at line 146 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)
    deallocate (this%idomain)
    deallocate (this%iboundary)
    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%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)

get_model_coords()

subroutine particlemodule::get_model_coords	(	class(particletype), intent(inout)	this,
		real(dp), intent(out)	x,
		real(dp), intent(out)	y,
		real(dp), intent(out)	z
	)

Parameters

[in,out]	this	particle
[out]	x	x coordinate
[out]	y	y coordinate
[out]	z	z coordinate

Definition at line 328 of file Particle.f90.

    use geomutilmodule, only: transform, compose
    class(ParticleType), intent(inout) :: 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
      ! -- Transform back from local to model coordinates
      call transform(this%x, this%y, this%z, x, y, z, &
                     this%xorigin, this%yorigin, this%zorigin, &
                     this%sinrot, this%cosrot, .true.)
    else
      ! -- Already in model coordinates
      x = this%x
      y = this%y
      z = this%z
    end if

Here is the call graph for this function:

get_particle_id()

pure character(len=lenmempath) function, public particlemodule::get_particle_id

(

class(particletype), intent(in)

particle

)

Particles are uniquely identified by model index, PRP index, location index, and release time.

Returns

particle id

Definition at line 353 of file Particle.f90.

    class(ParticleType), intent(in) :: particle !< particle
    character(len=LENMEMPATH) :: id !< particle id
 
    write (id, '(I0,"-",I0,"-",I0,"-",F0.0)') &
      particle%imdl, particle%iprp, particle%irpt, particle%trelease

Here is the caller graph for this function:

load_from_particle()

subroutine particlemodule::load_from_particle ( class(particlestoretype), intent(inout)  this, type(particletype), intent(in)  particle, integer(i4b), intent(in)  ip  )

private

Parameters

[in,out]	this	particle storage
[in]	ip	particle index

Definition at line 248 of file Particle.f90.

    class(ParticleStoreType), intent(inout) :: this !< particle storage
    type(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%icu(ip) = particle%icu
    this%ilay(ip) = particle%ilay
    this%izone(ip) = particle%izone
    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, &
      levelmin:levelmax) = &
      particle%idomain(levelmin:levelmax)
    this%iboundary( &
      ip, &
      levelmin:levelmax) = &
      particle%iboundary(levelmin:levelmax)

load_from_store()

subroutine particlemodule::load_from_store	(	class(particletype), intent(inout)	this,
		type(particlestoretype), intent(in)	store,
		integer(i4b), intent(in)	imdl,
		integer(i4b), intent(in)	iprp,
		integer(i4b), intent(in)	ip
	)

This routine is used to initialize a particle from the list so it can be tracked by prt_solve. The particle's advancing flag is set and local coordinate transformations are reset.

Parameters

[in,out]	this	particle
[in]	store	particle storage
[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 214 of file Particle.f90.

    class(ParticleType), intent(inout) :: this !< particle
    type(ParticleStoreType), intent(in) :: store !< particle storage
    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 this%transform(reset=.true.)
    this%imdl = imdl
    this%iprp = iprp
    this%irpt = store%irpt(ip)
    this%ip = ip
    this%name = store%name(ip)
    this%istopweaksink = store%istopweaksink(ip)
    this%istopzone = store%istopzone(ip)
    this%icu = store%icu(ip)
    this%ilay = store%ilay(ip)
    this%izone = store%izone(ip)
    this%istatus = store%istatus(ip)
    this%x = store%x(ip)
    this%y = store%y(ip)
    this%z = store%z(ip)
    this%trelease = store%trelease(ip)
    this%tstop = store%tstop(ip)
    this%ttrack = store%ttrack(ip)
    this%advancing = .true.
    this%idomain(levelmin:levelmax) = &
      store%idomain(ip, levelmin:levelmax)
    this%idomain(1) = imdl
    this%iboundary(levelmin:levelmax) = &
      store%iboundary(ip, levelmin:levelmax)

resize_store()

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

private

Parameters

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

Definition at line 171 of file Particle.f90.

    ! -- modules
    use arrayhandlersmodule, only: expandarray2d
    ! -- dummy
    class(ParticleStoreType), intent(inout) :: this !< particle store
    integer(I4B), intent(in) :: np !< number of particles
    character(*), intent(in) :: mempath !< path to memory
 
    ! resize 1D 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%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)
    ! resize first dimension of 2D arrays
    ! todo: memory manager support?
    call expandarray2d( &
      this%idomain, &
      np - size(this%idomain, 1), &
      0)
    call expandarray2d( &
      this%iboundary, &
      np - size(this%iboundary, 1), &
      0)

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, logical(lgp), intent(in), optional  reset  )

private

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
[in]	reset	whether to reset

Definition at line 280 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
    logical(LGP), intent(in), optional :: reset !< whether to reset
 
    ! -- reset if requested
    if (present(reset)) then
      if (reset) then
        this%xorigin = dzero
        this%yorigin = dzero
        this%zorigin = dzero
        this%sinrot = dzero
        this%cosrot = done
        this%cosrot = done
        this%transformed = .false.
        return
      end if
    end if
 
    ! -- Otherwise, transform coordinates
    call transform(this%x, this%y, this%z, &
                   this%x, this%y, this%z, &
                   xorigin, yorigin, zorigin, &
                   sinrot, cosrot, invert)
 
    ! -- Modify transformation from model coordinates to particle's new
    ! -- local coordinates by incorporating this latest transformation
    call compose(this%xorigin, this%yorigin, this%zorigin, &
                 this%sinrot, this%cosrot, &
                 xorigin, yorigin, zorigin, &
                 sinrot, cosrot, invert)
 
    ! -- Set isTransformed flag to true. Note that there is no check
    ! -- to see whether the modification brings the coordinates back
    ! -- to model coordinates (in which case the origin would be very
    ! -- close to zero and sinrot and cosrot would be very close to 0.
    ! -- and 1., respectively, allowing for roundoff error).
    this%transformed = .true.

Here is the call graph for this function:

Variable Documentation

levelmax

integer, parameter, public particlemodule::levelmax = 4

Definition at line 15 of file Particle.f90.

levelmin

integer, parameter, public particlemodule::levelmin = 0

Definition at line 15 of file Particle.f90.

  integer, parameter, public :: levelmin = 0, levelmax = 4