<?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.14">
  <compounddef id="interfacemom__io_1_1mom__read__vector" kind="interface" language="Fortran" prot="private">
    <compoundname>mom_io::mom_read_vector</compoundname>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="interfacemom__io_1_1mom__read__vector_1ae6c389d606c63292d978aa94db76d32b" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_io::mom_read_vector::mom_read_vector_3d</definition>
        <argsstring>(filename, u_fieldname, v_fieldname, u_data, v_data, MOM_Domain, timelevel, stagger, scalar_pair, scale)</argsstring>
        <name>mom_read_vector_3d</name>
        <param>
          <type>filename</type>
          <defname>filename</defname>
        </param>
        <param>
          <type>u_fieldname</type>
          <defname>u_fieldname</defname>
        </param>
        <param>
          <type>v_fieldname</type>
          <defname>v_fieldname</defname>
        </param>
        <param>
          <type>u_data</type>
          <defname>u_data</defname>
        </param>
        <param>
          <type>v_data</type>
          <defname>v_data</defname>
        </param>
        <param>
          <type>MOM_Domain</type>
          <defname>MOM_Domain</defname>
        </param>
        <param>
          <type>timelevel</type>
          <defname>timelevel</defname>
        </param>
        <param>
          <type>stagger</type>
          <defname>stagger</defname>
        </param>
        <param>
          <type>scalar_pair</type>
          <defname>scalar_pair</defname>
        </param>
        <param>
          <type>scale</type>
          <defname>scale</defname>
        </param>
        <briefdescription>
<para>This function uses the fms_io function read_data to read a pair of distributed 3-D data fields with names given by &quot;[uv]_fieldname&quot; from file &quot;filename&quot;. Valid values for &quot;stagger&quot; include CGRID_NE, BGRID_NE, and AGRID. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">filename</parametername>
</parameternamelist>
<parameterdescription>
<para>The name of the file to read</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">u_fieldname</parametername>
</parameternamelist>
<parameterdescription>
<para>The variable name of the u data in the file</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">v_fieldname</parametername>
</parameternamelist>
<parameterdescription>
<para>The variable name of the v data in the file</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">u_data</parametername>
</parameternamelist>
<parameterdescription>
<para>The 3 dimensional array into which the u-component of the data should be read</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">v_data</parametername>
</parameternamelist>
<parameterdescription>
<para>The 3 dimensional array into which the v-component of the data should be read</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">mom_domain</parametername>
</parameternamelist>
<parameterdescription>
<para>The MOM_Domain that describes the decomposition</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">timelevel</parametername>
</parameternamelist>
<parameterdescription>
<para>The time level in the file to read</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">stagger</parametername>
</parameternamelist>
<parameterdescription>
<para>A flag indicating where this vector is discretized</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">scalar_pair</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, a pair of scalars are to be read.cretized</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">scale</parametername>
</parameternamelist>
<parameterdescription>
<para>A scaling factor that the fields are multiplied by before they are returned. </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_io.F90" line="998" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_io.F90" bodystart="1000" bodyend="1037"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__io_1_1mom__read__vector_1afa1f6b837c14b60ba44b048ffc7e7988" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_io::mom_read_vector::mom_read_vector_2d</definition>
        <argsstring>(filename, u_fieldname, v_fieldname, u_data, v_data, MOM_Domain, timelevel, stagger, scalar_pair, scale)</argsstring>
        <name>mom_read_vector_2d</name>
        <param>
          <type>filename</type>
          <defname>filename</defname>
        </param>
        <param>
          <type>u_fieldname</type>
          <defname>u_fieldname</defname>
        </param>
        <param>
          <type>v_fieldname</type>
          <defname>v_fieldname</defname>
        </param>
        <param>
          <type>u_data</type>
          <defname>u_data</defname>
        </param>
        <param>
          <type>v_data</type>
          <defname>v_data</defname>
        </param>
        <param>
          <type>MOM_Domain</type>
          <defname>MOM_Domain</defname>
        </param>
        <param>
          <type>timelevel</type>
          <defname>timelevel</defname>
        </param>
        <param>
          <type>stagger</type>
          <defname>stagger</defname>
        </param>
        <param>
          <type>scalar_pair</type>
          <defname>scalar_pair</defname>
        </param>
        <param>
          <type>scale</type>
          <defname>scale</defname>
        </param>
        <briefdescription>
<para>This function uses the fms_io function read_data to read a pair of distributed 2-D data fields with names given by &quot;[uv]_fieldname&quot; from file &quot;filename&quot;. Valid values for &quot;stagger&quot; include CGRID_NE, BGRID_NE, and AGRID. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">filename</parametername>
</parameternamelist>
<parameterdescription>
<para>The name of the file to read</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">u_fieldname</parametername>
</parameternamelist>
<parameterdescription>
<para>The variable name of the u data in the file</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">v_fieldname</parametername>
</parameternamelist>
<parameterdescription>
<para>The variable name of the v data in the file</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">u_data</parametername>
</parameternamelist>
<parameterdescription>
<para>The 2 dimensional array into which the u-component of the data should be read</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">v_data</parametername>
</parameternamelist>
<parameterdescription>
<para>The 2 dimensional array into which the v-component of the data should be read</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">mom_domain</parametername>
</parameternamelist>
<parameterdescription>
<para>The MOM_Domain that describes the decomposition</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">timelevel</parametername>
</parameternamelist>
<parameterdescription>
<para>The time level in the file to read</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">stagger</parametername>
</parameternamelist>
<parameterdescription>
<para>A flag indicating where this vector is discretized</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">scalar_pair</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, a pair of scalars are to be read.cretized</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">scale</parametername>
</parameternamelist>
<parameterdescription>
<para>A scaling factor that the fields are multiplied by before they are returned. </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_io.F90" line="953" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_io.F90" bodystart="955" bodyend="991"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Read a pair of data fields representing the two components of a vector from a file. </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_io.F90" line="82" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_io.F90" bodystart="82" bodyend="84"/>
    <listofallmembers>
      <member refid="interfacemom__io_1_1mom__read__vector_1afa1f6b837c14b60ba44b048ffc7e7988" prot="private" virt="non-virtual"><scope>mom_io::mom_read_vector</scope><name>mom_read_vector_2d</name></member>
      <member refid="interfacemom__io_1_1mom__read__vector_1ae6c389d606c63292d978aa94db76d32b" prot="private" virt="non-virtual"><scope>mom_io::mom_read_vector</scope><name>mom_read_vector_3d</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
