methodcellpollockmodule Module Reference

Data Types
type	methodcellpollocktype

Functions/Subroutines
procedure subroutine, public	create_method_cell_pollock (method)
	Create a tracking method. More...
subroutine	destroy_mcp (this)
	Destroy the tracking method. More...
subroutine	load_mcp (this, particle, next_level, submethod)
	Load subcell tracking method. More...
subroutine	pass_mcp (this, particle)
	Having exited the lone subcell, pass the particle to the cell face In this case the lone subcell is the cell. More...
subroutine	apply_mcp (this, particle, tmax)
	Apply Pollock's method to a rectangular cell. More...
subroutine	load_subcell (this, particle, subcell)
	Loads the lone rectangular subcell from the rectangular cell. More...

Function/Subroutine Documentation

apply_mcp()

subroutine methodcellpollockmodule::apply_mcp ( class(methodcellpollocktype), intent(inout)  this, type(particletype), intent(inout), pointer  particle, real(dp), intent(in)  tmax  )

private

Definition at line 119 of file MethodCellPollock.f90.

    ! -- dummy
    class(MethodCellPollockType), intent(inout) :: this
    type(ParticleType), pointer, intent(inout) :: particle
    real(DP), intent(in) :: tmax
    ! -- local
    real(DP) :: xOrigin
    real(DP) :: yOrigin
    real(DP) :: zOrigin
    real(DP) :: sinrot
    real(DP) :: cosrot
 
    select type (cell => this%cell)
    type is (cellrecttype)
      ! -- Update particle state, checking whether any reporting or
      ! -- termination conditions apply
      call this%update(particle, cell%defn)
 
      ! -- Return early if particle is done advancing
      if (.not. particle%advancing) return
 
      ! -- If the particle is above the top of the cell (which is presumed to
      ! -- represent a water table above the cell bottom), pass the particle
      ! -- vertically and instantaneously to the cell top elevation and save
      ! -- the particle state to output file(s).
      if (particle%z > cell%defn%top) then
        particle%z = cell%defn%top
        call this%save(particle, reason=1) ! reason=1: cell transition
      end if
 
      !  Transform particle location into local cell coordinates
      !  (translated and rotated but not scaled relative to model).
      !  Transform particle location back to model coordinates, then
      !  reset transformation and eliminate accumulated roundoff error.
      xorigin = cell%xOrigin
      yorigin = cell%yOrigin
      zorigin = cell%zOrigin
      sinrot = cell%sinrot
      cosrot = cell%cosrot
      call particle%transform(xorigin, yorigin, zorigin, &
                              sinrot, cosrot)
      call this%track(particle, 2, tmax)
      call particle%transform(xorigin, yorigin, zorigin, &
                              sinrot, cosrot, invert=.true.)
      call particle%transform(reset=.true.)
    end select

create_method_cell_pollock()

procedure subroutine, public methodcellpollockmodule::create_method_cell_pollock

(

type(methodcellpollocktype), pointer

method

)

Definition at line 30 of file MethodCellPollock.f90.

    ! -- dummy
    type(MethodCellPollockType), pointer :: method
    ! -- local
    type(CellRectType), pointer :: cell
    type(SubcellRectType), pointer :: subcell
 
    allocate (method)
    call create_cell_rect(cell)
    method%cell => cell
    method%type => method%cell%type
    method%delegates = .true.
    call create_subcell_rect(subcell)
    method%subcell => subcell

Here is the call graph for this function:

Here is the caller graph for this function:

destroy_mcp()

subroutine methodcellpollockmodule::destroy_mcp ( class(methodcellpollocktype), intent(inout)  this )

private

Definition at line 47 of file MethodCellPollock.f90.

    class(MethodCellPollockType), intent(inout) :: this
    deallocate (this%type)

load_mcp()

subroutine methodcellpollockmodule::load_mcp ( class(methodcellpollocktype), intent(inout)  this, type(particletype), intent(inout), pointer  particle, integer, intent(in)  next_level, class(methodtype), intent(inout), pointer  submethod  )

private

Definition at line 53 of file MethodCellPollock.f90.

    ! -- modules
    use subcellmodule, only: subcelltype
    ! -- dummy
    class(MethodCellPollockType), intent(inout) :: this
    type(ParticleType), pointer, intent(inout) :: particle
    integer, intent(in) :: next_level
    class(MethodType), pointer, intent(inout) :: submethod
 
    select type (subcell => this%subcell)
    type is (subcellrecttype)
      call this%load_subcell(particle, subcell)
    end select
    call method_subcell_plck%init( &
      cell=this%cell, &
      subcell=this%subcell, &
      trackfilectl=this%trackfilectl, &
      tracktimes=this%tracktimes)
    submethod => method_subcell_plck
    particle%idomain(next_level) = 1

load_subcell()

subroutine methodcellpollockmodule::load_subcell ( class(methodcellpollocktype), intent(inout)  this, type(particletype), intent(inout), pointer  particle, type(subcellrecttype), intent(inout)  subcell  )

private

Definition at line 168 of file MethodCellPollock.f90.

    ! -- dummy
    class(MethodCellPollockType), intent(inout) :: this
    type(ParticleType), pointer, intent(inout) :: particle
    type(SubcellRectType), intent(inout) :: subcell
 
    select type (cell => this%cell)
    type is (cellrecttype)
      ! -- Set subcell number to 1
      subcell%isubcell = 1
 
      ! -- Subcell calculations will be done in local subcell coordinates
      subcell%dx = cell%dx
      subcell%dy = cell%dy
      subcell%dz = cell%dz
      subcell%sinrot = dzero
      subcell%cosrot = done
      subcell%xOrigin = dzero
      subcell%yOrigin = dzero
      subcell%zOrigin = dzero
 
      ! -- Set subcell edge velocities
      subcell%vx1 = cell%vx1 ! cell velocities already account for retfactor and porosity
      subcell%vx2 = cell%vx2
      subcell%vy1 = cell%vy1
      subcell%vy2 = cell%vy2
      subcell%vz1 = cell%vz1
      subcell%vz2 = cell%vz2
    end select

pass_mcp()

subroutine methodcellpollockmodule::pass_mcp	(	class(methodcellpollocktype), intent(inout)	this,
		type(particletype), intent(inout), pointer	particle
	)

Definition at line 77 of file MethodCellPollock.f90.

    ! -- dummy
    class(MethodCellPollockType), intent(inout) :: this
    type(ParticleType), pointer, intent(inout) :: particle
    ! -- local
    integer(I4B) :: exitface
    integer(I4B) :: entryface
 
    exitface = particle%iboundary(3)
    ! -- Map subcell exit face to cell face
    select case (exitface) ! note: exitFace uses Dave's iface convention
    case (0)
      entryface = -1
    case (1)
      entryface = 1
    case (2)
      entryface = 3
    case (3)
      entryface = 4
    case (4)
      entryface = 2
    case (5)
      entryface = 6 ! note: inface=5 same as inface=1 due to wraparound
    case (6)
      entryface = 7
    end select
    if (entryface .eq. -1) then
      particle%iboundary(2) = 0
    else
      if ((entryface .ge. 1) .and. (entryface .le. 4)) then
        ! -- Account for local cell rotation
        select type (cell => this%cell)
        type is (cellrecttype)
          entryface = entryface + cell%ipvOrigin - 1
        end select
        if (entryface .gt. 4) entryface = entryface - 4
      end if
      particle%iboundary(2) = entryface
    end if