MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
timestepselectmodule::timestepselecttype Type Reference

Time step selection type. More...

Collaboration diagram for timestepselectmodule::timestepselecttype:
Collaboration graph

Public Member Functions

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

Public 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 ( class(timestepselecttype) this)
Parameters
thisthis instance

Definition at line 52 of file TimeStepSelect.f90.

◆ deallocate()

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

Definition at line 47 of file TimeStepSelect.f90.

◆ init()

procedure timestepselectmodule::timestepselecttype::init ( class(timestepselecttype) this)
Parameters
thisthis instance

Definition at line 48 of file TimeStepSelect.f90.

◆ is_selected()

procedure timestepselectmodule::timestepselecttype::is_selected ( class(timestepselecttype) this,
integer(i4b), intent(in) kstp,
logical(lgp), intent(in), optional endofperiod )
Parameters
thisthis instance
[in]kstpcurrent time step
[in]endofperiodwhether last step of stress period

Definition at line 51 of file TimeStepSelect.f90.

◆ log()

procedure timestepselectmodule::timestepselecttype::log ( class(timestepselecttype) this,
integer(i4b), intent(in) iout,
character(len=*), intent(in) verb )
Parameters
thisthis instance
[in]ioutoutput unit
[in]verbselection name

Definition at line 49 of file TimeStepSelect.f90.

◆ read()

procedure timestepselectmodule::timestepselecttype::read ( class(timestepselecttype) this,
character(len=*), intent(in) line )
Parameters
thisthis instance
[in]lineinput line

Definition at line 50 of file TimeStepSelect.f90.

Member Data Documentation

◆ all

logical(lgp) timestepselectmodule::timestepselecttype::all

Definition at line 41 of file TimeStepSelect.f90.

41 logical(LGP) :: all

◆ first

logical(lgp) timestepselectmodule::timestepselecttype::first

Definition at line 42 of file TimeStepSelect.f90.

42 logical(LGP) :: first

◆ freq

integer(i4b) timestepselectmodule::timestepselecttype::freq

Definition at line 44 of file TimeStepSelect.f90.

44 integer(I4B) :: freq

◆ last

logical(lgp) timestepselectmodule::timestepselecttype::last

Definition at line 43 of file TimeStepSelect.f90.

43 logical(LGP) :: last

◆ steps

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

Definition at line 45 of file TimeStepSelect.f90.

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

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