methodcellpasstobotmodule Module Reference

Data Types
type	methodcellpasstobottype

Functions/Subroutines
subroutine, public	create_method_cell_ptb (method)
	Create a new pass-to-bottom tracking method. More...
subroutine	deallocate (this)
	Deallocate the pass-to-bottom tracking method. More...
subroutine	apply_ptb (this, particle, tmax)
	Pass particle vertically and instantaneously to the cell bottom. More...

Function/Subroutine Documentation

apply_ptb()

subroutine methodcellpasstobotmodule::apply_ptb ( class(methodcellpasstobottype), intent(inout)  this, type(particletype), intent(inout), pointer  particle, real(dp), intent(in)  tmax  )

private

Definition at line 45 of file MethodCellPassToBot.f90.

    use particlemodule, only: term_no_exits
    ! dummy
    class(MethodCellPassToBotType), intent(inout) :: this
    type(ParticleType), pointer, intent(inout) :: particle
    real(DP), intent(in) :: tmax
    ! local
    integer(I4B) :: nlay
 
    ! Check termination/reporting conditions
    call this%check(particle, this%cell%defn, tmax)
    if (.not. particle%advancing) return
 
    ! Pass to bottom face
    particle%z = this%cell%defn%bot
    particle%iboundary(2) = this%cell%defn%npolyverts + 2
 
    ! Terminate if in bottom layer
    select type (dis => this%fmi%dis)
    type is (distype)
      nlay = dis%nlay
    type is (disvtype)
      nlay = dis%nlay
    end select
    if (particle%ilay == nlay) then
      particle%advancing = .false.
      particle%istatus = term_no_exits
      call this%save(particle, reason=3)
    end if
 
    ! Save record
    call this%save(particle, reason=1)

create_method_cell_ptb()

subroutine, public methodcellpasstobotmodule::create_method_cell_ptb

(

type(methodcellpasstobottype), pointer

method

)

Definition at line 30 of file MethodCellPassToBot.f90.

    type(MethodCellPassToBotType), pointer :: method
    allocate (method)
    allocate (method%name)
    method%name = "passtobottom"
    method%delegates = .false.

Here is the caller graph for this function:

deallocate()

subroutine methodcellpasstobotmodule::deallocate ( class(methodcellpasstobottype), intent(inout)  this )

private

Definition at line 39 of file MethodCellPassToBot.f90.

    class(MethodCellPassToBotType), intent(inout) :: this
    deallocate (this%name)