module common / time More...

Data Types
type	time_manager_component

Functions/Subroutines
subroutine, public	time_manager_init (setup_timeintegration, restart_in_basename)

subroutine, public	time_manager_final ()

subroutine, public	time_manager_advance ()

subroutine, public	time_manager_checkstate ()

subroutine, public	time_manager_report_timeintervals ()

subroutine, public	time_manager_regist_component (tmanager_comp)

Variables
integer, dimension(6), public	time_startdate = (/ -999, 1, 1, 0, 0, 0 /)

real(dp), public	time_startms = 0.0_DP
	[millisec]

real(dp), public	time_startsubsec

integer, public	time_startday

real(dp), public	time_startsec

integer, dimension(6), public	time_enddate

real(dp), public	time_endsubsec

integer, public	time_endday

real(dp), public	time_endsec

real(dp), public	time_durationsec

logical, public	time_doresume

logical, public	time_doend

real(dp), public	time_dtsec_resume

integer, public	time_dstep_resume

Detailed Description

module common / time

Description: Module to manage time with temporal integration

Author: Yuta Kawai, Team SCALE

NAMELIST

PARAM_TIME

name	type	default value	comment
TIME_STARTDATE	integer, dimension(6)	(/ -999, 1, 1, 0, 0, 0 /)
TIME_STARTMS	real(DP)	0.0_DP	[millisec]
TIME_DURATION	real(DP)	UNDEF8
TIME_DURATION_UNIT	character(len=H_SHORT)	"SEC"
TIME_DT	real(DP)	UNDEF8
TIME_DT_UNIT	character(len=H_SHORT)	"SEC"
TIME_DT_RESUME	real(DP)	UNDEF8
TIME_DT_RESUME_UNIT	character(len=H_SHORT)	""
TIME_DT_WALLCLOCK_CHECK	real(DP)	UNDEF8
TIME_DT_WALLCLOCK_CHECK_UNIT	character(len=H_SHORT)	""
TIME_WALLCLOCK_LIMIT	real(DP)	-1.0_DP	Elapse time limit of wall clock time [sec]
TIME_WALLCLOCK_SAFE	real(DP)	0.9_DP	Safety coefficient for elapse time limit

History Output: No history output

Function/Subroutine Documentation

◆ time_manager_init()

subroutine, public scale_time_manager::time_manager_init	(	logical, intent(in), optional	setup_timeintegration,
		character(len=*), intent(in), optional	restart_in_basename )

Definition at line 162 of file scale_time_manager.F90.

 
    use scale_file, only: &
      file_get_attribute
 
    implicit none
 
    logical, intent(in), optional :: setup_TimeIntegration
    character(len=*), intent(in), optional :: restart_in_basename
    
    real(DP)               :: TIME_DURATION                = undef8
    character(len=H_SHORT) :: TIME_DURATION_UNIT           = "SEC"
    real(DP)               :: TIME_DT                      = undef8
    character(len=H_SHORT) :: TIME_DT_UNIT                 = "SEC"
 
    real(DP)               :: TIME_DT_RESUME               = undef8
    character(len=H_SHORT) :: TIME_DT_RESUME_UNIT          = ""
 
    real(DP)               :: TIME_DT_WALLCLOCK_CHECK      = undef8
    character(len=H_SHORT) :: TIME_DT_WALLCLOCK_CHECK_UNIT = ""
 
    namelist /param_time/ &
       time_startdate,               &
       time_startms,                 &
       time_duration,                &
       time_duration_unit,           &
       time_dt,                      &
       time_dt_unit,                 &
       time_dt_resume,               &
       time_dt_resume_unit,          &
       time_dt_wallclock_check,      &
       time_dt_wallclock_check_unit, &
       time_wallclock_limit,         &
       time_wallclock_safe
 
    integer              :: dateday
    real(DP)             :: datesec
    real(DP)             :: cftime(1)
    character(len=H_MID) :: cfunits
   
    character(len=27) :: startchardate
    character(len=27) :: endchardate
   
    integer :: ierr
    integer :: n
    !---------------------------------------------------------------------------
    
    log_newline
    log_info("TIME_manager_setup",*) 'Setup'
 
    !--- read namelist
    rewind(io_fid_conf)
    read(io_fid_conf,nml=param_time,iostat=ierr)
    if( ierr < 0 ) then !--- missing
       log_info("TIME_manager_setup",*) 'Not found namelist. Default used.'
    elseif( ierr > 0 ) then !--- fatal error
       log_error("TIME_manager_setup",*) 'Not appropriate names in namelist PARAM_TIME. Check!'
       call prc_abort
    endif
    log_nml(param_time)
 
    if ( present(setup_timeintegration) ) then
      setup_tinteg_flag = setup_timeintegration
    else
      setup_tinteg_flag = .true.
    end if
 
    if ( setup_tinteg_flag ) then
      if ( time_dt == undef8 ) then
        log_error("TIME_manager_setup",*) 'Not found TIME_DT. STOP.'
        call prc_abort
      endif
      if ( time_duration == undef8 ) then
        log_error("TIME_manager_setup",*) 'Not found TIME_DURATION. STOP.'
        call prc_abort
      endif
            
      if ( time_dt_resume == undef8 ) then
        time_dt_resume = time_duration
      endif
      if ( time_dt_resume_unit == '' ) then
          log_info_cont(*) 'Not found TIME_DT_RESUME_UNIT.        TIME_DURATION_UNIT is used.'
          time_dt_resume_unit = time_duration_unit
      endif
    end if
 
    !--- calculate time
    if ( time_startdate(1) == -999 ) then
      if ( present(restart_in_basename) ) then
        if ( restart_in_basename /= '' ) then ! read start time from the restart data
          call file_get_attribute( restart_in_basename, & ! [IN]
                                   "global",            & ! [IN]
                                   'time_start',        & ! [IN]
                                   cftime(:),           & ! [OUT]
                                   rankid = prc_myrank, & ! [IN]
                                   single = .false.     ) ! [IN]
 
          call file_get_attribute( restart_in_basename, & ! [IN]
                                   "global",            & ! [IN]
                                   'time_units',        & ! [IN]
                                   cfunits,             & ! [OUT]
                                   rankid = prc_myrank, & ! [IN]
                                   single = .false.     ) ! [IN]
 
         dateday = 0
         datesec = calendar_cfunits2sec( cftime(1), cfunits, 0 )
 
         call calendar_adjust_daysec( dateday, datesec )
 
         call calendar_daysec2date( time_startdate,   & ! [OUT]
                                    time_startsubsec, & ! [OUT]
                                    dateday,          & ! [IN]
                                    datesec,          & ! [IN]
                                    0                 ) ! [IN]
        end if
      else
         time_startdate   = (/ 0, 1, 1, 0, 0, 0 /)
         time_startsubsec = 0.0_dp
      endif
    else
      time_startsubsec = time_startms * 1.e-3_dp
    endif
 
    time_offset_year = time_startdate(1)
    
    call calendar_date2daysec( time_startday, time_startsec,                        & ! [OUT]
                               time_startdate(:), time_startms,  time_offset_year   ) ! [IN]
 
    call calendar_date2char( startchardate,                        & ! [OUT]
                             time_startdate(:), time_startsubsec   ) ! [IN]
  
    time_startdaysec  = calendar_combine_daysec( time_startday, time_startsec )
 
    time_nowdate(:)   = time_startdate(:)
    time_nowsubsec    = time_startms
    time_nowday       = time_startday
    time_nowsec       = time_startsec
    time_nowdaysec    = calendar_combine_daysec( time_nowday, time_nowsec )
 
    time_endday       = time_startday
    if (setup_tinteg_flag) then
      call calendar_unit2sec( time_durationsec, time_duration, time_duration_unit )
      time_endsec = time_startsec + time_durationsec
    else
      time_endsec = time_startsec
    end if
 
    call calendar_adjust_daysec( time_endday, time_endsec ) ! [INOUT]
 
    call calendar_daysec2date( time_enddate(:), & ! [OUT]
                               time_endsubsec,  & ! [OUT]
                               time_endday,     & ! [IN]
                               time_endsec,     & ! [IN]
                               time_offset_year ) ! [IN]
 
    call calendar_date2char( endchardate,     & ! [OUT]
                             time_enddate(:), & ! [IN]
                             time_endsubsec   ) ! [IN]
 
    log_newline
    log_info("TIME_manager_setup",*) 'Global date / time setting '
    log_info_cont('(1x,A,A)') 'START Date     : ', startchardate
    log_info_cont('(1x,A,A)') 'END   Date     : ', endchardate
 
    if (setup_tinteg_flag) then
      call calendar_unit2sec( time_dtsec, time_dt, time_dt_unit )
      time_nstep   = int( time_durationsec / time_dtsec )
      time_nowstep = 1
 
      call calendar_unit2sec( time_dtsec_resume, time_dt_resume, time_dt_resume_unit )
      time_dstep_resume = nint( time_dtsec_resume / time_dtsec )
      time_res_resume = time_dstep_resume - 1
    else
      time_dtsec = 1.0_rp
    end if
 
    !--
    time_manager_component_num = 0
    do n=1, time_manager_component_max_num
      nullify( time_manager_comp_ptr_list(n)%ptr )
    end do
    
    !--
    time_wallclock_start = prc_mpitime()
 
    if ( time_wallclock_limit > 0.0_dp ) then
      log_newline
      log_info("TIME_manager_setup",*) 'Wall clock time limit of execution is specified.'
 
      if ( time_dt_wallclock_check == undef8 ) then
        log_info_cont(*) 'Not found TIME_DT_WALLCLOCK_CHECK. TIME_DT is used.'
        time_dtsec_wallclock_check = time_dtsec
     else
        if ( time_dt_wallclock_check_unit == '' ) then
           log_info_cont(*) 'Not found TIME_DT_WALLCLOCK_CHECK_UNIT. TIME_DURATION_UNIT is used.'
           time_dt_wallclock_check_unit = time_duration_unit
        endif
        call calendar_unit2sec( time_dtsec_wallclock_check, time_dt_wallclock_check, time_dt_wallclock_check_unit )
        time_dtsec_wallclock_check = max( time_dtsec_wallclock_check, time_dtsec )
     endif
 
     time_dstep_wallclock_check = int( time_dtsec_wallclock_check / time_dtsec )
 
     time_wallclock_safe    = max( min( time_wallclock_safe, 1.0_dp ), 0.0_dp )
     time_wallclock_safelim = time_wallclock_limit * time_wallclock_safe
 
     log_info_cont('(1x,A,F10.1,A)')      'This job stops after ', time_wallclock_safelim, ' seconds.'
     log_info_cont('(1x,A,F10.3,A,I8,A)') 'Time interval for check     : ', time_dtsec_wallclock_check, &
                                          ' (step interval=', time_dstep_wallclock_check, ')'
    end if
 
    return

References time_dstep_resume, time_dtsec_resume, time_durationsec, time_enddate, time_endday, time_endsec, time_endsubsec, time_startdate, time_startday, time_startms, time_startsec, and time_startsubsec.

Referenced by mod_dg_driver::dg_driver(), and mod_dg_prep::dg_prep().

◆ time_manager_final()

subroutine, public scale_time_manager::time_manager_final

Definition at line 378 of file scale_time_manager.F90.

    implicit none
 
    integer :: n
    !---------------------------------------------------------------------------
 
    do n=1, time_manager_component_num
      nullify( time_manager_comp_ptr_list(n)%ptr )
    end do
    time_manager_component_num = 0
 
    return

Referenced by mod_dg_driver::dg_driver(), and mod_dg_prep::dg_prep().

◆ time_manager_advance()

subroutine, public scale_time_manager::time_manager_advance

Definition at line 392 of file scale_time_manager.F90.

    implicit none
    !---------------------------------------------------------------------------
 
    time_nowstep = time_nowstep + 1
    time_nowday  = time_startday
    time_nowsec  = time_startsec + real(time_nowstep-1,kind=dp) * time_dtsec
    
    ! reallocate day & sub-day
    call calendar_adjust_daysec( time_nowday, time_nowsec ) ! [INOUT]
  
    call calendar_daysec2date( time_nowdate(:), time_nowsubsec,           & ! [OUT]
                               time_nowday, time_nowsec, time_offset_year ) ! [IN]
  
    time_nowdaysec = calendar_combine_daysec( time_nowday, time_nowsec )
  
    if (time_nowstep > time_nstep) then
      time_doend = .true.
    end if
 
    return

References time_doend, time_startday, and time_startsec.

Referenced by mod_dg_driver::dg_driver(), and mod_dg_prep::dg_prep().

◆ time_manager_checkstate()

subroutine, public scale_time_manager::time_manager_checkstate

Definition at line 415 of file scale_time_manager.F90.

    use scale_calendar, only: calendar_date2char    
    implicit none
 
    integer :: n
    type(TIME_manager_component), pointer :: tm_comp
 
    real(DP)          :: WALLCLOCK_elapse
    character(len=27) :: nowchardate
    logical           :: TO_STDOUT
    !---------------------------------------------------------------------------
 
    do n=1, time_manager_component_num
      tm_comp => time_manager_comp_ptr_list(n)%ptr
      call tm_comp%Check_state()
    end do
 
    time_doresume   = .false.
    time_res_resume = time_res_resume + 1
 
    if (time_res_resume == time_dstep_resume) then
      time_doresume   = .true.
      time_res_resume =  0
    end if
 
    !----
 
    to_stdout = .false.
    if ( io_step_to_stdout > 0 ) then
       if( mod(time_nowstep-1,io_step_to_stdout) == 0 ) to_stdout = .true.
    endif
 
    call calendar_date2char( nowchardate,     & ! [OUT]
                             time_nowdate(:), & ! [IN]
                             time_nowsubsec   ) ! [IN]
 
    wallclock_elapse = prc_mpitime() - time_wallclock_start
 
    log_newline
    if ( time_wallclock_limit > 0.0_dp ) then
       log_progress('(1x,2A,2(A,I7),2(A,F10.1))') 'TIME: ', nowchardate,' STEP:',time_nowstep, '/', time_nstep, &
                                                                 ' WCLOCK:', wallclock_elapse, '/', time_wallclock_safelim
       if ( prc_universal_ismaster .AND. to_stdout ) then ! universal master node
          write(*,'(1x,2A,2(A,I7),2(A,F10.1))') 'TIME: ', nowchardate,' STEP:',time_nowstep, '/', time_nstep, &
                                                ' WCLOCK:', wallclock_elapse, '/', time_wallclock_safelim
       endif
    else
       log_progress('(1x,2A,2(A,I7),A,F10.1)') 'TIME: ', nowchardate,' STEP:',time_nowstep, '/', time_nstep, &
                                                              ' WCLOCK:', wallclock_elapse
       if ( prc_universal_ismaster .AND. to_stdout ) then ! universal master node
          write(*,'(1x,2A,2(A,I7),A,F10.1)') 'TIME: ', nowchardate,' STEP:',time_nowstep, '/', time_nstep, &
                                             ' WCLOCK:', wallclock_elapse
       endif
    endif
 
    return

References time_doresume, and time_dstep_resume.

Referenced by mod_dg_driver::dg_driver(), and mod_dg_prep::dg_prep().

◆ time_manager_report_timeintervals()

subroutine, public scale_time_manager::time_manager_report_timeintervals

Definition at line 473 of file scale_time_manager.F90.

    implicit none
 
    integer :: n, p
    type(TIME_manager_component), pointer :: tm_comp
    type(TIME_manager_process), pointer :: tm_process
    !-------------------------------------------------------------------
 
    log_newline
    log_info("TIME_manager_report_timeintervals",*) 'Time interval for each component (sec.)'
 
    do n=1, time_manager_component_num
      tm_comp => time_manager_comp_ptr_list(n)%ptr
      log_info_cont(*) trim(tm_comp%comp_name)
      do p=1, tm_comp%process_num
        tm_process => tm_comp%process_list(p)
        log_info_cont('(1x,A,F10.3)')        trim(tm_process%process_name)//' (time)             : ', tm_process%dtsec
        if (tm_process%inner_itr_num > 1) then
          log_info_cont('(1x,A,I10)') ' (step)             : ', tm_process%inner_itr_num 
        end if
        log_info_cont('(1x,A,I8,A)')  ' (step interval=', tm_process%dstep,    ')' 
      end do
    end do
 
    log_newline
    log_info_cont(*)                     'Time interval for restart (sec.)'
 
    do n=1, time_manager_component_num
      tm_comp => time_manager_comp_ptr_list(n)%ptr
      log_info_cont('(1x,A,F10.3,A,I8,A)') trim(tm_comp%comp_name)//' variables       : ', tm_comp%dtsec_restart, &
                                         ' (step interval=', tm_comp%dstep_restart, ')'
    end do
    log_info_cont('(1x,A,F10.3,A,I8,A)') 'Resume                      : ', time_dtsec_resume, &
    ' (step interval=', time_dstep_resume,        ')'
 
    return

References time_dstep_resume, and time_dtsec_resume.

Referenced by mod_dg_driver::dg_driver().

◆ time_manager_regist_component()

subroutine, public scale_time_manager::time_manager_regist_component ( type(time_manager_component), intent(in), target tmanager_comp )

Definition at line 511 of file scale_time_manager.F90.

    implicit none
 
    type(TIME_manager_component), intent(in), target :: tmanager_comp
    !------------------------------------------------------------------------
 
    time_manager_component_num = time_manager_component_num + 1
    if (time_manager_component_num > time_manager_component_max_num) then
      log_error("TIME_manager_regist_component",*) 'The number of TIME_manager_component registered exceeds ', &
        time_manager_component_num, time_manager_component_max_num
      call prc_abort
    end if
 
    time_manager_comp_ptr_list(time_manager_component_num)%ptr => tmanager_comp
    return