mod_clock Module Reference

Data Types
type	watch
interface	watch_lap

Functions/Subroutines
subroutine	watch_init (MYWATCH)
real(dp) function	watch_time (MYWATCH)
subroutine	watch_reset (MYWATCH)
subroutine	watch_lap_noprint (MYWATCH)
subroutine	watch_start_lap (MYWATCH)
subroutine	watch_stop_lap (MYWATCH)
subroutine	watch_report (MYWATCH, UNIT, MSG)
subroutine	watch_lap_print (MYWATCH, UNIT, MSG)
subroutine	gettime (INSTRING, INSECS)
subroutine	get_timestamp (TS)
subroutine	report_time (IINT, ISTART, IEND, STIME)

Variables
type(watch)	report_watch

Function/Subroutine Documentation

get_timestamp()

subroutine mod_clock::get_timestamp

(

character(len=*)

TS

)

Definition at line 322 of file mod_clock.f90.

  CHARACTER(LEN=*)  TS
  CHARACTER(LEN=8)  D
  CHARACTER(LEN=10) T
                                                                                      
  CALL date_and_time ( date=d,time=t )
  ts = d(7:8)//'/'//d(5:6)//'/'//d(1:4)//'   '//t(1:2)//':'//t(3:4)

Here is the caller graph for this function:

gettime()

subroutine mod_clock::gettime	(	character(len=13), intent(inout)	INSTRING,
		integer, intent(in)	INSECS
	)

Definition at line 279 of file mod_clock.f90.

   IMPLICIT NONE
   INTEGER, INTENT(IN) :: INSECS 
   CHARACTER(LEN=13), INTENT(INOUT) :: INSTRING
   CHARACTER(LEN=4)  :: S0
   CHARACTER(LEN=2)  :: S1,S2,S3
   INTEGER :: DTCP,HTCP,MTCP,STCP
 
   dtcp = insecs/(3600*24)
   htcp = mod(insecs,(3600*24))/3600
   mtcp = mod(insecs,(3600))/60
   stcp = insecs - (dtcp*3600*24 + htcp*3600 + mtcp*60)

   IF(dtcp >= 10000 ) then
      
      instring = "> 10000 DAYS"
      return
      
   else if (dtcp < 0) THEN
      
      instring = " < 0 DAYS?"
      return
      
   else
      
      WRITE(s0,"(I4.4)")int(dtcp)
      
   END IF
   
   WRITE(s1,"(I2.2)")int(htcp)
   
   WRITE(s2,"(I2.2)")int(mtcp)
   
   WRITE(s3,"(I2.2)")int(stcp)
   

   instring = s0//":"//s1//":"//s2//":"//s3
   

Here is the caller graph for this function:

report_time()

subroutine mod_clock::report_time	(	integer(itime), intent(in)	IINT,
		integer(itime), intent(in)	ISTART,
		integer(itime), intent(in)	IEND,
		type(time), intent(in)	STIME
	)

Definition at line 334 of file mod_clock.f90.

   IMPLICIT NONE
   INTEGER(itime), INTENT(IN) :: IINT,ISTART,IEND
   Type(TIME),INTENT(IN) :: STIME
   REAL(SP) :: TTCP,TAVE
   CHARACTER(LEN=80)  :: SIMTIME,FINTIME 
   CHARACTER(LEN=22) :: PCOMP
   INTEGER :: I,ICMP,ICMP2
   INTEGER(ITIME) :: BIG_COUNT
   LOGICAL, SAVE :: INITIALIZED

   real(DP):: tmp, seconds
   integer :: hours, minutes
   Character(len=2) :: h, m
   Character(Len=9) :: s
   Character(Len=6) :: d

   IF(.not. initialized) THEN
      CALL watch_init(report_watch)

      tave = -1.0_sp
      fintime = "   UNKNOWN"
      initialized = .true.
      
   ELSE
      !
      !  CALCULATE CURRENT TIME
      !
      CALL watch_lap(report_watch)
      
      !
      !  CALCULATE AVERAGE TIME/ITERATION
      !
      big_count = report_watch%COUNT_CURRENT - report_watch%COUNT_0
      IF (big_count < 0) big_count = big_count + report_watch%COUNT_MAX
      
      tave = dble(big_count) / dble(report_watch%COUNT_RATE * report_watch%LAP_COUNT)
      
      IF(tave < 0) tave = 0.0_sp
      
      !
      !  CALCULATE TIME TO COMPLETION
      !
      ttcp = tave*(iend-iint)
      
      CALL gettime(fintime,int(ttcp))
      
   END IF

!
!  CALCULATE COMPLETION PERCENTAGE GRAPHIC
!
!   IF(MOD(IINT,1) /= 0) RETURN
   icmp = int( 100.*float(iint-istart+1)/float(iend-istart+1)) 
   icmp2 = icmp/5
   pcomp = " "
   pcomp(1:1)  = "|"
   pcomp(22:22) = "|"

   DO i=2,icmp2+1
     pcomp(i:i) = "="
   END DO

   if (use_real_world_time) then
      !  Get the date and time of the current iterationr
      simtime = write_datetime(stime,6,"UTC")

      
      !
      !  REPORT
      !
      IF(mod(iint-1,10_dp) ==0) THEN
         WRITE(ipt,102)
      END IF
      WRITE(ipt,101)iint,simtime,fintime,tave,pcomp
      
   else
      
      tmp = real(stime%MuSOD,dp) / real(million,dp)
      
      hours = tmp/3600
      minutes = (tmp-hours*3600)/60
      seconds = mod(tmp,60.0_dp)
      
      write(d,'(i6.6)') stime%mjd
      write(h,'(i2.2)') hours
      write(m,'(i2.2)') minutes
      write(s,'(F9.6)') seconds

      simtime = "D"//d//"T"//h//":"//m//":"//s
      IF(mod(iint-1,10_dp) ==0) THEN
         WRITE(ipt,103)
      END IF

      WRITE(ipt,101)iint,simtime,fintime,tave,pcomp
   end if

   return
101 FORMAT(1x,"!",i7,3x,a26,3x,a13,3x,f8.4,2x,a22)  
102 FORMAT(1x,"!   IINT ",6x,"  SIMTIME(UTC)  ",9x," FINISH IN ",5x," SECS/IT ",1x," PERCENT COMPLETE   ")  
103 FORMAT(1x,"!   IINT ",6x,"  SIMTIME  ",14x," FINISH IN ",5x," SECS/IT ",1x," PERCENT COMPLETE   ")  

Here is the call graph for this function:

Here is the caller graph for this function:

watch_init()

subroutine mod_clock::watch_init

(

type(watch)

MYWATCH

)

Definition at line 116 of file mod_clock.f90.

  IMPLICIT NONE
  TYPE(WATCH) :: MYWATCH
  
  mywatch%COUNT_RATE    = 0
  mywatch%COUNT_MAX     = 0
  mywatch%COUNT_CURRENT = 0
  mywatch%COUNT_LAST    = 0
  mywatch%COUNT_0        = 0
  mywatch%Lap_Count     = 0

 CALL system_clock (mywatch%COUNT_CURRENT, mywatch%COUNT_RATE, mywatch%COUNT_MAX)
 
 mywatch%COUNT_0     = mywatch%COUNT_CURRENT
 mywatch%COUNT_LAST = mywatch%COUNT_CURRENT

     IF(mywatch%COUNT_MAX == 0) CALL fatal_error &
          & ("MOD_CLOCK: FORTRAN DOES NOT RECOGNIZE YOUR SYSTEM CLOCK!",&
          & "INTIRINISIC, SYSTEM_CLOCK returned COUNT_MAX==0")

     IF(mywatch%COUNT_RATE .LE. 0) CALL fatal_error &
          & ("MOD_CLOCK: FORTRAN DOES NOT RECOGNIZE YOUR SYSTEM CLOCK!",&
          & .LE."INTIRINISIC, SYSTEM_CLOCK returned COUNT_RATE  0")

     IF(mywatch%COUNT_0 .LT. 0) CALL fatal_error &
          & ("MOD_CLOCK: FORTRAN DOES NOT RECOGNIZE YOUR SYSTEM CLOCK!",&
          & .LT."INTIRINISIC, SYSTEM_CLOCK returned COUNT  0")

Here is the call graph for this function:

Here is the caller graph for this function:

watch_lap_noprint()

subroutine mod_clock::watch_lap_noprint

(

type(watch)

MYWATCH

)

Definition at line 181 of file mod_clock.f90.

     IMPLICIT NONE  
     TYPE(WATCH) :: MYWATCH

     mywatch%COUNT_LAST = mywatch%COUNT_CURRENT
     CALL system_clock(mywatch%COUNT_CURRENT)
     mywatch%LAP_Count = mywatch%LAP_Count + 1

Here is the caller graph for this function:

watch_lap_print()

subroutine mod_clock::watch_lap_print	(	type(watch)	MYWATCH,
		integer, intent(in)	UNIT,
		character(len=*), intent(in)	MSG
	)

Definition at line 249 of file mod_clock.f90.

     IMPLICIT NONE  
     

     TYPE(WATCH) :: MYWATCH
     integer, intent(in) :: unit
     Character(len=*), intent(in) :: MSG
     INTEGER(ITIME) :: BIG_COUNT
     REAL(DP) :: LAP_TIME
     Character(len=16)  :: ltime
     

     CALL watch_lap_noprint(mywatch)
     big_count = mywatch%COUNT_CURRENT - mywatch%COUNT_LAST
     IF (big_count < 0) big_count = big_count + mywatch%COUNT_MAX

     lap_time = dble(big_count) / dble(mywatch%COUNT_RATE)

     write(ltime,'(F16.6)') lap_time

     write(unit,*) "! === "//trim(msg)//" ==="
     write(unit,*) "! Last Lap Time(seconds):"//trim(adjustl(ltime))
     write(unit,*) "! ==============================="
  

Here is the call graph for this function:

watch_report()

subroutine mod_clock::watch_report	(	type(watch)	MYWATCH,
		integer, intent(in)	UNIT,
		character(len=*), intent(in)	MSG
	)

Definition at line 219 of file mod_clock.f90.

     IMPLICIT NONE  
     

     TYPE(WATCH) :: MYWATCH   
     integer, intent(in) :: unit
     Character(len=*), intent(in) :: MSG
     INTEGER(ITIME) :: BIG_COUNT
     Character(len=16)  :: lcnt,ltime
     REAL(DP) :: AVG_TIME

     write(lcnt,'(I8.8)')mywatch%LAP_COUNT

     big_count = mywatch%COUNT_CURRENT - mywatch%COUNT_0
     IF (big_count < 0) big_count = big_count + mywatch%COUNT_MAX

     avg_time = dble(big_count) / dble(mywatch%COUNT_RATE * mywatch%LAP_COUNT)

     write(ltime,'(F16.6)') avg_time

     write(unit,*) "! === "//trim(msg)//" ==="
     write(unit,*) "! Average Lap Time(seconds):"//trim(adjustl(ltime))//"; &
          &Lap Count:"//trim(adjustl(lcnt))
     write(unit,*) "! ==============================="
     
  

Here is the caller graph for this function:

watch_reset()

subroutine mod_clock::watch_reset

(

type(watch)

MYWATCH

)

Definition at line 167 of file mod_clock.f90.

     IMPLICIT NONE  
     TYPE(WATCH) :: MYWATCH
     
     CALL system_clock(mywatch%COUNT_CURRENT)
     mywatch%LAP_Count = 0
     mywatch%Count_LAST = mywatch%COUNT_CURRENT
     mywatch%Count_0     = mywatch%COUNT_CURRENT

watch_start_lap()

subroutine mod_clock::watch_start_lap

(

type(watch)

MYWATCH

)

Definition at line 194 of file mod_clock.f90.

     IMPLICIT NONE  
     TYPE(WATCH) :: MYWATCH

     CALL system_clock(mywatch%COUNT_CURRENT)
     !IGNORE TIME SINCE LAST STOP
     mywatch%Count_0 =mywatch%Count_0 + (mywatch%COUNT_CURRENT - mywatch%COUNT_LAST)

Here is the caller graph for this function:

watch_stop_lap()

subroutine mod_clock::watch_stop_lap

(

type(watch)

MYWATCH

)

Definition at line 207 of file mod_clock.f90.

     IMPLICIT NONE  
     TYPE(WATCH) :: MYWATCH

     CALL system_clock(mywatch%COUNT_CURRENT)
     mywatch%COUNT_LAST = mywatch%COUNT_CURRENT
     mywatch%LAP_Count = mywatch%LAP_Count + 1

Here is the caller graph for this function:

watch_time()

real(dp) function mod_clock::watch_time

(

type(watch)

MYWATCH

)

Definition at line 149 of file mod_clock.f90.

     IMPLICIT NONE  
     TYPE(WATCH) :: MYWATCH
     REAL(DP) :: WATCH_TIME
     INTEGER(ITIME) :: BIG_COUNT
     INTEGER :: MY_COUNT

     CALL system_clock(count=my_count)
     big_count = my_count - mywatch%COUNT_0
     IF (big_count < 0) big_count = big_count + mywatch%COUNT_MAX

     watch_time = dble(big_count) / dble(mywatch%COUNT_RATE)
     

Variable Documentation

report_watch

type(watch) mod_clock::report_watch

Definition at line 71 of file mod_clock.f90.

   TYPE(WATCH):: Report_watch