Extends ATS so we can do synchronization.
More...
|
| 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_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.
|
|
| 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
|
Definition at line 14 of file ParallelAts.f90.
◆ ats_allocate_arrays()
| procedure, private adaptivetimestepmodule::atstype::ats_allocate_arrays |
( |
class(atstype) | this | ) |
|
|
privateinherited |
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 | ) |
|
|
privateinherited |
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 | ) |
|
|
privateinherited |
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 | ) |
|
|
inherited |
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 ) |
|
inherited |
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 | ) |
|
|
privateinherited |
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 ) |
|
inherited |
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 | ) |
|
|
privateinherited |
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 | ) |
|
|
privateinherited |
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 | ) |
|
|
privateinherited |
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 | ) |
|
|
privateinherited |
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 ) |
|
inherited |
Reset the time step using dtfailadj because the time step did not converge.
Definition at line 35 of file ats.f90.
◆ ats_set_delt() [1/2]
| 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 ) |
|
inherited |
Set the time step length (delt) for this time step using the ATS controls.
Definition at line 34 of file ats.f90.
◆ ats_set_delt() [2/2]
| procedure, public parallelatsmodule::parallelatstype::ats_set_delt |
( |
class(parallelatstype) | 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, but with synchronization across ranks.
Definition at line 17 of file ParallelAts.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 ) |
|
inherited |
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() [1/2]
| 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 ) |
|
inherited |
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.
◆ ats_submit_delt() [2/2]
| procedure, public parallelatsmodule::parallelatstype::ats_submit_delt |
( |
class(parallelatstype) | 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 16 of file ParallelAts.f90.
◆ isadaptiveperiod()
| procedure, public adaptivetimestepmodule::atstype::isadaptiveperiod |
( |
class(atstype) | this, |
|
|
integer(i4b), intent(in) | kper ) |
|
inherited |
Check settings and determine if kper is an adaptive stress period.
Definition at line 32 of file ats.f90.
◆ dt0
| real(dp), dimension(:), pointer, contiguous adaptivetimestepmodule::atstype::dt0 => null() |
|
inherited |
◆ dtadj
| real(dp), dimension(:), pointer, contiguous adaptivetimestepmodule::atstype::dtadj => null() |
|
inherited |
◆ dtfailadj
| real(dp), dimension(:), pointer, contiguous adaptivetimestepmodule::atstype::dtfailadj => null() |
|
inherited |
◆ dtmax
| real(dp), dimension(:), pointer, contiguous adaptivetimestepmodule::atstype::dtmax => null() |
|
inherited |
◆ dtmin
| real(dp), dimension(:), pointer, contiguous adaptivetimestepmodule::atstype::dtmin => null() |
|
inherited |
◆ dtstable
| real(dp), pointer, public adaptivetimestepmodule::atstype::dtstable => null() |
|
inherited |
◆ iperats
| integer(i4b), dimension(:), pointer, contiguous adaptivetimestepmodule::atstype::iperats => null() |
|
inherited |
◆ kperats
| integer(i4b), dimension(:), pointer, contiguous adaptivetimestepmodule::atstype::kperats => null() |
|
inherited |
◆ maxats
| integer(i4b), pointer adaptivetimestepmodule::atstype::maxats => null() |
|
inherited |
◆ nper
| integer(i4b), pointer adaptivetimestepmodule::atstype::nper => null() |
|
inherited |
◆ parser
Definition at line 29 of file ats.f90.
29 type(BlockParserType) :: parser
The documentation for this type was generated from the following file: