mom_cpu_clock module reference

Wraps the MPP cpu clock functions.

More…

Functions/Subroutines

cpu_clock_id()

cpu_clock_id returns the integer handle for a named CPU clock.

Detailed Description

Wraps the MPP cpu clock functions.

Function/Subroutine Documentation

function mom_cpu_clock/cpu_clock_id(name, synchro_flag, grain) [integer]

cpu_clock_id returns the integer handle for a named CPU clock.

Parameters

• name :: [in] The unique name of the CPU clock

• synchro_flag :: [in] An integer flag that controls whether the PEs are synchronized before the cpu clocks start counting. Synchronization occurs before the start of a clock if this is odd, while additional (expensive) statistics can set for other values. If absent, the default is taken from the settings for FMS.

• grain :: [in] The timing granularity for this clock, usually set to the values of CLOCK_COMPONENT, CLOCK_ROUTINE, CLOCK_LOOP, etc.

Return

undefined :: The integer CPU clock handle.

Called from

mom_barotropic::barotropic_init mom_continuity_ppm::continuity_ppm_init mom_meke::meke_init mom_main mom_open_boundary::open_boundary_init mom_forcing_type::register_forcing_type_diags mom_regularize_layers::regularize_layers_init mom_tidal_forcing::tidal_forcing_init