<?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.20" xml:lang="en-US">
  <compounddef id="interfacemom__checksums_1_1hchksum__pair" kind="interface" language="Fortran" prot="private">
    <compoundname>mom_checksums::hchksum_pair</compoundname>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="interfacemom__checksums_1_1hchksum__pair_1a6e01954e421d1cfa073d666fb35eec46" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_checksums::hchksum_pair::chksum_pair_h_2d</definition>
        <argsstring>(mesg, arrayA, arrayB, HI, haloshift, omit_corners, scale, logunit, scalar_pair)</argsstring>
        <name>chksum_pair_h_2d</name>
        <param>
          <type>mesg</type>
          <defname>mesg</defname>
        </param>
        <param>
          <type>arrayA</type>
          <defname>arrayA</defname>
        </param>
        <param>
          <type>arrayB</type>
          <defname>arrayB</defname>
        </param>
        <param>
          <type>HI</type>
          <defname>HI</defname>
        </param>
        <param>
          <type>haloshift</type>
          <defname>haloshift</defname>
        </param>
        <param>
          <type>omit_corners</type>
          <defname>omit_corners</defname>
        </param>
        <param>
          <type>scale</type>
          <defname>scale</defname>
        </param>
        <param>
          <type>logunit</type>
          <defname>logunit</defname>
        </param>
        <param>
          <type>scalar_pair</type>
          <defname>scalar_pair</defname>
        </param>
        <briefdescription>
<para>Checksums on a pair of 2d arrays staggered at tracer points. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">mesg</parametername>
</parameternamelist>
<parameterdescription>
<para>Identifying messages </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">hi</parametername>
</parameternamelist>
<parameterdescription>
<para>A horizontal index type </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">arraya</parametername>
</parameternamelist>
<parameterdescription>
<para>The first array to be checksummed </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">arrayb</parametername>
</parameternamelist>
<parameterdescription>
<para>The second array to be checksummed </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">haloshift</parametername>
</parameternamelist>
<parameterdescription>
<para>The width of halos to check (default 0) </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">omit_corners</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, avoid checking diagonal shifts </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">scale</parametername>
</parameternamelist>
<parameterdescription>
<para>A scaling factor for this array. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">logunit</parametername>
</parameternamelist>
<parameterdescription>
<para>IO unit for checksum logging </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">scalar_pair</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, then the arrays describe a scalar, rather than vector </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_checksums.F90" line="200" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_checksums.F90" bodystart="202" bodyend="247"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__checksums_1_1hchksum__pair_1a4e7dffe8666c9a3551a2606b6183300a" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_checksums::hchksum_pair::chksum_pair_h_3d</definition>
        <argsstring>(mesg, arrayA, arrayB, HI, haloshift, omit_corners, scale, logunit, scalar_pair)</argsstring>
        <name>chksum_pair_h_3d</name>
        <param>
          <type>mesg</type>
          <defname>mesg</defname>
        </param>
        <param>
          <type>arrayA</type>
          <defname>arrayA</defname>
        </param>
        <param>
          <type>arrayB</type>
          <defname>arrayB</defname>
        </param>
        <param>
          <type>HI</type>
          <defname>HI</defname>
        </param>
        <param>
          <type>haloshift</type>
          <defname>haloshift</defname>
        </param>
        <param>
          <type>omit_corners</type>
          <defname>omit_corners</defname>
        </param>
        <param>
          <type>scale</type>
          <defname>scale</defname>
        </param>
        <param>
          <type>logunit</type>
          <defname>logunit</defname>
        </param>
        <param>
          <type>scalar_pair</type>
          <defname>scalar_pair</defname>
        </param>
        <briefdescription>
<para>Checksums on a pair of 3d arrays staggered at tracer points. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">mesg</parametername>
</parameternamelist>
<parameterdescription>
<para>Identifying messages </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">hi</parametername>
</parameternamelist>
<parameterdescription>
<para>A horizontal index type </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">arraya</parametername>
</parameternamelist>
<parameterdescription>
<para>The first array to be checksummed </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">arrayb</parametername>
</parameternamelist>
<parameterdescription>
<para>The second array to be checksummed </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">haloshift</parametername>
</parameternamelist>
<parameterdescription>
<para>The width of halos to check (default 0) </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">omit_corners</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, avoid checking diagonal shifts </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">scale</parametername>
</parameternamelist>
<parameterdescription>
<para>A scaling factor for this array. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">logunit</parametername>
</parameternamelist>
<parameterdescription>
<para>IO unit for checksum logging </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">scalar_pair</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, then the arrays describe a scalar, rather than vector </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_checksums.F90" line="251" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_checksums.F90" bodystart="253" bodyend="301"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Checksums a pair of arrays (2d or 3d) staggered at tracer points. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_checksums.F90" line="24" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_checksums.F90" bodystart="24" bodyend="25"/>
    <listofallmembers>
      <member refid="interfacemom__checksums_1_1hchksum__pair_1a6e01954e421d1cfa073d666fb35eec46" prot="private" virt="non-virtual"><scope>mom_checksums::hchksum_pair</scope><name>chksum_pair_h_2d</name></member>
      <member refid="interfacemom__checksums_1_1hchksum__pair_1a4e7dffe8666c9a3551a2606b6183300a" prot="private" virt="non-virtual"><scope>mom_checksums::hchksum_pair</scope><name>chksum_pair_h_3d</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
