particlereleaseschedulemodule Module Reference

Particle release scheduling.

Data Types
type	particlereleasescheduletype
	Particle release scheduling utility. More...

Functions/Subroutines
type(particlereleasescheduletype) function, pointer, public	create_release_schedule (tolerance)
	Create a new release schedule. More...
subroutine	destroy (this)
	Deallocate the release schedule. More...
subroutine	log (this, iout)
	Write the release schedule to the given output unit. More...
subroutine	schedule (this, trelease)
	Add a release time to the schedule. More...
subroutine	advance (this, lines)
	Refresh the schedule for the current time step. More...
logical function	any (this)
	Check if any releases are scheduled. More...
integer function	count (this)
	Return the number of releases scheduled. More...

Function/Subroutine Documentation

advance()

subroutine particlereleaseschedulemodule::advance ( class(particlereleasescheduletype), intent(inout)  this, character(len=linelength), dimension(:), intent(in), optional  lines  )

private

This involves several tasks: first, advance the time selection. Then, if period-block release setting lines are provided, reinitialize the time step selection for the given period. Finally, refresh the schedule array, deduplicating any times closer than the set tolerance.

This routine is idempotent.

Definition at line 108 of file ParticleReleaseSchedule.f90.

    use tdismodule, only: totimc, kstp, endofperiod
    class(ParticleReleaseScheduleType), intent(inout) :: this
    character(len=LINELENGTH), intent(in), optional :: lines(:)
    integer(I4B) :: it, i
    real(DP) :: tprevious
    real(DP) :: trelease
 
    ! Advance the time selection.
    call this%time_select%advance()
 
    ! Reinitialize the time step selection if new
    ! period-block release settings are provided.
    if (present(lines)) then
      call this%step_select%init()
      do i = 1, size(lines)
        call this%step_select%read(lines(i))
      end do
    end if
 
    ! Reinitialize the release time schedule.
    if (allocated(this%times)) deallocate (this%times)
    allocate (this%times(0))
 
    tprevious = -done
    trelease = -done
 
    ! Add a release time configured by period-block
    ! settings, if one is scheduled this time step.
    if (this%step_select%is_selected(kstp, endofperiod=endofperiod)) then
      trelease = totimc
      call this%schedule(trelease)
      tprevious = trelease
    end if
 
    ! Schedule explicitly specified release times, up
    ! to the configured tolerance of coincidence
    if (this%time_select%any()) then
      do it = this%time_select%selection(1), this%time_select%selection(2)
        trelease = this%time_select%times(it)
        if (tprevious >= dzero .and. is_close( &
            tprevious, &
            trelease, &
            atol=this%tolerance)) cycle
 
        call this%schedule(trelease)
        tprevious = trelease
      end do
    end if

Here is the call graph for this function:

any()

logical function particlereleaseschedulemodule::any

(

class(particlereleasescheduletype)

this

)

Note: be sure to call advance() before calling this function, or the result may still be associated with a prior time step.

Definition at line 164 of file ParticleReleaseSchedule.f90.

    class(ParticleReleaseScheduleType) :: this
    a = this%count() > 0

count()

integer function particlereleaseschedulemodule::count ( class(particlereleasescheduletype)  this )

private

Note: be sure to call advance() before calling this function, or the result may still be associated with a prior time step.

Definition at line 174 of file ParticleReleaseSchedule.f90.

    class(ParticleReleaseScheduleType) :: this
    n = size(this%times)

create_release_schedule()

type(particlereleasescheduletype) function, pointer, public particlereleaseschedulemodule::create_release_schedule

(

real(dp), intent(in)

tolerance

)

Parameters

[in]

tolerance

coincident release time tolerance

Returns

schedule pointer

Definition at line 46 of file ParticleReleaseSchedule.f90.

    real(DP), intent(in) :: tolerance !< coincident release time tolerance
    type(ParticleReleaseScheduleType), pointer :: schedule_ !< schedule pointer
 
    allocate (schedule_)
    allocate (schedule_%times(0))
    allocate (schedule_%time_select)
    allocate (schedule_%step_select)
    call schedule_%time_select%init()
    call schedule_%step_select%init()
    schedule_%tolerance = tolerance

Here is the caller graph for this function:

destroy()

subroutine particlereleaseschedulemodule::destroy ( class(particlereleasescheduletype), intent(inout)  this )

private

Parameters

[in,out]

this

this instance

Definition at line 60 of file ParticleReleaseSchedule.f90.

    class(ParticleReleaseScheduleType), intent(inout) :: this !< this instance
 
    deallocate (this%times)
    call this%time_select%deallocate()
    call this%step_select%deallocate()
    deallocate (this%time_select)
    deallocate (this%step_select)

log()

subroutine particlereleaseschedulemodule::log ( class(particlereleasescheduletype), intent(inout)  this, integer(i4b), intent(in)  iout  )

private

Parameters

[in,out]	this	this instance
[in]	iout	output unit

Definition at line 71 of file ParticleReleaseSchedule.f90.

    class(ParticleReleaseScheduleType), intent(inout) :: this !< this instance
    integer(I4B), intent(in) :: iout !< output unit
    character(len=*), parameter :: fmt = &
      &"(6x,A,': ',50(G0,' '))"
 
    if (this%any()) then
      write (iout, fmt) 'RELEASE SCHEDULE', this%times
    else
      write (iout, "(1x,a,1x,a)") 'NO RELEASES SCHEDULED'
    end if

schedule()

subroutine particlereleaseschedulemodule::schedule ( class(particlereleasescheduletype), intent(inout)  this, real(dp), intent(in)  trelease  )

private

To schedule multiple release times at once, expand and populate the time selection object by hand. DO NOT attempt to manipulate the times array; this is a read-only property which the schedule maintains.

Definition at line 91 of file ParticleReleaseSchedule.f90.

    class(ParticleReleaseScheduleType), intent(inout) :: this
    real(DP), intent(in) :: trelease
    call expandarray(this%times)
    this%times(size(this%times)) = trelease