<?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.16">
  <compounddef id="interfacemom__checksum__packages_1_1mom__state__chksum" kind="interface" language="Fortran" prot="private">
    <compoundname>mom_checksum_packages::mom_state_chksum</compoundname>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="interfacemom__checksum__packages_1_1mom__state__chksum_1a5a3f0a3be81eeea835f9344256534ba1" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_checksum_packages::mom_state_chksum::mom_state_chksum_5arg</definition>
        <argsstring>(mesg, u, v, h, uh, vh, G, GV, US, haloshift, symmetric, vel_scale)</argsstring>
        <name>mom_state_chksum_5arg</name>
        <param>
          <type>mesg</type>
          <defname>mesg</defname>
        </param>
        <param>
          <type>u</type>
          <defname>u</defname>
        </param>
        <param>
          <type>v</type>
          <defname>v</defname>
        </param>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>uh</type>
          <defname>uh</defname>
        </param>
        <param>
          <type>vh</type>
          <defname>vh</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>haloshift</type>
          <defname>haloshift</defname>
        </param>
        <param>
          <type>symmetric</type>
          <defname>symmetric</defname>
        </param>
        <param>
          <type>vel_scale</type>
          <defname>vel_scale</defname>
        </param>
        <briefdescription>
<para>Write out chksums for the model&apos;s basic state variables, including transports. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">mesg</parametername>
</parameternamelist>
<parameterdescription>
<para>A message that appears on the chksum lines. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>The ocean&apos;s grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>The ocean&apos;s vertical grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">u</parametername>
</parameternamelist>
<parameterdescription>
<para>The zonal velocity [L T-1 ~&gt; m s-1] or other units. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">v</parametername>
</parameternamelist>
<parameterdescription>
<para>The meridional velocity [L T-1 ~&gt; m s-1] or other units. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thicknesses [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">uh</parametername>
</parameternamelist>
<parameterdescription>
<para>Volume flux through zonal faces = u*h*dy </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">vh</parametername>
</parameternamelist>
<parameterdescription>
<para>Volume flux through meridional faces = v*h*dx </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">us</parametername>
</parameternamelist>
<parameterdescription>
<para>A dimensional unit scaling type </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 checksums on the fully symmetric computational domain. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">vel_scale</parametername>
</parameternamelist>
<parameterdescription>
<para>The scaling factor to convert velocities to [m s-1] </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_checksum_packages.F90" line="42" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_checksum_packages.F90" bodystart="43" bodyend="80"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__checksum__packages_1_1mom__state__chksum_1aeed57bfb1b13b7cd6bf9a974cdcaf78e" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_checksum_packages::mom_state_chksum::mom_state_chksum_3arg</definition>
        <argsstring>(mesg, u, v, h, G, GV, US, haloshift, symmetric)</argsstring>
        <name>mom_state_chksum_3arg</name>
        <param>
          <type>mesg</type>
          <defname>mesg</defname>
        </param>
        <param>
          <type>u</type>
          <defname>u</defname>
        </param>
        <param>
          <type>v</type>
          <defname>v</defname>
        </param>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>haloshift</type>
          <defname>haloshift</defname>
        </param>
        <param>
          <type>symmetric</type>
          <defname>symmetric</defname>
        </param>
        <briefdescription>
<para>Write out chksums for the model&apos;s basic state variables. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">mesg</parametername>
</parameternamelist>
<parameterdescription>
<para>A message that appears on the chksum lines. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>The ocean&apos;s grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>The ocean&apos;s vertical grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">u</parametername>
</parameternamelist>
<parameterdescription>
<para>Zonal velocity [L T-1 ~&gt; m s-1] or [m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">v</parametername>
</parameternamelist>
<parameterdescription>
<para>Meridional velocity [L T-1 ~&gt; m s-1] or [m s-1].. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thicknesses [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">us</parametername>
</parameternamelist>
<parameterdescription>
<para>A dimensional unit scaling type, which is used to rescale u and v if present. </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 checksums on the fully symmetric computational domain. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_checksum_packages.F90" line="86" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_checksum_packages.F90" bodystart="87" bodyend="114"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Write out checksums of the MOM6 state variables. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_checksum_packages.F90" line="23" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_checksum_packages.F90" bodystart="23" bodyend="25"/>
    <listofallmembers>
      <member refid="interfacemom__checksum__packages_1_1mom__state__chksum_1aeed57bfb1b13b7cd6bf9a974cdcaf78e" prot="private" virt="non-virtual"><scope>mom_checksum_packages::mom_state_chksum</scope><name>mom_state_chksum_3arg</name></member>
      <member refid="interfacemom__checksum__packages_1_1mom__state__chksum_1a5a3f0a3be81eeea835f9344256534ba1" prot="private" virt="non-virtual"><scope>mom_checksum_packages::mom_state_chksum</scope><name>mom_state_chksum_5arg</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
