<?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="interfacemom__checksums_1_1vchksum" kind="interface" language="Fortran" prot="private">
    <compoundname>mom_checksums::vchksum</compoundname>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="interfacemom__checksums_1_1vchksum_1a2fea0e7404edd53bbefdfa66d4706917" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_checksums::vchksum::chksum_v_2d</definition>
        <argsstring>(array_m, mesg, HI_m, haloshift, symmetric, omit_corners, scale, logunit)</argsstring>
        <name>chksum_v_2d</name>
        <param>
          <type>array_m</type>
          <defname>array_m</defname>
        </param>
        <param>
          <type>mesg</type>
          <defname>mesg</defname>
        </param>
        <param>
          <type>HI_m</type>
          <defname>HI_m</defname>
        </param>
        <param>
          <type>haloshift</type>
          <defname>haloshift</defname>
        </param>
        <param>
          <type>symmetric</type>
          <defname>symmetric</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>
        <briefdescription>
<para>Checksums a 2d array staggered at C-grid v points. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">hi_m</parametername>
</parameternamelist>
<parameterdescription>
<para>A horizontal index type </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">array_m</parametername>
</parameternamelist>
<parameterdescription>
<para>The array to be checksummed </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">mesg</parametername>
</parameternamelist>
<parameterdescription>
<para>An identifying message </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">symmetric</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, do the checksums on the full symmetric computational domain. </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>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_checksums.F90" line="1024" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_checksums.F90" bodystart="1026" bodyend="1199"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__checksums_1_1vchksum_1aef73c84b0fe627762c1742f57747a119" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_checksums::vchksum::chksum_v_3d</definition>
        <argsstring>(array_m, mesg, HI_m, haloshift, symmetric, omit_corners, scale, logunit)</argsstring>
        <name>chksum_v_3d</name>
        <param>
          <type>array_m</type>
          <defname>array_m</defname>
        </param>
        <param>
          <type>mesg</type>
          <defname>mesg</defname>
        </param>
        <param>
          <type>HI_m</type>
          <defname>HI_m</defname>
        </param>
        <param>
          <type>haloshift</type>
          <defname>haloshift</defname>
        </param>
        <param>
          <type>symmetric</type>
          <defname>symmetric</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>
        <briefdescription>
<para>Checksums a 3d array staggered at C-grid v points. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">hi_m</parametername>
</parameternamelist>
<parameterdescription>
<para>A horizontal index type </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">array_m</parametername>
</parameternamelist>
<parameterdescription>
<para>The array to be checksummed </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">mesg</parametername>
</parameternamelist>
<parameterdescription>
<para>An identifying message </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">symmetric</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, do the checksums on the full symmetric computational domain. </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>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_checksums.F90" line="1703" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_checksums.F90" bodystart="1705" bodyend="1879"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Checksums an array (2d or 3d) staggered at C-grid v points. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_checksums.F90" line="39" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_checksums.F90" bodystart="39" bodyend="40"/>
    <listofallmembers>
      <member refid="interfacemom__checksums_1_1vchksum_1a2fea0e7404edd53bbefdfa66d4706917" prot="private" virt="non-virtual"><scope>mom_checksums::vchksum</scope><name>chksum_v_2d</name></member>
      <member refid="interfacemom__checksums_1_1vchksum_1aef73c84b0fe627762c1742f57747a119" prot="private" virt="non-virtual"><scope>mom_checksums::vchksum</scope><name>chksum_v_3d</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
