Functions/Subroutines
subroutine, public	tdis_cr (fname, inmempath)
	Create temporal discretization. More...

subroutine, public	tdis_set_counters ()
	Set kstp and kper. More...

subroutine, public	tdis_set_timestep ()
	Set time step length. More...

subroutine, public	tdis_delt_reset (deltnew)
	Reset delt and update timing variables and indicators. More...

subroutine	tdis_set_delt ()
	Set time step length. More...

subroutine, public	tdis_ot (iout)
	Print simulation time. More...

subroutine, public	tdis_da ()
	Deallocate memory. More...

subroutine	tdis_source_options ()
	Source the timing discretization options. More...

subroutine	tdis_allocate_scalars ()
	Allocate tdis scalars. More...

subroutine	tdis_allocate_arrays ()
	Allocate tdis arrays. More...

subroutine	tdis_source_dimensions ()
	Source dimension NPER. More...

subroutine	tdis_source_timing ()
	Source timing information. More...

subroutine	check_tdis_timing (nper, perlen, nstp, tsmult)
	Check the tdis timing information. More...

Variables
integer(i4b), pointer, public	nper => null()
	number of stress period More...

integer(i4b), pointer, public	itmuni => null()
	flag indicating time units More...

integer(i4b), pointer, public	kper => null()
	current stress period number More...

integer(i4b), pointer, public	kstp => null()
	current time step number More...

integer(i4b), pointer, public	inats => null()
	flag indicating ats active for simulation More...

logical(lgp), pointer, public	readnewdata => null()
	flag indicating time to read new data More...

logical(lgp), pointer, public	endofperiod => null()
	flag indicating end of stress period More...

logical(lgp), pointer, public	endofsimulation => null()
	flag indicating end of simulation More...

real(dp), pointer, public	delt => null()
	length of the current time step More...

real(dp), pointer, public	pertim => null()
	time relative to start of stress period More...

real(dp), pointer, public	topertim => null()
	simulation time at start of stress period More...

real(dp), pointer, public	totim => null()
	time relative to start of simulation More...

real(dp), pointer, public	totimc => null()
	simulation time at start of time step More...

real(dp), pointer, public	deltsav => null()
	saved value for delt, used for subtiming More...

real(dp), pointer, public	totimsav => null()
	saved value for totim, used for subtiming More...

real(dp), pointer, public	pertimsav => null()
	saved value for pertim, used for subtiming More...

real(dp), pointer, public	totalsimtime => null()
	time at end of simulation More...

real(dp), dimension(:), pointer, public, contiguous	perlen => null()
	length of each stress period More...

integer(i4b), dimension(:), pointer, public, contiguous	nstp => null()
	number of time steps in each stress period More...

real(dp), dimension(:), pointer, public, contiguous	tsmult => null()
	time step multiplier for each stress period More...

character(len=lendatetime), pointer, public	datetime0 => null()
	starting date and time for the simulation More...

character(len=lenmempath), pointer	input_mempath => null()
	input context mempath for tdis More...

character(len=linelength), pointer	input_fname => null()
	input filename for tdis More...

Function/Subroutine Documentation

◆ check_tdis_timing()

subroutine tdismodule::check_tdis_timing	(	integer(i4b), intent(in)	nper,
		real(dp), dimension(:), intent(in), contiguous	perlen,
		integer(i4b), dimension(:), intent(in), contiguous	nstp,
		real(dp), dimension(:), intent(in), contiguous	tsmult
	)

Return back to tdis_read_timing if an error condition is found and let the ustop routine be called there instead so the StoreErrorUnit routine can be called to assign the correct file name.

Definition at line 601 of file tdis.f90.

     ! -- modules
     use constantsmodule, only: linelength, dzero, done
     use simmodule, only: store_error
     ! -- dummy
     integer(I4B), intent(in) :: nper
     real(DP), dimension(:), contiguous, intent(in) :: perlen
     integer(I4B), dimension(:), contiguous, intent(in) :: nstp
     real(DP), dimension(:), contiguous, intent(in) :: tsmult
     ! -- local
     integer(I4B) :: kper, kstp
     real(DP) :: tstart, tend, dt
     character(len=LINELENGTH) :: errmsg
     ! -- formats
     character(len=*), parameter :: fmtpwarn = &
       "(1X,/1X,'PERLEN is zero for stress period ', I0, &
       &'. PERLEN must not be zero for transient periods.')"
     character(len=*), parameter :: fmtsperror = &
       &"(A,' for stress period ', I0)"
     character(len=*), parameter :: fmtdterror = &
       "('Time step length of ', G0, ' is too small in period ', I0, &
       &' and time step ', I0)"
     !
     ! -- Initialize
     tstart = dzero
     !
     ! -- Go through and check each stress period
     do kper = 1, nper
       !
       ! -- Error if nstp less than or equal to zero
       if (nstp(kper) <= 0) then
         write (errmsg, fmtsperror) 'Number of time steps less than one ', kper
         call store_error(errmsg)
         return
       end if
       !
       ! -- Warn if perlen is zero
       if (perlen(kper) == dzero) then
         write (iout, fmtpwarn) kper
         return
       end if
       !
       ! -- Error if tsmult is less than zero
       if (tsmult(kper) <= dzero) then
         write (errmsg, fmtsperror) 'TSMULT must be greater than 0.0 ', kper
         call store_error(errmsg)
         return
       end if
       !
       ! -- Error if negative period length
       if (perlen(kper) < dzero) then
         write (errmsg, fmtsperror) 'PERLEN cannot be less than 0.0 ', kper
         call store_error(errmsg)
         return
       end if
       !
       ! -- Go through all time step lengths and make sure they are valid
       do kstp = 1, nstp(kper)
         if (kstp == 1) then
           dt = perlen(kper) / float(nstp(kper))
           if (tsmult(kper) /= done) &
             dt = perlen(kper) * (done - tsmult(kper)) / &
                  (done - tsmult(kper)**nstp(kper))
         else
           dt = dt * tsmult(kper)
         end if
         tend = tstart + dt
         !
         ! -- Error condition if tstart == tend
         if (tstart == tend) then
           write (errmsg, fmtdterror) dt, kper, kstp
           call store_error(errmsg)
           return
         end if
       end do
       !
       ! -- reset tstart = tend
       tstart = tend
       !
     end do

Here is the call graph for this function:

Here is the caller graph for this function:

◆ tdis_allocate_arrays()

subroutine tdismodule::tdis_allocate_arrays

Definition at line 515 of file tdis.f90.

     ! -- modules
     use memorymanagermodule, only: mem_allocate
     !
     call mem_allocate(perlen, nper, 'PERLEN', 'TDIS')
     call mem_allocate(nstp, nper, 'NSTP', 'TDIS')
     call mem_allocate(tsmult, nper, 'TSMULT', 'TDIS')

Here is the caller graph for this function:

◆ tdis_allocate_scalars()

subroutine tdismodule::tdis_allocate_scalars

Definition at line 463 of file tdis.f90.

     ! -- modules
     use memorymanagermodule, only: mem_allocate
     use constantsmodule, only: dzero
     !
     ! -- memory manager variables
     call mem_allocate(nper, 'NPER', 'TDIS')
     call mem_allocate(itmuni, 'ITMUNI', 'TDIS')
     call mem_allocate(kper, 'KPER', 'TDIS')
     call mem_allocate(kstp, 'KSTP', 'TDIS')
     call mem_allocate(inats, 'INATS', 'TDIS')
     call mem_allocate(readnewdata, 'READNEWDATA', 'TDIS')
     call mem_allocate(endofperiod, 'ENDOFPERIOD', 'TDIS')
     call mem_allocate(endofsimulation, 'ENDOFSIMULATION', 'TDIS')
     call mem_allocate(delt, 'DELT', 'TDIS')
     call mem_allocate(pertim, 'PERTIM', 'TDIS')
     call mem_allocate(topertim, 'TOPERTIM', 'TDIS')
     call mem_allocate(totim, 'TOTIM', 'TDIS')
     call mem_allocate(totimc, 'TOTIMC', 'TDIS')
     call mem_allocate(deltsav, 'DELTSAV', 'TDIS')
     call mem_allocate(totimsav, 'TOTIMSAV', 'TDIS')
     call mem_allocate(pertimsav, 'PERTIMSAV', 'TDIS')
     call mem_allocate(totalsimtime, 'TOTALSIMTIME', 'TDIS')
     !
     ! -- strings
     allocate (datetime0)
     allocate (input_mempath)
     allocate (input_fname)
     !
     ! -- Initialize variables
     nper = 0
     itmuni = 0
     kper = 0
     kstp = 0
     inats = 0
     readnewdata = .true.
     endofperiod = .true.
     endofsimulation = .false.
     delt = dzero
     pertim = dzero
     topertim = dzero
     totim = dzero
     totimc = dzero
     deltsav = dzero
     totimsav = dzero
     pertimsav = dzero
     totalsimtime = dzero
     datetime0 = ''

Here is the caller graph for this function:

◆ tdis_cr()

subroutine, public tdismodule::tdis_cr	(	character(len=*), intent(in)	fname,
		character(len=*), intent(in)	inmempath
	)

Definition at line 49 of file tdis.f90.

     ! -- modules
     use inputoutputmodule, only: getunit, openfile
     use constantsmodule, only: linelength, dzero
     use adaptivetimestepmodule, only: ats_cr
     ! -- dummy
     character(len=*), intent(in) :: fname
     character(len=*), intent(in) :: inmempath
     ! -- local
     ! -- formats
     character(len=*), parameter :: fmtheader = &
      "(1X,/1X,'TDIS -- TEMPORAL DISCRETIZATION PACKAGE,',   /                  &
       &' VERSION 1 : 11/13/2014 - INPUT READ FROM MEMPATH: ', A)"
     !
     ! -- Allocate the scalar variables
     call tdis_allocate_scalars()
     !
     ! -- set input context and fname
     input_fname = fname
     input_mempath = inmempath
     !
     ! -- Identify package
     write (iout, fmtheader) input_mempath
     !
     ! -- Source options
     call tdis_source_options()
     !
     ! -- Source dimensions and then allocate arrays
     call tdis_source_dimensions()
     call tdis_allocate_arrays()
     !
     ! -- Source timing
     call tdis_source_timing()
     !
     if (inats > 0) then
       call ats_cr(inats, nper)
     end if

Here is the call graph for this function:

Here is the caller graph for this function:

◆ tdis_da()

subroutine, public tdismodule::tdis_da

Definition at line 344 of file tdis.f90.

     ! -- modules
     use memorymanagermodule, only: mem_deallocate
     use adaptivetimestepmodule, only: ats_da
     !
     ! -- ats
     if (inats > 0) call ats_da()
     !
     ! -- Scalars
     call mem_deallocate(nper)
     call mem_deallocate(itmuni)
     call mem_deallocate(kper)
     call mem_deallocate(kstp)
     call mem_deallocate(inats)
     call mem_deallocate(readnewdata)
     call mem_deallocate(endofperiod)
     call mem_deallocate(endofsimulation)
     call mem_deallocate(delt)
     call mem_deallocate(pertim)
     call mem_deallocate(topertim)
     call mem_deallocate(totim)
     call mem_deallocate(totimc)
     call mem_deallocate(deltsav)
     call mem_deallocate(totimsav)
     call mem_deallocate(pertimsav)
     call mem_deallocate(totalsimtime)
     !
     ! -- strings
     deallocate (datetime0)
     deallocate (input_mempath)
     deallocate (input_fname)
     !
     ! -- Arrays
     call mem_deallocate(perlen)
     call mem_deallocate(nstp)
     call mem_deallocate(tsmult)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ tdis_delt_reset()

subroutine, public tdismodule::tdis_delt_reset ( real(dp), intent(in) deltnew )

This routine is called when a timestep fails to converge, and so it is retried using a smaller time step (deltnew).

Definition at line 212 of file tdis.f90.

     ! -- modules
     use constantsmodule, only: done, dzero
     use adaptivetimestepmodule, only: isadaptiveperiod, &
                                       ats_set_delt, &
                                       ats_set_endofperiod
     ! -- dummy
     real(DP), intent(in) :: deltnew
     ! -- local
     logical(LGP) :: adaptivePeriod
     !
     ! -- Set values
     adaptiveperiod = isadaptiveperiod(kper)
     delt = deltnew
     totim = totimsav + delt
     pertim = pertimsav + delt
     !
     ! -- Set end of period indicator
     endofperiod = .false.
     if (adaptiveperiod) then
       call ats_set_endofperiod(kper, pertim, perlen(kper), endofperiod)
     else
       if (kstp == nstp(kper)) then
         endofperiod = .true.
       end if
     end if
     !
     ! -- Set end of simulation indicator
     if (endofperiod .and. kper == nper) then
       endofsimulation = .true.
       totim = totalsimtime
     end if

Here is the call graph for this function:

Here is the caller graph for this function:

◆ tdis_ot()

subroutine, public tdismodule::tdis_ot ( integer(i4b), intent(in) iout )

Definition at line 273 of file tdis.f90.

     ! -- modules
     use constantsmodule, only: dzero, done, dsixty, dsecperhr, dhrperday, &
                                ddyperyr, dsecperdy, dsecperyr
     ! -- dummy
     integer(I4B), intent(in) :: iout
     ! -- local
     real(DP) :: cnv, delsec, totsec, persec, delmn, delhr, totmn, tothr, &
                 totdy, totyr, permn, perhr, perdy, peryr, deldy, delyr
     ! -- format
     character(len=*), parameter :: fmttmsmry = "(1X, ///9X, &
       &'TIME SUMMARY AT END OF TIME STEP', I5,' IN STRESS PERIOD ', I4)"
     character(len=*), parameter :: fmttmstpmsg = &
       &"(21X, '     TIME STEP LENGTH =', G15.6 / &
       & 21X, '   STRESS PERIOD TIME =', G15.6 / &
       & 21X, 'TOTAL SIMULATION TIME =', G15.6)"
     character(len=*), parameter :: fmttottmmsg = &
       &"(19X, ' SECONDS     MINUTES      HOURS', 7X, &
       &'DAYS        YEARS'/20X, 59('-'))"
     character(len=*), parameter :: fmtdelttm = &
       &"(1X, '  TIME STEP LENGTH', 1P, 5G12.5)"
     character(len=*), parameter :: fmtpertm = &
       &"(1X, 'STRESS PERIOD TIME', 1P, 5G12.5)"
     character(len=*), parameter :: fmttottm = &
       &"(1X, '        TOTAL TIME', 1P, 5G12.5,/)"
     !
     ! -- Write header message for the information that follows
     write (iout, fmttmsmry) kstp, kper
     !
     ! -- Use time unit indicator to get factor to convert to seconds
     cnv = dzero
     if (itmuni == 1) cnv = done
     if (itmuni == 2) cnv = dsixty
     if (itmuni == 3) cnv = dsecperhr
     if (itmuni == 4) cnv = dsecperdy
     if (itmuni == 5) cnv = dsecperyr
     !
     ! -- If FACTOR=0 then time units are non-standard
     if (cnv == dzero) then
       ! -- Print times in non-standard time units
       write (iout, fmttmstpmsg) delt, pertim, totim
     else
       ! -- Calculate length of time step & elapsed time in seconds
       delsec = cnv * delt
       totsec = cnv * totim
       persec = cnv * pertim
       !
       ! -- Calculate times in minutes, hours, days, and years
       delmn = delsec / dsixty
       delhr = delmn / dsixty
       deldy = delhr / dhrperday
       delyr = deldy / ddyperyr
       totmn = totsec / dsixty
       tothr = totmn / dsixty
       totdy = tothr / dhrperday
       totyr = totdy / ddyperyr
       permn = persec / dsixty
       perhr = permn / dsixty
       perdy = perhr / dhrperday
       peryr = perdy / ddyperyr
       !
       ! -- Print time step length and elapsed times in all time units
       write (iout, fmttottmmsg)
       write (iout, fmtdelttm) delsec, delmn, delhr, deldy, delyr
       write (iout, fmtpertm) persec, permn, perhr, perdy, peryr
       write (iout, fmttottm) totsec, totmn, tothr, totdy, totyr
     end if

Here is the caller graph for this function:

◆ tdis_set_counters()

subroutine, public tdismodule::tdis_set_counters

Definition at line 90 of file tdis.f90.

     ! -- modules
     use constantsmodule, only: done, dzero, mnormal, mvalidate, dnodata
     use simvariablesmodule, only: isim_mode
     use messagemodule, only: write_message
     use adaptivetimestepmodule, only: isadaptiveperiod, dtstable, &
                                       ats_period_message
     ! -- local
     character(len=LINELENGTH) :: line
     character(len=4) :: cpref
     character(len=10) :: cend
     ! -- formats
     character(len=*), parameter :: fmtspts = &
       &"(a, 'Solving:  Stress period: ',i5,4x, 'Time step: ',i5,4x, a)"
     character(len=*), parameter :: fmtvspts = &
       &"(' Validating:  Stress period: ',i5,4x,'Time step: ',i5,4x)"
     character(len=*), parameter :: fmtspi = &
       "('1',/1X,'STRESS PERIOD NO. ',I0,', LENGTH =',G15.7,/ &
       &1X,42('-'))"
     character(len=*), parameter :: fmtspits = &
       "(1X,'NUMBER OF TIME STEPS = ',I0,/ &
       &1X,'MULTIPLIER FOR DELT =',F10.3)"
     !
     ! -- Initialize variables for this step
     if (inats > 0) dtstable = dnodata
     readnewdata = .false.
     cpref = '    '
     cend = ''
     !
     ! -- Increment kstp and kper
     if (endofperiod) then
       kstp = 1
       kper = kper + 1
       readnewdata = .true.
     else
       kstp = kstp + 1
     end if
     !
     ! -- Print stress period and time step to console
     select case (isim_mode)
     case (mvalidate)
       write (line, fmtvspts) kper, kstp
     case (mnormal)
       write (line, fmtspts) cpref, kper, kstp, trim(cend)
     end select
     if (isim_level >= vall) &
       call write_message(line)
     call write_message(line, iunit=iout, skipbefore=1, skipafter=1)
     !
     ! -- Write message if first time step
     if (kstp == 1) then
       write (iout, fmtspi) kper, perlen(kper)
       if (isadaptiveperiod(kper)) then
         call ats_period_message(kper)
       else
         write (iout, fmtspits) nstp(kper), tsmult(kper)
       end if
     end if

Here is the call graph for this function:

Here is the caller graph for this function:

◆ tdis_set_delt()

subroutine tdismodule::tdis_set_delt

Definition at line 248 of file tdis.f90.

     ! -- modules
     use constantsmodule, only: done
     !
     if (kstp == 1) then
       ! -- Calculate the first value of delt for this stress period
       topertim = totim
       if (tsmult(kper) /= done) then
         ! -- Timestep length has a geometric progression
         delt = perlen(kper) * (done - tsmult(kper)) / &
                (done - tsmult(kper)**nstp(kper))
       else
         ! -- Timestep length is constant
         delt = perlen(kper) / float(nstp(kper))
       end if
     elseif (kstp == nstp(kper)) then
       ! -- Calculate exact last delt to avoid accumulation errors
       delt = topertim + perlen(kper) - totim
     else
       delt = tsmult(kper) * delt
     end if

Here is the caller graph for this function:

◆ tdis_set_timestep()

subroutine, public tdismodule::tdis_set_timestep

Definition at line 152 of file tdis.f90.

     ! -- modules
     use constantsmodule, only: done, dzero
     use adaptivetimestepmodule, only: isadaptiveperiod, &
                                       ats_set_delt, &
                                       ats_set_endofperiod
     ! -- local
     logical(LGP) :: adaptivePeriod
     ! -- format
     character(len=*), parameter :: fmttsi = &
                                    "(1X,'INITIAL TIME STEP SIZE =',G15.7)"
     !
     ! -- Initialize
     adaptiveperiod = isadaptiveperiod(kper)
     if (kstp == 1) then
       pertim = dzero
       topertim = dzero
     end if
     !
     ! -- Set delt
     if (adaptiveperiod) then
       call ats_set_delt(kstp, kper, pertim, perlen(kper), delt)
     else
       call tdis_set_delt()
       if (kstp == 1) then
         write (iout, fmttsi) delt
       end if
     end if
     !
     ! -- Advance timers and update totim and pertim based on delt
     totimsav = totim
     pertimsav = pertim
     totimc = totimsav
     totim = totimsav + delt
     pertim = pertimsav + delt
     !
     ! -- Set end of period indicator
     endofperiod = .false.
     if (adaptiveperiod) then
       call ats_set_endofperiod(kper, pertim, perlen(kper), endofperiod)
     else
       if (kstp == nstp(kper)) then
         endofperiod = .true.
       end if
     end if
     if (endofperiod) then
       pertim = perlen(kper)
     end if
     !
     ! -- Set end of simulation indicator
     if (endofperiod .and. kper == nper) then
       endofsimulation = .true.
     end if

Here is the call graph for this function:

Here is the caller graph for this function:

◆ tdis_source_dimensions()

subroutine tdismodule::tdis_source_dimensions

Definition at line 526 of file tdis.f90.

     ! -- modules
     use constantsmodule, only: linelength
     use memorymanagerextmodule, only: mem_set_value
     use sourcecommonmodule, only: filein_fname
     use simtdisinputmodule, only: simtdisparamfoundtype
     ! -- local
     type(SimTdisParamFoundType) :: found
     ! -- formats
     character(len=*), parameter :: fmtnper = &
                                    "(1X,I4,' STRESS PERIOD(S) IN SIMULATION')"
     !
     ! -- source dimensions from input context
     call mem_set_value(nper, 'NPER', input_mempath, found%nper)
     !
     ! -- log values to list file
     write (iout, '(1x,a)') 'PROCESSING TDIS DIMENSIONS'
     !
     if (found%nper) then
       write (iout, fmtnper) nper
     end if
     !
     write (iout, '(1x,a)') 'END OF TDIS DIMENSIONS'

Here is the call graph for this function:

Here is the caller graph for this function:

◆ tdis_source_options()

subroutine tdismodule::tdis_source_options

Definition at line 384 of file tdis.f90.

     ! -- modules
     use constantsmodule, only: linelength
     use inputoutputmodule, only: getunit, openfile
     use simmodule, only: store_error, store_error_filename
     use memorymanagerextmodule, only: mem_set_value
     use sourcecommonmodule, only: filein_fname
     use simtdisinputmodule, only: simtdisparamfoundtype
     ! -- local
     type(SimTdisParamFoundType) :: found
     character(len=LINELENGTH), dimension(6) :: time_units = &
       &[character(len=LINELENGTH) :: 'UNDEFINED', 'SECONDS', 'MINUTES', 'HOURS', &
                                      'DAYS', 'YEARS']
     character(len=LINELENGTH) :: fname
     ! -- formats
     character(len=*), parameter :: fmtitmuni = &
       &"(4x,'SIMULATION TIME UNIT IS ',A)"
     character(len=*), parameter :: fmtdatetime0 = &
       &"(4x,'SIMULATION STARTING DATE AND TIME IS ',A)"
     !
     ! -- initialize time unit to undefined
     itmuni = 0
     !
     ! -- source options from input context
     call mem_set_value(itmuni, 'TIME_UNITS', input_mempath, time_units, &
                        found%time_units)
     call mem_set_value(datetime0, 'START_DATE_TIME', input_mempath, &
                        found%start_date_time)
     !
     if (found%time_units) then
       if (itmuni == 0) then
         call store_error('Unrecognized input value for TIME_UNITS option.')
         call store_error_filename(input_fname)
       else
         !
         ! -- adjust to 0-based indexing for itmuni
         itmuni = itmuni - 1
       end if
     end if
     !
     ! -- enforce 0 or 1 ATS6_FILENAME entries in option block
     if (filein_fname(fname, 'ATS6_FILENAME', input_mempath, &
                      input_fname)) then
       inats = getunit()
       call openfile(inats, iout, fname, 'ATS')
     end if
     !
     ! -- log values to list file
     write (iout, '(1x,a)') 'PROCESSING TDIS OPTIONS'
     !
     if (found%time_units) then
       select case (itmuni)
       case (0)
         write (iout, fmtitmuni) 'UNDEFINED'
       case (1)
         write (iout, fmtitmuni) 'SECONDS'
       case (2)
         write (iout, fmtitmuni) 'MINUTES'
       case (3)
         write (iout, fmtitmuni) 'HOURS'
       case (4)
         write (iout, fmtitmuni) 'DAYS'
       case (5)
         write (iout, fmtitmuni) 'YEARS'
       case default
       end select
     else
       write (iout, fmtitmuni) 'UNDEFINED'
     end if
     !
     if (found%start_date_time) then
       write (iout, fmtdatetime0) datetime0
     end if
     !
     write (iout, '(1x,a)') 'END OF TDIS OPTIONS'

Here is the call graph for this function:

Here is the caller graph for this function:

◆ tdis_source_timing()

subroutine tdismodule::tdis_source_timing

Definition at line 553 of file tdis.f90.

     ! -- modules
     use constantsmodule, only: linelength, dzero
     use simmodule, only: store_error_filename, count_errors
     use memorymanagerextmodule, only: mem_set_value
     use sourcecommonmodule, only: filein_fname
     use simtdisinputmodule, only: simtdisparamfoundtype
     ! -- local
     type(SimTdisParamFoundType) :: found
     integer(I4B) :: n
     ! -- formats
     character(len=*), parameter :: fmtheader = &
       "(1X,//1X,'STRESS PERIOD     LENGTH       TIME STEPS', &
        &'     MULTIPLIER FOR DELT',/1X,76('-'))"
     character(len=*), parameter :: fmtrow = &
                                    "(1X,I8,1PG21.7,I7,0PF25.3)"
     !
     ! -- source perioddata from input context
     call mem_set_value(perlen, 'PERLEN', input_mempath, found%perlen)
     call mem_set_value(nstp, 'NSTP', input_mempath, found%nstp)
     call mem_set_value(tsmult, 'TSMULT', input_mempath, found%tsmult)
     !
     ! -- Check timing information
     call check_tdis_timing(nper, perlen, nstp, tsmult)
     !
     ! -- Check for errors
     if (count_errors() > 0) then
       call store_error_filename(input_fname)
     end if
     !
     ! -- log timing
     write (iout, '(1x,a)') 'PROCESSING TDIS PERIODDATA'
     write (iout, fmtheader)
     !
     do n = 1, size(perlen)
       write (iout, fmtrow) n, perlen(n), nstp(n), tsmult(n)
       totalsimtime = totalsimtime + perlen(n)
     end do
     !
     write (iout, '(1x,a)') 'END OF TDIS PERIODDATA'

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ datetime0

character(len=lendatetime), pointer, public tdismodule::datetime0 => null()

Definition at line 41 of file tdis.f90.

41 character(len=LENDATETIME), public, pointer :: datetime0 => null() !< starting date and time for the simulation

◆ delt

real(dp), pointer, public tdismodule::delt => null()

Definition at line 29 of file tdis.f90.

29 real(DP), public, pointer :: delt => null() !< length of the current time step

◆ deltsav

real(dp), pointer, public tdismodule::deltsav => null()

Definition at line 34 of file tdis.f90.

34 real(DP), public, pointer :: deltsav => null() !< saved value for delt, used for subtiming

◆ endofperiod

logical(lgp), pointer, public tdismodule::endofperiod => null()

Definition at line 27 of file tdis.f90.

27 logical(LGP), public, pointer :: endofperiod => null() !< flag indicating end of stress period

◆ endofsimulation

logical(lgp), pointer, public tdismodule::endofsimulation => null()

Definition at line 28 of file tdis.f90.

28 logical(LGP), public, pointer :: endofsimulation => null() !< flag indicating end of simulation

◆ inats

integer(i4b), pointer, public tdismodule::inats => null()

Definition at line 25 of file tdis.f90.

25 integer(I4B), public, pointer :: inats => null() !< flag indicating ats active for simulation

◆ input_fname

character(len=linelength), pointer tdismodule::input_fname => null()

private

Definition at line 43 of file tdis.f90.

43 character(len=LINELENGTH), pointer :: input_fname => null() !< input filename for tdis

◆ input_mempath

character(len=lenmempath), pointer tdismodule::input_mempath => null()

private

Definition at line 42 of file tdis.f90.

42 character(len=LENMEMPATH), pointer :: input_mempath => null() !< input context mempath for tdis

◆ itmuni

integer(i4b), pointer, public tdismodule::itmuni => null()

Definition at line 22 of file tdis.f90.

22 integer(I4B), public, pointer :: itmuni => null() !< flag indicating time units

◆ kper

integer(i4b), pointer, public tdismodule::kper => null()

Definition at line 23 of file tdis.f90.

23 integer(I4B), public, pointer :: kper => null() !< current stress period number

◆ kstp

integer(i4b), pointer, public tdismodule::kstp => null()

Definition at line 24 of file tdis.f90.

24 integer(I4B), public, pointer :: kstp => null() !< current time step number

◆ nper

integer(i4b), pointer, public tdismodule::nper => null()

Definition at line 21 of file tdis.f90.

21 integer(I4B), public, pointer :: nper => null() !< number of stress period

◆ nstp

integer(i4b), dimension(:), pointer, public, contiguous tdismodule::nstp => null()

Definition at line 39 of file tdis.f90.

39 integer(I4B), public, dimension(:), pointer, contiguous :: nstp => null() !< number of time steps in each stress period

◆ perlen

real(dp), dimension(:), pointer, public, contiguous tdismodule::perlen => null()

Definition at line 38 of file tdis.f90.

38 real(DP), public, dimension(:), pointer, contiguous :: perlen => null() !< length of each stress period

◆ pertim

real(dp), pointer, public tdismodule::pertim => null()

Definition at line 30 of file tdis.f90.

30 real(DP), public, pointer :: pertim => null() !< time relative to start of stress period

◆ pertimsav

real(dp), pointer, public tdismodule::pertimsav => null()

Definition at line 36 of file tdis.f90.

36 real(DP), public, pointer :: pertimsav => null() !< saved value for pertim, used for subtiming

◆ readnewdata

logical(lgp), pointer, public tdismodule::readnewdata => null()

Definition at line 26 of file tdis.f90.

26 logical(LGP), public, pointer :: readnewdata => null() !< flag indicating time to read new data

◆ topertim

real(dp), pointer, public tdismodule::topertim => null()

Definition at line 31 of file tdis.f90.

31 real(DP), public, pointer :: topertim => null() !< simulation time at start of stress period

◆ totalsimtime

real(dp), pointer, public tdismodule::totalsimtime => null()

Definition at line 37 of file tdis.f90.

37 real(DP), public, pointer :: totalsimtime => null() !< time at end of simulation

◆ totim

real(dp), pointer, public tdismodule::totim => null()

Definition at line 32 of file tdis.f90.

32 real(DP), public, pointer :: totim => null() !< time relative to start of simulation

◆ totimc

real(dp), pointer, public tdismodule::totimc => null()

Definition at line 33 of file tdis.f90.

33 real(DP), public, pointer :: totimc => null() !< simulation time at start of time step

◆ totimsav

real(dp), pointer, public tdismodule::totimsav => null()

Definition at line 35 of file tdis.f90.

35 real(DP), public, pointer :: totimsav => null() !< saved value for totim, used for subtiming

◆ tsmult

real(dp), dimension(:), pointer, public, contiguous tdismodule::tsmult => null()

Definition at line 40 of file tdis.f90.

40 real(DP), public, dimension(:), pointer, contiguous :: tsmult => null() !< time step multiplier for each stress period

Functions/Subroutines

Variables

Function/Subroutine Documentation

◆ check_tdis_timing()

◆ tdis_allocate_arrays()

◆ tdis_allocate_scalars()

◆ tdis_cr()

◆ tdis_da()

◆ tdis_delt_reset()

◆ tdis_ot()

◆ tdis_set_counters()

◆ tdis_set_delt()

◆ tdis_set_timestep()

◆ tdis_source_dimensions()

◆ tdis_source_options()

◆ tdis_source_timing()

Variable Documentation

◆ datetime0

◆ delt

◆ deltsav

◆ endofperiod

◆ endofsimulation

◆ inats

◆ input_fname

◆ input_mempath

◆ itmuni

◆ kper

◆ kstp

◆ nper

◆ nstp

◆ perlen

◆ pertim

◆ pertimsav

◆ readnewdata

◆ topertim

◆ totalsimtime

◆ totim

◆ totimc

◆ totimsav

◆ tsmult