<?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.19" xml:lang="en-US">
  <compounddef id="interfacemom__domains_1_1fill__symmetric__edges" kind="interface" language="Fortran" prot="private">
    <compoundname>mom_domains::fill_symmetric_edges</compoundname>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="interfacemom__domains_1_1fill__symmetric__edges_1ab320455c6a6fe9ec184df297be4d1aff" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_domains::fill_symmetric_edges::fill_vector_symmetric_edges_2d</definition>
        <argsstring>(u_cmpt, v_cmpt, MOM_dom, stagger, scalar, clock)</argsstring>
        <name>fill_vector_symmetric_edges_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>stagger</type>
          <defname>stagger</defname>
        </param>
        <param>
          <type>scalar</type>
          <defname>scalar</defname>
        </param>
        <param>
          <type>clock</type>
          <defname>clock</defname>
        </param>
        <briefdescription>
<para>fill_vector_symmetric_edges_2d does an usual set of halo updates that only fill in the values at the edge of a pair of symmetric memory two-dimensional arrays representing the compontents of a two-dimensional horizontal vector. If symmetric memory is not being used, this subroutine does nothing except to possibly turn optional cpu clocks on or off. </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">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">scalar</parametername>
</parameternamelist>
<parameterdescription>
<para>An optional argument indicating whether. </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>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_domains.F90" line="546" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_domains.F90" bodystart="548" bodyend="626"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Do a set of halo updates that fill in the values at the duplicated edges of a staggered symmetric memory domain. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_domains.F90" line="93" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_domains.F90" bodystart="93" bodyend="95"/>
    <listofallmembers>
      <member refid="interfacemom__domains_1_1fill__symmetric__edges_1ab320455c6a6fe9ec184df297be4d1aff" prot="private" virt="non-virtual"><scope>mom_domains::fill_symmetric_edges</scope><name>fill_vector_symmetric_edges_2d</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
