<?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_1chksum" kind="interface" language="Fortran" prot="private">
    <compoundname>mom_checksums::chksum</compoundname>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="interfacemom__checksums_1_1chksum_1ad95756f66bded93e6be500043f9eac0d" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_checksums::chksum::chksum1d</definition>
        <argsstring>(array, mesg, start_i, end_i, compare_PEs)</argsstring>
        <name>chksum1d</name>
        <param>
          <type>array</type>
          <defname>array</defname>
        </param>
        <param>
          <type>mesg</type>
          <defname>mesg</defname>
        </param>
        <param>
          <type>start_i</type>
          <defname>start_i</defname>
        </param>
        <param>
          <type>end_i</type>
          <defname>end_i</defname>
        </param>
        <param>
          <type>compare_PEs</type>
          <defname>compare_PEs</defname>
        </param>
        <briefdescription>
<para>chksum1d does a checksum of a 1-dimensional array. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">array</parametername>
</parameternamelist>
<parameterdescription>
<para>The array to be summed (index starts at 1). </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">mesg</parametername>
</parameternamelist>
<parameterdescription>
<para>An identifying message. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">start_i</parametername>
</parameternamelist>
<parameterdescription>
<para>The starting index for the sum (default 1) </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">end_i</parametername>
</parameternamelist>
<parameterdescription>
<para>The ending index for the sum (default all) </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">compare_pes</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, compare across PEs instead of summing and list the root_PE value (default true) </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_checksums.F90" line="1886" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_checksums.F90" bodystart="1887" bodyend="1937"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__checksums_1_1chksum_1a2fba13939b2a2b0752cf960bd7fc9e17" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_checksums::chksum::chksum2d</definition>
        <argsstring>(array, mesg)</argsstring>
        <name>chksum2d</name>
        <param>
          <type>array</type>
          <defname>array</defname>
        </param>
        <param>
          <type>mesg</type>
          <defname>mesg</defname>
        </param>
        <briefdescription>
<para>chksum2d does a checksum of all data in a 2-d array. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>array</parametername>
</parameternamelist>
<parameterdescription>
<para>The array to be checksummed </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>mesg</parametername>
</parameternamelist>
<parameterdescription>
<para>An identifying message </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_checksums.F90" line="1944" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_checksums.F90" bodystart="1945" bodyend="1968"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__checksums_1_1chksum_1a6d57100cdc39c849d3c55fc182859ef1" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_checksums::chksum::chksum3d</definition>
        <argsstring>(array, mesg)</argsstring>
        <name>chksum3d</name>
        <param>
          <type>array</type>
          <defname>array</defname>
        </param>
        <param>
          <type>mesg</type>
          <defname>mesg</defname>
        </param>
        <briefdescription>
<para>chksum3d does a checksum of all data in a 2-d array. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>array</parametername>
</parameternamelist>
<parameterdescription>
<para>The array to be checksummed </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>mesg</parametername>
</parameternamelist>
<parameterdescription>
<para>An identifying message </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_checksums.F90" line="1972" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_checksums.F90" bodystart="1973" bodyend="1997"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>This is an older interface for 1-, 2-, or 3-D checksums. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_checksums.F90" line="64" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_checksums.F90" bodystart="64" bodyend="65"/>
    <listofallmembers>
      <member refid="interfacemom__checksums_1_1chksum_1ad95756f66bded93e6be500043f9eac0d" prot="private" virt="non-virtual"><scope>mom_checksums::chksum</scope><name>chksum1d</name></member>
      <member refid="interfacemom__checksums_1_1chksum_1a2fba13939b2a2b0752cf960bd7fc9e17" prot="private" virt="non-virtual"><scope>mom_checksums::chksum</scope><name>chksum2d</name></member>
      <member refid="interfacemom__checksums_1_1chksum_1a6d57100cdc39c849d3c55fc182859ef1" prot="private" virt="non-virtual"><scope>mom_checksums::chksum</scope><name>chksum3d</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
