Represents a series of instants at which some event should occur. More...

Collaboration diagram for timeselectmodule::timeselecttype:

Public Member Functions
procedure	deallocate

procedure	expand

procedure	init

procedure	increasing

procedure	log

procedure	select

procedure	advance

procedure	any

procedure	count

procedure	sort

procedure	extend

Public Attributes
real(dp), dimension(:), allocatable	times

integer(i4b), dimension(2)	selection

Detailed Description

Maintains an array of configured times which can be sliced to match e.g. the current period & time step. Slicing can be performed manually, with the select() routine, or automatically, with the advance() routine, for a convenient view onto the applicable subset of the complete time array.

Array storage can be expanded manually. Note: array expansion must take place before selection; when expand() is called the selection is wiped. Alternatively, the extend() routine will automatically expand the array and sort it.

Most use cases likely assume a strictly increasing time selection; this can be checked with increasing(). Note that the sort() routine does not check for duplicates, and should usually be followed by an increasing() check before the time selection is used.

Definition at line 30 of file TimeSelect.f90.

Member Function/Subroutine Documentation

◆ advance()

procedure timeselectmodule::timeselecttype::advance

Definition at line 40 of file TimeSelect.f90.

◆ any()

procedure timeselectmodule::timeselecttype::any

Definition at line 41 of file TimeSelect.f90.

◆ count()

procedure timeselectmodule::timeselecttype::count

Definition at line 42 of file TimeSelect.f90.

◆ deallocate()

procedure timeselectmodule::timeselecttype::deallocate

Definition at line 34 of file TimeSelect.f90.

◆ expand()

procedure timeselectmodule::timeselecttype::expand

Definition at line 35 of file TimeSelect.f90.

◆ extend()

procedure timeselectmodule::timeselecttype::extend

Definition at line 44 of file TimeSelect.f90.

◆ increasing()

procedure timeselectmodule::timeselecttype::increasing

Definition at line 37 of file TimeSelect.f90.

◆ init()

procedure timeselectmodule::timeselecttype::init

Definition at line 36 of file TimeSelect.f90.

◆ log()

procedure timeselectmodule::timeselecttype::log

Definition at line 38 of file TimeSelect.f90.

◆ select()

procedure timeselectmodule::timeselecttype::select

Definition at line 39 of file TimeSelect.f90.

◆ sort()

procedure timeselectmodule::timeselecttype::sort

Definition at line 43 of file TimeSelect.f90.

Member Data Documentation

◆ selection

integer(i4b), dimension(2) timeselectmodule::timeselecttype::selection

Definition at line 32 of file TimeSelect.f90.

32 integer(I4B) :: selection(2)

◆ times

real(dp), dimension(:), allocatable timeselectmodule::timeselecttype::times

Definition at line 31 of file TimeSelect.f90.

31 real(DP), allocatable :: times(:)

The documentation for this type was generated from the following file:

/home/runner/work/modflow6/modflow6/src/Model/ModelUtilities/TimeSelect.f90

Public Member Functions

Public Attributes