MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
adaptivetimestepmodule::atstype Type Reference
Inheritance diagram for adaptivetimestepmodule::atstype:
Inheritance graph
Collaboration diagram for adaptivetimestepmodule::atstype:
Collaboration graph

Public Member Functions

procedure, public ats_init (this, inunit, nper_tdis)
 Create ATS object.
procedure, public isadaptiveperiod (this, kper)
 Determine if period is adaptive.
procedure, public ats_submit_delt (this, kstp, kper, dt, sloc, idir)
 Allow and external caller to submit preferred time step.
procedure, public ats_set_delt (this, kstp, kper, pertim, perlencurrent, delt)
 Set time step.
procedure, public ats_reset_delt (this, kstp, kper, laststepfailed, delt, finishedtrying)
 Reset time step because failure has occurred.
procedure, public ats_period_message (this, kper)
 Write period message.
procedure, public ats_set_endofperiod (this, kper, pertim, perlencurrent, endofperiod)
 Set end of period indicator.
procedure, public ats_da (this)
 Deallocate variables.

Public Attributes

integer(i4b), pointer nper => null()
 set equal to nper
integer(i4b), pointer maxats => null()
 number of ats entries
real(dp), pointer, public dtstable => null()
 delt value required for stability
integer(i4b), dimension(:), pointer, contiguous kperats => null()
 array of stress period numbers to apply ats (size NPER)
integer(i4b), dimension(:), pointer, contiguous iperats => null()
 array of stress period numbers to apply ats (size MAXATS)
real(dp), dimension(:), pointer, contiguous dt0 => null()
 input array of initial time step sizes
real(dp), dimension(:), pointer, contiguous dtmin => null()
 input array of minimum time step sizes
real(dp), dimension(:), pointer, contiguous dtmax => null()
 input array of maximum time step sizes
real(dp), dimension(:), pointer, contiguous dtadj => null()
 input array of time step factors for shortening or increasing
real(dp), dimension(:), pointer, contiguous dtfailadj => null()
 input array of time step factors for shortening due to nonconvergence
type(blockparsertype) parser
 block parser for reading input file

Private Member Functions

procedure, private ats_allocate_scalars (this)
 Allocate scalars.
procedure, private ats_allocate_arrays (this)
 Allocate arrays.
procedure, private ats_read_options (this)
 Read options.
procedure, private ats_read_dimensions (this)
 Read dimensions.
procedure, private ats_read_timing (this)
 Read timing.
procedure, private ats_process_input (this)
 Process input.
procedure, private ats_input_table (this)
 Write input table.
procedure, private ats_check_timing (this)
 Check timing.

Detailed Description

Definition at line 18 of file ats.f90.

Member Function/Subroutine Documentation

◆ ats_allocate_arrays()

procedure, private adaptivetimestepmodule::atstype::ats_allocate_arrays ( class(atstype) this)
private

Allocate and initialize arrays for the ATS package.

Definition at line 41 of file ats.f90.

◆ ats_allocate_scalars()

procedure, private adaptivetimestepmodule::atstype::ats_allocate_scalars ( class(atstype) this)
private

Allocate and initialize scalars for the ATS package.

Definition at line 40 of file ats.f90.

◆ ats_check_timing()

procedure, private adaptivetimestepmodule::atstype::ats_check_timing ( class(atstype) this)
private

Perform a check on the input data to make sure values are within required ranges.

Definition at line 47 of file ats.f90.

◆ ats_da()

procedure, public adaptivetimestepmodule::atstype::ats_da ( class(atstype) this)

Deallocate all ATS variables.

Definition at line 38 of file ats.f90.

◆ ats_init()

procedure, public adaptivetimestepmodule::atstype::ats_init ( class(atstype) this,
integer(i4b), intent(in) inunit,
integer(i4b), intent(in) nper_tdis )

Create a new ATS object, and read and check input.

Definition at line 31 of file ats.f90.

◆ ats_input_table()

procedure, private adaptivetimestepmodule::atstype::ats_input_table ( class(atstype) this)
private

Write a table showing the ATS input read from the perioddata block.

Definition at line 46 of file ats.f90.

◆ ats_period_message()

procedure, public adaptivetimestepmodule::atstype::ats_period_message ( class(atstype) this,
integer(i4b), intent(in) kper )

Write message to mfsim.lst file with information on ATS settings for this period.

Definition at line 36 of file ats.f90.

◆ ats_process_input()

procedure, private adaptivetimestepmodule::atstype::ats_process_input ( class(atstype) this)
private

Process ATS input by filling the kperats array.

Definition at line 45 of file ats.f90.

◆ ats_read_dimensions()

procedure, private adaptivetimestepmodule::atstype::ats_read_dimensions ( class(atstype) this)
private

Read dimensions from ATS input file.

Definition at line 43 of file ats.f90.

◆ ats_read_options()

procedure, private adaptivetimestepmodule::atstype::ats_read_options ( class(atstype) this)
private

Read options from ATS input file.

Definition at line 42 of file ats.f90.

◆ ats_read_timing()

procedure, private adaptivetimestepmodule::atstype::ats_read_timing ( class(atstype) this)
private

Read timing information from ATS input file.

Definition at line 44 of file ats.f90.

◆ ats_reset_delt()

procedure, public adaptivetimestepmodule::atstype::ats_reset_delt ( class(atstype) this,
integer(i4b), intent(in) kstp,
integer(i4b), intent(in) kper,
integer(i4b), intent(in) laststepfailed,
real(dp), intent(inout) delt,
logical, intent(inout) finishedtrying )

Reset the time step using dtfailadj because the time step did not converge.

Definition at line 35 of file ats.f90.

◆ ats_set_delt()

procedure, public adaptivetimestepmodule::atstype::ats_set_delt ( class(atstype) this,
integer(i4b), intent(in) kstp,
integer(i4b), intent(in) kper,
real(dp), intent(inout) pertim,
real(dp), intent(in) perlencurrent,
real(dp), intent(inout) delt )

Set the time step length (delt) for this time step using the ATS controls.

Definition at line 34 of file ats.f90.

◆ ats_set_endofperiod()

procedure, public adaptivetimestepmodule::atstype::ats_set_endofperiod ( class(atstype) this,
integer(i4b), intent(in) kper,
real(dp), intent(inout) pertim,
real(dp), intent(in) perlencurrent,
logical(lgp), intent(inout) endofperiod )

Determine if it is the end of the stress period and set the endofperiod logical variable if so.

Definition at line 37 of file ats.f90.

◆ ats_submit_delt()

procedure, public adaptivetimestepmodule::atstype::ats_submit_delt ( class(atstype) this,
integer(i4b), intent(in) kstp,
integer(i4b), intent(in) kper,
real(dp), intent(in) dt,
character(len=*), intent(in) sloc,
integer(i4b), intent(in), optional idir )

Submit a preferred time step length. Alternatively, if idir is is passed, then either increase or decrease the submitted time step by the dtadj input variable.

Definition at line 33 of file ats.f90.

◆ isadaptiveperiod()

procedure, public adaptivetimestepmodule::atstype::isadaptiveperiod ( class(atstype) this,
integer(i4b), intent(in) kper )

Check settings and determine if kper is an adaptive stress period.

Definition at line 32 of file ats.f90.

Member Data Documentation

◆ dt0

real(dp), dimension(:), pointer, contiguous adaptivetimestepmodule::atstype::dt0 => null()

Definition at line 24 of file ats.f90.

◆ dtadj

real(dp), dimension(:), pointer, contiguous adaptivetimestepmodule::atstype::dtadj => null()

Definition at line 27 of file ats.f90.

◆ dtfailadj

real(dp), dimension(:), pointer, contiguous adaptivetimestepmodule::atstype::dtfailadj => null()

Definition at line 28 of file ats.f90.

◆ dtmax

real(dp), dimension(:), pointer, contiguous adaptivetimestepmodule::atstype::dtmax => null()

Definition at line 26 of file ats.f90.

◆ dtmin

real(dp), dimension(:), pointer, contiguous adaptivetimestepmodule::atstype::dtmin => null()

Definition at line 25 of file ats.f90.

◆ dtstable

real(dp), pointer, public adaptivetimestepmodule::atstype::dtstable => null()

Definition at line 21 of file ats.f90.

◆ iperats

integer(i4b), dimension(:), pointer, contiguous adaptivetimestepmodule::atstype::iperats => null()

Definition at line 23 of file ats.f90.

◆ kperats

integer(i4b), dimension(:), pointer, contiguous adaptivetimestepmodule::atstype::kperats => null()

Definition at line 22 of file ats.f90.

◆ maxats

integer(i4b), pointer adaptivetimestepmodule::atstype::maxats => null()

Definition at line 20 of file ats.f90.

◆ nper

integer(i4b), pointer adaptivetimestepmodule::atstype::nper => null()

Definition at line 19 of file ats.f90.

◆ parser

type(blockparsertype) adaptivetimestepmodule::atstype::parser

Definition at line 29 of file ats.f90.

29 type(BlockParserType) :: parser !< block parser for reading input file

The documentation for this type was generated from the following file:
  • /home/runner/work/modflow6/modflow6/src/Timing/ats.f90