dc_clock::dcclockpredict Interface Reference

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

Detailed Description

Definition at line 164 of file dc_clock.f90.

Member Function/Subroutine Documentation

dcclockpredict0()

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

Display predicted CPU time and completion date

From CLOCK variable clk and progress, displays predicted CPU time and completion date as follows:

########## 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

Give progress a value from 0 to 1. 0 is program start, 1 is end. (For example, give 0.5 when the program is half done.)

Note: The "prediction" is calculated by a simple algorithm from elapsed time and progress, so it is not an accurate prediction. Use as a guide only.

Specify the output unit number in unit. If unit is not given, output goes to standard output.

If clk has not been initialized by DCClockCreate, an error is raised. If err is provided, .true. is returned in err and the program continues.

Parameters

[in]	clk	CLOCK type variable
[in]	progress	Progress value (0.0 to 1.0)
[in]	unit	Output unit number (optional). Default: standard output.
[out]	err	Error flag (optional). .true. if error occurred.

Definition at line 1137 of file dc_clock.f90.

    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
    logical:: initflag_mpi
    integer:: err_mpi, myrank_mpi
    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 mpi_initialized(initflag_mpi, err_mpi)
    if ( initflag_mpi ) then
      call mpi_comm_rank(mpi_comm_world, myrank_mpi, err_mpi)
      if ( myrank_mpi /= 0 ) goto 999
    end if
    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)

References dc_trace::beginsub(), dc_trace::dbgmessage(), dc_error::dc_enotinit, dc_error::dc_noerr, dc_types::dp, dc_trace::endsub(), dc_types::stdout, and dc_error::storeerror().

Here is the call graph for this function:

---

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

• /build/gtool5-1.0.0~rc5/debian/build-parallel/src/dc_utils/dc_clock.f90