<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.17">
  <compounddef id="namespacemom__cpu__clock" kind="namespace" language="Fortran">
    <compoundname>mom_cpu_clock</compoundname>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacemom__cpu__clock_1a7fda795074ed5ec5b00a26e7531c14f3" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>integer function, public</type>
        <definition>integer function, public mom_cpu_clock::cpu_clock_id</definition>
        <argsstring>(name, synchro_flag, grain)</argsstring>
        <name>cpu_clock_id</name>
        <param>
          <type>name</type>
          <defname>name</defname>
        </param>
        <param>
          <type>synchro_flag</type>
          <defname>synchro_flag</defname>
        </param>
        <param>
          <type>grain</type>
          <defname>grain</defname>
        </param>
        <briefdescription>
<para>cpu_clock_id returns the integer handle for a named CPU clock. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">name</parametername>
</parameternamelist>
<parameterdescription>
<para>The unique name of the CPU clock </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">synchro_flag</parametername>
</parameternamelist>
<parameterdescription>
<para>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. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">grain</parametername>
</parameternamelist>
<parameterdescription>
<para>The timing granularity for this clock, usually set to the values of CLOCK_COMPONENT, CLOCK_ROUTINE, CLOCK_LOOP, etc. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>The integer CPU clock handle. </para>
</simplesect>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_cpu_clock.F90" line="22" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_cpu_clock.F90" bodystart="23" bodyend="39"/>
        <referencedby refid="namespacemom__barotropic_1a59244968890766632554a6d271ec4499" compoundref="MOM__barotropic_8F90" startline="4206" endline="4919">mom_barotropic::barotropic_init</referencedby>
        <referencedby refid="namespacemom__bulk__mixed__layer_1a14f3b36851c81d60fb31ff86870a7d54" compoundref="MOM__bulk__mixed__layer_8F90" startline="3390" endline="3685">mom_bulk_mixed_layer::bulkmixedlayer_init</referencedby>
        <referencedby refid="namespacemom__continuity__ppm_1a832c506364bca555b36409a91e0f5906" compoundref="MOM__continuity__PPM_8F90" startline="2230" endline="2321">mom_continuity_ppm::continuity_ppm_init</referencedby>
        <referencedby refid="namespacemom__meke_1a099f1cfad37430ef1bd60972a92b1be4" compoundref="MOM__MEKE_8F90" startline="984" endline="1342">mom_meke::meke_init</referencedby>
        <referencedby refid="MOM__driver_8F90_1a08fffeb2d8e8acbf9ed4609be6d258c6" compoundref="MOM__driver_8F90" startline="1">mom_main</referencedby>
        <referencedby refid="namespacemom__forcing__type_1ad4a8e0b876c8082f77352a25a56b86e9" compoundref="MOM__forcing__type_8F90" startline="1233" endline="1889">mom_forcing_type::register_forcing_type_diags</referencedby>
        <referencedby refid="namespacemom__regularize__layers_1a7f5b60398ab6cb0dd38cdc3b3053091e" compoundref="MOM__regularize__layers_8F90" startline="769" endline="855">mom_regularize_layers::regularize_layers_init</referencedby>
        <referencedby refid="namespacemom__tidal__forcing_1aee336a2affeebc78b75845bc6f78a320" compoundref="MOM__tidal__forcing_8F90" startline="230" endline="524">mom_tidal_forcing::tidal_forcing_init</referencedby>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Wraps the MPP cpu clock functions. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_cpu_clock.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
