<?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__domains_1_1pass__var__start" kind="interface" language="Fortran" prot="private">
    <compoundname>mom_domains::pass_var_start</compoundname>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="interfacemom__domains_1_1pass__var__start_1ac7f069531c9cf43458e3d57d896e2989" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>integer function</type>
        <definition>integer function mom_domains::pass_var_start::pass_var_start_3d</definition>
        <argsstring>(array, MOM_dom, sideflag, position, complete, halo, clock)</argsstring>
        <name>pass_var_start_3d</name>
        <param>
          <type>array</type>
          <defname>array</defname>
        </param>
        <param>
          <type>MOM_dom</type>
          <defname>MOM_dom</defname>
        </param>
        <param>
          <type>sideflag</type>
          <defname>sideflag</defname>
        </param>
        <param>
          <type>position</type>
          <defname>position</defname>
        </param>
        <param>
          <type>complete</type>
          <defname>complete</defname>
        </param>
        <param>
          <type>halo</type>
          <defname>halo</defname>
        </param>
        <param>
          <type>clock</type>
          <defname>clock</defname>
        </param>
        <briefdescription>
<para>pass_var_start_3d starts a halo update for a three-dimensional array. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">array</parametername>
</parameternamelist>
<parameterdescription>
<para>The array which is having its halos points exchanged. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">mom_dom</parametername>
</parameternamelist>
<parameterdescription>
<para>The MOM_domain_type containing the mpp_domain needed to determine where data should be sent. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">sideflag</parametername>
</parameternamelist>
<parameterdescription>
<para>An optional integer indicating which directions the data should be sent. It is TO_ALL or the sum of any of TO_EAST, TO_WEST, TO_NORTH, and TO_SOUTH. For example, TO_EAST sends the data to the processor to the east, so the halos on the western side are filled. TO_ALL is the default if sideflag is omitted. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">position</parametername>
</parameternamelist>
<parameterdescription>
<para>An optional argument indicating the position. This is CENTER by default and is often CORNER, but could also be EAST_FACE or NORTH_FACE. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">complete</parametername>
</parameternamelist>
<parameterdescription>
<para>An optional argument indicating whether the halo updates should be completed before progress resumes. Omitting complete is the same as setting complete to .true. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">halo</parametername>
</parameternamelist>
<parameterdescription>
<para>The size of the halo to update - the full halo by default. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">clock</parametername>
</parameternamelist>
<parameterdescription>
<para>The handle for a cpu time clock that should be started then stopped to time this routine. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>The integer index for this update. </para>
</simplesect>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_domains.F90" line="353" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_domains.F90" bodystart="355" bodyend="394"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__domains_1_1pass__var__start_1a587d11b942b9f4992c0114e8b44e11cf" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>integer function</type>
        <definition>integer function mom_domains::pass_var_start::pass_var_start_2d</definition>
        <argsstring>(array, MOM_dom, sideflag, position, complete, halo, clock)</argsstring>
        <name>pass_var_start_2d</name>
        <param>
          <type>array</type>
          <defname>array</defname>
        </param>
        <param>
          <type>MOM_dom</type>
          <defname>MOM_dom</defname>
        </param>
        <param>
          <type>sideflag</type>
          <defname>sideflag</defname>
        </param>
        <param>
          <type>position</type>
          <defname>position</defname>
        </param>
        <param>
          <type>complete</type>
          <defname>complete</defname>
        </param>
        <param>
          <type>halo</type>
          <defname>halo</defname>
        </param>
        <param>
          <type>clock</type>
          <defname>clock</defname>
        </param>
        <briefdescription>
<para>pass_var_start_2d starts a halo update for a two-dimensional array. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">array</parametername>
</parameternamelist>
<parameterdescription>
<para>The array which is having its halos points exchanged. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">mom_dom</parametername>
</parameternamelist>
<parameterdescription>
<para>The MOM_domain_type containing the mpp_domain needed to determine where data should be sent. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">sideflag</parametername>
</parameternamelist>
<parameterdescription>
<para>An optional integer indicating which directions the data should be sent. It is TO_ALL or the sum of any of TO_EAST, TO_WEST, TO_NORTH, and TO_SOUTH. For example, TO_EAST sends the data to the processor to the east, so the halos on the western side are filled. TO_ALL is the default if sideflag is omitted. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">position</parametername>
</parameternamelist>
<parameterdescription>
<para>An optional argument indicating the position. This is CENTER by default and is often CORNER, but could also be EAST_FACE or NORTH_FACE. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">complete</parametername>
</parameternamelist>
<parameterdescription>
<para>An optional argument indicating whether the halo updates should be completed before progress resumes. Omitting complete is the same as setting complete to .true. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">halo</parametername>
</parameternamelist>
<parameterdescription>
<para>The size of the halo to update - the full halo by default. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">clock</parametername>
</parameternamelist>
<parameterdescription>
<para>The handle for a cpu time clock that should be started then stopped to time this routine. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>The integer index for this update. </para>
</simplesect>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_domains.F90" line="308" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_domains.F90" bodystart="310" bodyend="349"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Initiate a non-blocking halo update on an array. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_domains.F90" line="64" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_domains.F90" bodystart="64" bodyend="65"/>
    <listofallmembers>
      <member refid="interfacemom__domains_1_1pass__var__start_1a587d11b942b9f4992c0114e8b44e11cf" prot="private" virt="non-virtual"><scope>mom_domains::pass_var_start</scope><name>pass_var_start_2d</name></member>
      <member refid="interfacemom__domains_1_1pass__var__start_1ac7f069531c9cf43458e3d57d896e2989" prot="private" virt="non-virtual"><scope>mom_domains::pass_var_start</scope><name>pass_var_start_3d</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
