<?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__io_1_1mom__read__data" kind="interface" language="Fortran" prot="private">
    <compoundname>mom_io::mom_read_data</compoundname>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="interfacemom__io_1_1mom__read__data_1a2bb1880532b2332ec27cae5076cdeecd" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_io::mom_read_data::mom_read_data_4d</definition>
        <argsstring>(filename, fieldname, data, MOM_Domain, timelevel, position, scale)</argsstring>
        <name>mom_read_data_4d</name>
        <param>
          <type>filename</type>
          <defname>filename</defname>
        </param>
        <param>
          <type>fieldname</type>
          <defname>fieldname</defname>
        </param>
        <param>
          <type>data</type>
          <defname>data</defname>
        </param>
        <param>
          <type>MOM_Domain</type>
          <defname>MOM_Domain</defname>
        </param>
        <param>
          <type>timelevel</type>
          <defname>timelevel</defname>
        </param>
        <param>
          <type>position</type>
          <defname>position</defname>
        </param>
        <param>
          <type>scale</type>
          <defname>scale</defname>
        </param>
        <briefdescription>
<para>This function uses the fms_io function read_data to read a distributed 4-D data field named &quot;fieldname&quot; from file &quot;filename&quot;. Valid values for &quot;position&quot; include CORNER, CENTER, EAST_FACE and NORTH_FACE. </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">fieldname</parametername>
</parameternamelist>
<parameterdescription>
<para>The variable name of the data in the file </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">data</parametername>
</parameternamelist>
<parameterdescription>
<para>The 4-dimensional array into which 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">position</parametername>
</parameternamelist>
<parameterdescription>
<para>A flag indicating where this data is located </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">scale</parametername>
</parameternamelist>
<parameterdescription>
<para>A scaling factor that the field is 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="924" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_io.F90" bodystart="926" bodyend="946"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__io_1_1mom__read__data_1a8d8b4317fa8b790ec2cecfd15befd3dd" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_io::mom_read_data::mom_read_data_3d</definition>
        <argsstring>(filename, fieldname, data, MOM_Domain, timelevel, position, scale)</argsstring>
        <name>mom_read_data_3d</name>
        <param>
          <type>filename</type>
          <defname>filename</defname>
        </param>
        <param>
          <type>fieldname</type>
          <defname>fieldname</defname>
        </param>
        <param>
          <type>data</type>
          <defname>data</defname>
        </param>
        <param>
          <type>MOM_Domain</type>
          <defname>MOM_Domain</defname>
        </param>
        <param>
          <type>timelevel</type>
          <defname>timelevel</defname>
        </param>
        <param>
          <type>position</type>
          <defname>position</defname>
        </param>
        <param>
          <type>scale</type>
          <defname>scale</defname>
        </param>
        <briefdescription>
<para>This function uses the fms_io function read_data to read a distributed 3-D data field named &quot;fieldname&quot; from file &quot;filename&quot;. Valid values for &quot;position&quot; include CORNER, CENTER, EAST_FACE and NORTH_FACE. </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">fieldname</parametername>
</parameternamelist>
<parameterdescription>
<para>The variable name of the data in the file </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">data</parametername>
</parameternamelist>
<parameterdescription>
<para>The 3-dimensional array into which 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">position</parametername>
</parameternamelist>
<parameterdescription>
<para>A flag indicating where this data is located </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">scale</parametername>
</parameternamelist>
<parameterdescription>
<para>A scaling factor that the field is 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="896" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_io.F90" bodystart="898" bodyend="918"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__io_1_1mom__read__data_1a3dfc4ff2a1046e81623c2de711036206" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_io::mom_read_data::mom_read_data_2d</definition>
        <argsstring>(filename, fieldname, data, MOM_Domain, timelevel, position, scale)</argsstring>
        <name>mom_read_data_2d</name>
        <param>
          <type>filename</type>
          <defname>filename</defname>
        </param>
        <param>
          <type>fieldname</type>
          <defname>fieldname</defname>
        </param>
        <param>
          <type>data</type>
          <defname>data</defname>
        </param>
        <param>
          <type>MOM_Domain</type>
          <defname>MOM_Domain</defname>
        </param>
        <param>
          <type>timelevel</type>
          <defname>timelevel</defname>
        </param>
        <param>
          <type>position</type>
          <defname>position</defname>
        </param>
        <param>
          <type>scale</type>
          <defname>scale</defname>
        </param>
        <briefdescription>
<para>This function uses the fms_io function read_data to read a distributed 2-D data field named &quot;fieldname&quot; from file &quot;filename&quot;. Valid values for &quot;position&quot; include CORNER, CENTER, EAST_FACE and NORTH_FACE. </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">fieldname</parametername>
</parameternamelist>
<parameterdescription>
<para>The variable name of the data in the file </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">data</parametername>
</parameternamelist>
<parameterdescription>
<para>The 2-dimensional array into which 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">position</parametername>
</parameternamelist>
<parameterdescription>
<para>A flag indicating where this data is located </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">scale</parametername>
</parameternamelist>
<parameterdescription>
<para>A scaling factor that the field is 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="868" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_io.F90" bodystart="870" bodyend="890"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__io_1_1mom__read__data_1a1654977ec3a066c709eb80476c9565f9" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_io::mom_read_data::mom_read_data_1d</definition>
        <argsstring>(filename, fieldname, data, timelevel, scale)</argsstring>
        <name>mom_read_data_1d</name>
        <param>
          <type>filename</type>
          <defname>filename</defname>
        </param>
        <param>
          <type>fieldname</type>
          <defname>fieldname</defname>
        </param>
        <param>
          <type>data</type>
          <defname>data</defname>
        </param>
        <param>
          <type>timelevel</type>
          <defname>timelevel</defname>
        </param>
        <param>
          <type>scale</type>
          <defname>scale</defname>
        </param>
        <briefdescription>
<para>This function uses the fms_io function read_data to read 1-D data field named &quot;fieldname&quot; from file &quot;filename&quot;. </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">fieldname</parametername>
</parameternamelist>
<parameterdescription>
<para>The variable name of the data in the file </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">data</parametername>
</parameternamelist>
<parameterdescription>
<para>The 1-dimensional array into which the data </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">scale</parametername>
</parameternamelist>
<parameterdescription>
<para>A scaling factor that the field is 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="849" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_io.F90" bodystart="850" bodyend="862"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Read a data field from a file. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_io.F90" line="74" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_io.F90" bodystart="74" bodyend="78"/>
    <listofallmembers>
      <member refid="interfacemom__io_1_1mom__read__data_1a1654977ec3a066c709eb80476c9565f9" prot="private" virt="non-virtual"><scope>mom_io::mom_read_data</scope><name>mom_read_data_1d</name></member>
      <member refid="interfacemom__io_1_1mom__read__data_1a3dfc4ff2a1046e81623c2de711036206" prot="private" virt="non-virtual"><scope>mom_io::mom_read_data</scope><name>mom_read_data_2d</name></member>
      <member refid="interfacemom__io_1_1mom__read__data_1a8d8b4317fa8b790ec2cecfd15befd3dd" prot="private" virt="non-virtual"><scope>mom_io::mom_read_data</scope><name>mom_read_data_3d</name></member>
      <member refid="interfacemom__io_1_1mom__read__data_1a2bb1880532b2332ec27cae5076cdeecd" prot="private" virt="non-virtual"><scope>mom_io::mom_read_data</scope><name>mom_read_data_4d</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
