dc_clock::predict Interface Reference

Private Member Functions
subroutine	dcclockpredict0 (clk, progress, unit, err)

Detailed Description

Definition at line 208 of file dc_clock.f90.

Member Function/Subroutine Documentation

dcclockpredict0()

subroutine dc_clock::predict::dcclockpredict0 ( type(clock), intent(in)  clk, real, intent(in)  progress, integer, intent(in), optional  unit, logical, intent(out), optional  err  )

private

Definition at line 855 of file dc_clock.f90.

    !
    !=== プログラムが終了するまでの予測 CPU 時間, および日時を表示
    !
    ! CLOCK 変数 *clk* と *progress* から, プログラムが
    ! 終了するまでの予測 CPU 時間, および日時を以下のように表示します.
    !
    !     ########## PREDICTION OF CALCULATION ###########
    !     Start Date             2007-03-08T16:49:25+09:00
    !     Current Date           2007-03-08T16:49:27+09:00
    !     Progress     66.67%  [****************         ]
    !     Remaining CPU TIME      0.100000E+01
    !     Completion Date        2007-03-08T16:49:28+09:00
    !
    ! 第2引数である *progress* には 0 〜 1 までの値を与えてください.
    ! プログラムの開始時を 0, 終了時を 1 とします. (例えば,
    ! プログラムが半分進んだ時には 0.5 を与えます).
    !
    ! ここで行う「予測」とは, これまでの経過時間および
    ! 終了したプログラムの分量から単純なアルゴリズムで割り出している
    ! ものなので, 正確な予測値を返すわけではありません.
    ! あくまで目安として利用してください.
    !
    ! 引数 *unit* には出力先の装置番号を
    ! 与えてください. *unit* を与えない場合, 標準出力へ表示されます.
    !
    ! 第一引数 *clk* に対して DCClockCreate による初期化が行われていない場合,
    ! エラーを発生させます. *err* を与える場合には *err* に .true. が返り,
    ! プログラムは続行されます.
    !
    use dc_types, only: stdout, dp
    use dc_message, only: messagenotify
    use dc_string, only: tochar, cprintf, printf
    use dc_error, only: storeerror, dc_enotinit, dc_noerr
    use dc_date_types, only: dc_difftime, dc_datetime
    use dc_date, only: operator(+), dcdatetimecreate, tochar, evalsec, &
      & dcdifftimecreate
    implicit none
    type(clock), intent(in):: clk
    real, intent(in):: progress
    integer, intent(in), optional:: unit
    logical, intent(out), optional:: err
    character(STRING):: cause_c
    integer:: stat, out_unit
    type(dc_difftime):: remain_diff
    type(dc_datetime):: comp_date, cur_date
    character(7):: prog_percent
    character(25):: prog_bar
    integer:: prog_bar_ptr
    real:: prog_valid
    character(*), parameter:: subname = 'DCClockPredict'
  continue
    call beginsub(subname)
    stat = dc_noerr
    cause_c = 'CLOCK'
    if (.not. clk % initialized) then
      call messagenotify('W', subname, 'Call Create before Predict in dc_clock.')
      call dbgmessage('Ignored because input argument was not initialized.')
      stat = dc_enotinit
      goto 999
    end if
    if (progress <= 0.0) then
      call messagenotify('W', subname, 'Specify 0.0 -- 1.0 value to "progress"')
      return
    elseif (progress > 1.0) then
      call messagenotify('W', subname, 'Over 1.0 value to "progress" was modified to 1.0')
      prog_valid = 1.0
    else
      prog_valid = progress
    end if
    if (present(unit)) then
      out_unit = unit
    else
      out_unit = stdout
    end if
    call dcdifftimecreate( remain_diff, &
      & sec = real(nint(EvalSec(clk) / prog_valid * (1.0 - prog_valid)), DP) )
    call dcdatetimecreate(cur_date)
    comp_date = cur_date + remain_diff
    prog_percent = ''
    prog_percent = adjustr(trim(printf_g5_2(real(prog_valid * 100, dp))) // '%')
    prog_bar = ''
    prog_bar_ptr = int(prog_valid * 25)
    if (prog_bar_ptr > 0) prog_bar(1:prog_bar_ptr) = '*************************'
    call printf(out_unit, '')
    call printf(out_unit, &
      & ' ########## PREDICTION OF CALCULATION ###########')
    call printf(out_unit, &
      & ' Start Date             %c', c1=trim(tochar(clk % start_date)))
    call printf(out_unit, &
      & ' Current Date           %c', c1=trim(tochar(cur_date)))
    call printf(out_unit, &
      & ' Progress     %c [%c]', c1=prog_percent, c2=prog_bar)
    call printf(out_unit, &
      & ' Remaining CPU TIME   %c %c', &
      & c1=trim(result_value_form(evalsec(remain_diff))), &
      & c2=trim(fit_unit_value(0.0_dp, remain_diff)))
    call printf(out_unit, &
      & ' Completion Date        %c', c1=trim(tochar(comp_date)))
999 continue
    call storeerror(stat, subname, err, cause_c)
    call endsub(subname)

---

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

• dc_utils/dc_clock.f90