<?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.15">
  <compounddef id="interfacemom__domains_1_1pass__vector__start" kind="interface" language="Fortran" prot="private">
    <compoundname>mom_domains::pass_vector_start</compoundname>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="interfacemom__domains_1_1pass__vector__start_1afcd13d423d6f7428a61cc14a31f6519b" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>integer function</type>
        <definition>integer function mom_domains::pass_vector_start::pass_vector_start_3d</definition>
        <argsstring>(u_cmpt, v_cmpt, MOM_dom, direction, stagger, complete, halo, clock)</argsstring>
        <name>pass_vector_start_3d</name>
        <param>
          <type>u_cmpt</type>
          <defname>u_cmpt</defname>
        </param>
        <param>
          <type>v_cmpt</type>
          <defname>v_cmpt</defname>
        </param>
        <param>
          <type>MOM_dom</type>
          <defname>MOM_dom</defname>
        </param>
        <param>
          <type>direction</type>
          <defname>direction</defname>
        </param>
        <param>
          <type>stagger</type>
          <defname>stagger</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_vector_start_3d starts a halo update for a pair of three-dimensional arrays representing the compontents of a three-dimensional horizontal vector. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">u_cmpt</parametername>
</parameternamelist>
<parameterdescription>
<para>The nominal zonal (u) component of the vector pair which is having its halos points exchanged. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">v_cmpt</parametername>
</parameternamelist>
<parameterdescription>
<para>The nominal meridional (v) component of the vector pair 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">direction</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, possibly plus SCALAR_PAIR if these are paired non-directional scalars discretized at the typical vector component locations. 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 omitted. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">stagger</parametername>
</parameternamelist>
<parameterdescription>
<para>An optional flag, which may be one of A_GRID, BGRID_NE, or CGRID_NE, indicating where the two components of the vector are discretized. Omitting stagger is the same as setting it to CGRID_NE. </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="746" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_domains.F90" bodystart="748" bodyend="797"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__domains_1_1pass__vector__start_1ae89f5b81804c86807a7a7e6e2de1e1bb" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>integer function</type>
        <definition>integer function mom_domains::pass_vector_start::pass_vector_start_2d</definition>
        <argsstring>(u_cmpt, v_cmpt, MOM_dom, direction, stagger, complete, halo, clock)</argsstring>
        <name>pass_vector_start_2d</name>
        <param>
          <type>u_cmpt</type>
          <defname>u_cmpt</defname>
        </param>
        <param>
          <type>v_cmpt</type>
          <defname>v_cmpt</defname>
        </param>
        <param>
          <type>MOM_dom</type>
          <defname>MOM_dom</defname>
        </param>
        <param>
          <type>direction</type>
          <defname>direction</defname>
        </param>
        <param>
          <type>stagger</type>
          <defname>stagger</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_vector_start_2d starts a halo update for a pair of two-dimensional arrays representing the compontents of a two-dimensional horizontal vector. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">u_cmpt</parametername>
</parameternamelist>
<parameterdescription>
<para>The nominal zonal (u) component of the vector pair which is having its halos points exchanged. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">v_cmpt</parametername>
</parameternamelist>
<parameterdescription>
<para>The nominal meridional (v) component of the vector pair 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">direction</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, possibly plus SCALAR_PAIR if these are paired non-directional scalars discretized at the typical vector component locations. 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 omitted. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">stagger</parametername>
</parameternamelist>
<parameterdescription>
<para>An optional flag, which may be one of A_GRID, BGRID_NE, or CGRID_NE, indicating where the two components of the vector are discretized. Omitting stagger is the same as setting it to CGRID_NE. </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="689" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_domains.F90" bodystart="691" bodyend="741"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Initiate a halo update on a pair of arrays representing the two components of a vector. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_domains.F90" line="74" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_domains.F90" bodystart="74" bodyend="75"/>
    <listofallmembers>
      <member refid="interfacemom__domains_1_1pass__vector__start_1ae89f5b81804c86807a7a7e6e2de1e1bb" prot="private" virt="non-virtual"><scope>mom_domains::pass_vector_start</scope><name>pass_vector_start_2d</name></member>
      <member refid="interfacemom__domains_1_1pass__vector__start_1afcd13d423d6f7428a61cc14a31f6519b" prot="private" virt="non-virtual"><scope>mom_domains::pass_vector_start</scope><name>pass_vector_start_3d</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
