dc_clock::putline Interface Reference

Public Member Functions
subroutine	dcclockputline0 (clk, unit, indent, err)

Detailed Description

Definition at line 178 of file dc_clock.f90.

Member Function/Subroutine Documentation

dcclockputline0()

subroutine dc_clock::putline::dcclockputline0	(	type(clock), intent(in)	clk,
		integer, intent(in), optional	unit,
		character(*), intent(in), optional	indent,
		logical, intent(out), optional	err
	)

Display CLOCK variable information

Displays information about a CLOCK type variable. 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]	unit	Output unit number (optional). Default: standard output.
[in]	indent	Indent of displayed messages (optional)
[out]	err	Error flag (optional). .true. if error occurred.

Definition at line 604 of file dc_clock.f90.

    use dc_types, only: stdout
    use dc_message, only: messagenotify
    use dc_string, only: printf, tochar, cprintf
    use dc_date, only: evalsec, evalday, tochar
    use dc_error, only: storeerror, dc_enotinit, dc_noerr
    use dc_types, only: dp
    implicit none
    type(CLOCK), intent(in):: clk
    integer, intent(in), optional:: unit
    character(*), intent(in), optional:: indent
    logical, intent(out), optional:: err
    integer:: out_unit
    character(STRING):: cause_c
    integer:: stat
    integer:: indent_len
    character(STRING):: indent_str
    character(*), parameter:: subname = 'DCClockPutLine'
  continue
    call beginsub(subname)
    stat = dc_noerr
    cause_c = 'CLOCK'
    if (.not. clk % initialized) then
      call messagenotify('W', subname, 'Call Create before PutLine in dc_clock.')
      call dbgmessage('Ignored because input argument was not initialized.')
      stat = dc_enotinit
      goto 999
    end if
    if (present(unit)) then
      out_unit = unit
    else
      out_unit = stdout
    end if
    indent_len = 0
    indent_str = ''
    if (present(indent)) then
      if (len(indent) /= 0) then
        indent_len = len(indent)
        indent_str(1:indent_len) = indent
      end if
    end if
    call printf(out_unit, &
      & indent_str(1:indent_len) // &
      & '#<CLOCK:: @name=%c @clocking=%y @elapsed_time=%f sec. %c @start_date=%c>', &
      & c1=trim(clk % name), l=(/clk % start_time > 0.0_dp/), &
      & d=(/clk % elapsed_time/), &
      & c2=trim(fit_unit_value(clk % elapsed_time)), &
      & c3=trim(tochar(clk % start_date)))
    call dbgmessage('name=%c, output to device number %d', &
      & c1=trim(clk % name), i=(/out_unit/))
999 continue
    call storeerror(stat, subname, err, cause_c)
    call endsub(subname)

---

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