dc_clock::dcclockresult Interface Reference

Public Member Functions
subroutine	dcclockresult0 (clks, unit, total_auto, clk_total, total_name, err)

Detailed Description

Definition at line 148 of file dc_clock.f90.

Member Function/Subroutine Documentation

dcclockresult0()

subroutine dc_clock::dcclockresult::dcclockresult0	(	type(clock), dimension(:), intent(in)	clks,
		integer, intent(in), optional	unit,
		logical, intent(in), optional	total_auto,
		type(clock), intent(in), optional	clk_total,
		character(*), intent(in), optional	total_name,
		logical, intent(out), optional	err
	)

Display CPU time summary

Displays the total CPU time summary. Pass an array of CLOCK variables to clks. This is intended to be called at the end of the program. Specify the output unit number in unit. If unit is not given, output goes to standard output.

If total_auto is .true., the sum of all clks is automatically displayed. If clk_total is given, it takes precedence.

If clk_total is given, this CLOCK variable is displayed as the total.

If total_name is given, this string is output at the beginning of the summary.

If any clk in clks 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]	clks	Array of CLOCK type variables
[in]	unit	Output unit number (optional). Default: standard output.
[in]	total_auto	If .true., automatically display sum of all clks (optional)
[in]	clk_total	CLOCK variable to display as total (optional)
[in]	total_name	String to output at the beginning of summary (optional)
[out]	err	Error flag (optional). .true. if error occurred.

Definition at line 712 of file dc_clock.f90.

    use dc_types, only: stdout, string, dp
    use dc_message, only: messagenotify
    use dc_string, only: printf, tochar, cprintf
    use dc_date, only: evalsec
    use dc_error, only: storeerror, dc_enotinit, dc_noerr
    implicit none
    type(CLOCK), intent(in):: clks(:)
    integer, intent(in), optional:: unit
    logical, intent(in), optional:: total_auto
    type(CLOCK), intent(in), optional:: clk_total
    logical, intent(out), optional:: err
    character(*), intent(in), optional:: total_name
    integer:: out_unit, i, clks_size, ra
    character(20):: clk_name
    integer:: name_len
    character(STRING):: cause_c
    character(STRING):: total_name_work
    type(CLOCK):: clk_auto_total
    logical:: total_print_complete
    real(DP):: elapsed_time_val_cor
    integer:: stat
    character(*), parameter:: total_time_mes = '       TOTAL TIME = '
    integer:: myrank_mpi, nprocs_mpi
    character(*), parameter:: subname = 'DCClockResult'
  continue
    call beginsub(subname)
    stat = dc_noerr
    cause_c = 'CLOCK'
    clks_size = size(clks)
    do i = 1, clks_size
      if (.not. clks(i) % initialized) then
        call messagenotify('W', subname, 'Call Create before Result in dc_clock.')
        call dbgmessage('Ignored because input argument was not initialized.')
        stat = dc_enotinit
        goto 999
      end if
    end do
    if (present(unit)) then
      out_unit = unit
    else
      out_unit = stdout
    end if
    if (present(total_name)) then
      total_name_work = ' (' // trim(total_name) // ')'
    else
      total_name_work = ''
    end if
    myrank_mpi = -1
    nprocs_mpi = 1
    do ra = 0, nprocs_mpi - 1
      call printf(out_unit, '')
      if ( myrank_mpi < 0 ) then
        call printf(out_unit, &
          & ' ############## CPU TIME SUMMARY%c################', &
          & c1=trim(total_name_work) // ' ')
      else
        call printf(out_unit, &
          & ' ####### CPU TIME SUMMARY%c#### [rank=%06d] ####', &
          & c1=trim(total_name_work) // ' ', &
          & i = (/myrank_mpi/) )
      end if
      do i = 1, clks_size
        clk_name = ''
        name_len = min(len(clk_name), len_trim(clks(i) % name))
        if (name_len > 0) then
          clk_name(1:name_len) = clks(i) % name(1:name_len)
        end if
        elapsed_time_val_cor = clks(i) % elapsed_time
        if (elapsed_time_val_cor < 0.0_dp) elapsed_time_val_cor = 0.0_dp
        call printf(out_unit, &
          & ' %c%c  %c', c1=clk_name, &
          & c2=trim(result_value_form(elapsed_time_val_cor)), &
          & c3=trim(fit_unit_value(clks(i) % elapsed_time)))
      end do
      total_print_complete = .false.
      if (present(clk_total)) then
        if (clk_total % initialized) then
          call printf(out_unit, &
            & ' ------------------------------------------------')
          elapsed_time_val_cor = clk_total % elapsed_time
          if (elapsed_time_val_cor < 0.0_dp) elapsed_time_val_cor = 0.0_dp
          call printf(out_unit, &
            & ' %c%c  %c', c1=total_time_mes, &
            & c2=trim(result_value_form(elapsed_time_val_cor)), &
            & c3=trim(fit_unit_value(clk_total % elapsed_time)))
          total_print_complete = .true.
        end if
      end if
      if (present(total_auto) .and. .not. total_print_complete) then
        if (total_auto) then
          clk_auto_total = clks(1)
          if (clks_size > 1) then
            do i = 2, clks_size
              clk_auto_total = clk_auto_total + clks(i)
            end do
          end if
          call printf(out_unit, &
            & ' ------------------------------------------------')
          elapsed_time_val_cor = clk_auto_total % elapsed_time
          if (elapsed_time_val_cor < 0.0_dp) elapsed_time_val_cor = 0.0_dp
          call printf(out_unit, &
            & ' %c%c  %c', c1=total_time_mes, &
            & c2=trim(result_value_form(elapsed_time_val_cor)), &
            & c3=trim(fit_unit_value(clk_auto_total % elapsed_time)))
        end if
      end if
      call dbgmessage('total results, output to device number %d', &
        & i=(/out_unit/))
    end do
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, dc_error::storeerror(), dc_types::string, and dc_types::token.

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-serial/src/dc_utils/dc_clock.f90