PMTM_create_timer

PMTM_create_timer

Fortran:

:::fortran
subroutine PMTM_create_timer(group, timer, timer_name, timer_type , err_code)

Creates a timer.

:::fortran
    integer, intent(in)::group 

The timer group to which this timer will be associated.

:::fortran
    type(PMTM_timer), intent(out)::timer

The returned handle to the timer. character(len=*), intent(in)::timer_name The name of the timer.

:::fortran
    integer, intent(in)::timer_type 

The type of the timer, the options being:

• PMTM_TIMER_NONE
  • Only output the individual rank timers.
• PMTM_TIMER_AVG
  • Output the average time across all ranks and all rank timers.
• PMTM_TIMER_MAX
  • Output the maximum time across all ranks and all rank timers.
• PMTM_TIMER_MIN
  • Output the minimum time across all ranks and all rank timers.
• PMTM_TIMER_ALL
  • Output all the above statistics and all rank timers.
• PMTM_TIMER_MMA
  • Output only the maximum, minimum and average times across all ranks. (Version 2.5.2 and later)
• PMTM_TIMER_AVO
  • Output only the average timers across all ranks. (Version 2.5.2 and later)
• PMTM_TIMER_INT
  • Do not output any timer information for this timer. (Version 2.5.2 and later)

Other timers are being added to give more flexibility.

:::fortran
integer, intent(out)::err_code 
Will be set to **PMTM_SUCCESS** if the call was successful and the appropriate error code if not.

OpenMP: Timers running under OpenMP with an instance for each thread should have the same timer_name if they are expected to be associated during finalisation. Also, once created, it is assumed all activities (except output) on a timer will be carried out by a single thread. If this is not the case, serialisation should be applied as no protection is provided by the PMTM library.

C:

:::C
PMTM_error_t PMTM_create_timer(PMTM_timer_group_t group, PMTM_timer_t * timer, const char * timer_name, PMTM_timer_type_t timer_type)