timestepselectmodule::timestepselecttype Type Reference

Time step selection type. More...

Collaboration diagram for timestepselectmodule::timestepselecttype:

Private Member Functions
procedure	deallocate
procedure	init
procedure	log
procedure	read
procedure	is_selected
procedure	any

Private Attributes
logical(lgp)	all
logical(lgp)	first
logical(lgp)	last
integer(i4b)	freq
integer(i4b), dimension(:), allocatable	steps

Detailed Description

Represents a selection of time steps as configured in an input file's period block settings. The object should be initiated with the init() procedure. The read() procedure accepts a character string of form:

ALL STEPS 1 4 5 6 FIRST LAST FREQUENCY 4

The read() procedure may be invoked multiple times to select multiple time steps. Note that a character string reusing a keyword which has been used for a previous read() invocation will override the previous setting using that keyword. To combine multiple settings, be sure the keywords are different on each invocation, e.g.:

FIRST LAST STEPS 2

The is_selected() function indicates whether the given time step is active. This function accepts an optional argument, indicating that the time step is the last in the stress period.

Definition at line 40 of file TimeStepSelect.f90.

Member Function/Subroutine Documentation

any()

procedure timestepselectmodule::timestepselecttype::any

private

Definition at line 52 of file TimeStepSelect.f90.

deallocate()

procedure timestepselectmodule::timestepselecttype::deallocate

private

Definition at line 47 of file TimeStepSelect.f90.

init()

procedure timestepselectmodule::timestepselecttype::init

private

Definition at line 48 of file TimeStepSelect.f90.

is_selected()

procedure timestepselectmodule::timestepselecttype::is_selected

private

Definition at line 51 of file TimeStepSelect.f90.

log()

procedure timestepselectmodule::timestepselecttype::log

private

Definition at line 49 of file TimeStepSelect.f90.

read()

procedure timestepselectmodule::timestepselecttype::read

private

Definition at line 50 of file TimeStepSelect.f90.

Member Data Documentation

all

logical(lgp) timestepselectmodule::timestepselecttype::all

private

Definition at line 41 of file TimeStepSelect.f90.

    logical(LGP) :: all

first

logical(lgp) timestepselectmodule::timestepselecttype::first

private

Definition at line 42 of file TimeStepSelect.f90.

    logical(LGP) :: first

freq

integer(i4b) timestepselectmodule::timestepselecttype::freq

private

Definition at line 44 of file TimeStepSelect.f90.

    integer(I4B) :: freq

last

logical(lgp) timestepselectmodule::timestepselecttype::last

private

Definition at line 43 of file TimeStepSelect.f90.

    logical(LGP) :: last

steps

integer(i4b), dimension(:), allocatable timestepselectmodule::timestepselecttype::steps

private

Definition at line 45 of file TimeStepSelect.f90.

    integer(I4B), allocatable :: steps(:)

---

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

• /home/runner/work/modflow6/modflow6/src/Model/ModelUtilities/TimeStepSelect.f90