timestepselectmodule Module Reference

Time step selection module.

Data Types
type	timestepselecttype
	Time step selection type. More...

Functions/Subroutines
subroutine	deallocate (this)
	Deallocate the time step selection object. More...
subroutine	init (this)
	Initialize the time step selection object. More...
subroutine	log (this, iout, verb)
subroutine	read (this, line)
	Read a line of input and prepare the selection object. More...
logical function	is_selected (this, kstp, endofperiod)
	Indicates whether the given time step is selected. More...
logical function	any (this)
	Indicates whether any time steps are selected. More...

Function/Subroutine Documentation

any()

logical function timestepselectmodule::any ( class(timestepselecttype)  this )

private

Parameters

this	this instance

Definition at line 180 of file TimeStepSelect.f90.

    class(TimeStepSelectType) :: this !< this instance
    a = (this%all .or. &
         this%first .or. &
         this%last .or. &
         this%freq > 0 .or. &
         size(this%steps) > 0)

deallocate()

subroutine timestepselectmodule::deallocate ( class(timestepselecttype)  this )

private

Definition at line 58 of file TimeStepSelect.f90.

    class(TimeSTepSelectType) :: this
    deallocate (this%steps)

init()

subroutine timestepselectmodule::init ( class(timestepselecttype)  this )

private

Parameters

this	this instance

Definition at line 64 of file TimeStepSelect.f90.

    class(TimeStepSelectType) :: this !< this instance
 
    if (allocated(this%steps)) deallocate (this%steps)
    allocate (this%steps(0))
    this%freq = 0
    this%first = .false.
    this%last = .false.
    this%all = .false.

is_selected()

logical function timestepselectmodule::is_selected ( class(timestepselecttype)  this, integer(i4b), intent(in)  kstp, logical(lgp), intent(in), optional  endofperiod  )

private

Parameters

	this	this instance
[in]	kstp	current time step
[in]	endofperiod	whether last step of stress period

Definition at line 146 of file TimeStepSelect.f90.

    ! dummy
    class(TimeStepSelectType) :: this !< this instance
    integer(I4B), intent(in) :: kstp !< current time step
    logical(LGP), intent(in), optional :: endofperiod !< whether last step of stress period
    ! local
    integer(I4B) :: i, n
    logical(LGP) :: lend
 
    if (present(endofperiod)) then
      lend = endofperiod
    else
      lend = .false.
    end if
 
    is_selected = .false.
    if (this%all) is_selected = .true.
    if (kstp == 1 .and. this%first) is_selected = .true.
    if (lend .and. this%last) is_selected = .true.
    if (this%freq > 0) then
      if (mod(kstp, this%freq) == 0) is_selected = .true.
    end if
    n = size(this%steps)
    if (n > 0) then
      do i = 1, n
        if (kstp == this%steps(i)) then
          is_selected = .true.
          exit
        end if
      end do
    end if

log()

subroutine timestepselectmodule::log ( class(timestepselecttype)  this, integer(i4b), intent(in)  iout, character(len=*), intent(in)  verb  )

private

Parameters

	this	this instance
[in]	iout	output unit
[in]	verb	selection name

Definition at line 75 of file TimeStepSelect.f90.

    ! dummy
    class(TimeStepSelectType) :: this !< this instance
    integer(I4B), intent(in) :: iout !< output unit
    character(len=*), intent(in) :: verb !< selection name
    ! formats
    character(len=*), parameter :: fmt_steps = &
      &"(6x,'THE FOLLOWING STEPS WILL BE ',A,': ',50(I0,' '))"
    character(len=*), parameter :: fmt_freq = &
      &"(6x,'THE FOLLOWING FREQUENCY WILL BE ',A,': ',I0)"
 
    if (this%all) then
      write (iout, "(6x,a,a)") 'ALL TIME STEPS WILL BE ', verb
    end if
    if (size(this%steps) > 0) then
      write (iout, fmt_steps) verb, this%steps
    end if
    if (this%freq > 0) then
      write (iout, fmt_freq) verb, this%freq
    end if
    if (this%first) then
      write (iout, "(6x,a,a)") 'THE FIRST TIME STEP WILL BE ', verb
    end if
    if (this%last) then
      write (iout, "(6x,a,a)") 'THE LAST TIME STEP WILL BE ', verb
    end if

read()

subroutine timestepselectmodule::read ( class(timestepselecttype)  this, character(len=*), intent(in)  line  )

private

Parameters

	this	this instance
[in]	line	input line

Definition at line 104 of file TimeStepSelect.f90.

    class(TimeStepSelectType) :: this !< this instance
    character(len=*), intent(in) :: line !< input line
 
    character(len=len(line)) :: l
    integer(I4B) :: n, lloc, istart, istop, ival
    real(DP) :: rval
 
    l(:) = line(:)
    lloc = 1
 
    call urword(l, lloc, istart, istop, 1, ival, rval, 0, 0)
    select case (l(istart:istop))
    case ('ALL')
      this%all = .true.
    case ('STEPS')
      listsearch: do
        call urword(l, lloc, istart, istop, 2, ival, rval, -1, 0)
        if (ival > 0) then
          n = size(this%steps)
          call expandarray(this%steps)
          this%steps(n + 1) = ival
          cycle listsearch
        end if
        exit listsearch
      end do listsearch
    case ('FREQUENCY')
      call urword(l, lloc, istart, istop, 2, ival, rval, -1, 0)
      this%freq = ival
    case ('FIRST')
      this%first = .true.
    case ('LAST')
      this%last = .true.
    case default
      write (errmsg, '(2a)') &
        'Looking for ALL, STEPS, FIRST, LAST, OR FREQUENCY. Found: ', &
        trim(adjustl(line))
      call store_error(errmsg, terminate=.true.)
    end select

Here is the call graph for this function: