<?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="namespacemom__transform__fms" kind="namespace" language="Fortran">
    <compoundname>mom_transform_fms</compoundname>
    <innerclass refid="interfacemom__transform__fms_1_1rotated__mpp__chksum" prot="private">mom_transform_fms::rotated_mpp_chksum</innerclass>
    <innerclass refid="interfacemom__transform__fms_1_1rotated__time__interp__external" prot="private">mom_transform_fms::rotated_time_interp_external</innerclass>
    <innerclass refid="interfacemom__transform__fms_1_1rotated__write__field" prot="private">mom_transform_fms::rotated_write_field</innerclass>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacemom__transform__fms_1af2a926d5cc524276b429fa4156be89d8" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>integer function</type>
        <definition>integer function mom_transform_fms::rotated_mpp_chksum_real_0d</definition>
        <argsstring>(field, pelist, mask_val, turns)</argsstring>
        <name>rotated_mpp_chksum_real_0d</name>
        <param>
          <type>field</type>
          <defname>field</defname>
        </param>
        <param>
          <type>pelist</type>
          <defname>pelist</defname>
        </param>
        <param>
          <type>mask_val</type>
          <defname>mask_val</defname>
        </param>
        <param>
          <type>turns</type>
          <defname>turns</defname>
        </param>
        <briefdescription>
<para>Compute the FMS (mpp) checksum of a scalar. This function is provided to support the full FMS mpp_chksum interface. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" line="56" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" bodystart="58" bodyend="67"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
      </memberdef>
      <memberdef kind="function" id="namespacemom__transform__fms_1a79f9c2d49563712b519f914dc822c78f" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>integer function</type>
        <definition>integer function mom_transform_fms::rotated_mpp_chksum_real_1d</definition>
        <argsstring>(field, pelist, mask_val, turns)</argsstring>
        <name>rotated_mpp_chksum_real_1d</name>
        <param>
          <type>field</type>
          <defname>field</defname>
        </param>
        <param>
          <type>pelist</type>
          <defname>pelist</defname>
        </param>
        <param>
          <type>mask_val</type>
          <defname>mask_val</defname>
        </param>
        <param>
          <type>turns</type>
          <defname>turns</defname>
        </param>
        <briefdescription>
<para>Compute the FMS (mpp) checksum of a 1d field. This function is provided to support the full FMS mpp_chksum interface. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" line="73" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" bodystart="75" bodyend="84"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
      </memberdef>
      <memberdef kind="function" id="namespacemom__transform__fms_1aa0a52d3a9741060b7f48b0132bd0b4b4" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>integer function</type>
        <definition>integer function mom_transform_fms::rotated_mpp_chksum_real_2d</definition>
        <argsstring>(field, pelist, mask_val, turns)</argsstring>
        <name>rotated_mpp_chksum_real_2d</name>
        <param>
          <type>field</type>
          <defname>field</defname>
        </param>
        <param>
          <type>pelist</type>
          <defname>pelist</defname>
        </param>
        <param>
          <type>mask_val</type>
          <defname>mask_val</defname>
        </param>
        <param>
          <type>turns</type>
          <defname>turns</defname>
        </param>
        <briefdescription>
<para>Compute the FMS (mpp) checksum of a rotated 2d field. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" line="89" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" bodystart="91" bodyend="111"/>
      </memberdef>
      <memberdef kind="function" id="namespacemom__transform__fms_1a39eeef843db8a28b66344bd1ebcab5c9" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>integer function</type>
        <definition>integer function mom_transform_fms::rotated_mpp_chksum_real_3d</definition>
        <argsstring>(field, pelist, mask_val, turns)</argsstring>
        <name>rotated_mpp_chksum_real_3d</name>
        <param>
          <type>field</type>
          <defname>field</defname>
        </param>
        <param>
          <type>pelist</type>
          <defname>pelist</defname>
        </param>
        <param>
          <type>mask_val</type>
          <defname>mask_val</defname>
        </param>
        <param>
          <type>turns</type>
          <defname>turns</defname>
        </param>
        <briefdescription>
<para>Compute the FMS (mpp) checksum of a rotated 3d field. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" line="116" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" bodystart="118" bodyend="138"/>
      </memberdef>
      <memberdef kind="function" id="namespacemom__transform__fms_1ae465486bda33da51b35b16159c026801" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>integer function</type>
        <definition>integer function mom_transform_fms::rotated_mpp_chksum_real_4d</definition>
        <argsstring>(field, pelist, mask_val, turns)</argsstring>
        <name>rotated_mpp_chksum_real_4d</name>
        <param>
          <type>field</type>
          <defname>field</defname>
        </param>
        <param>
          <type>pelist</type>
          <defname>pelist</defname>
        </param>
        <param>
          <type>mask_val</type>
          <defname>mask_val</defname>
        </param>
        <param>
          <type>turns</type>
          <defname>turns</defname>
        </param>
        <briefdescription>
<para>Compute the FMS (mpp) checksum of a rotated 4d field. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" line="143" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" bodystart="145" bodyend="165"/>
      </memberdef>
      <memberdef kind="function" id="namespacemom__transform__fms_1a8ce2dcf42b708c710ae299cd916003a2" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_transform_fms::rotated_write_field_real_0d</definition>
        <argsstring>(io_unit, field_md, field, tstamp, turns)</argsstring>
        <name>rotated_write_field_real_0d</name>
        <param>
          <type>io_unit</type>
          <defname>io_unit</defname>
        </param>
        <param>
          <type>field_md</type>
          <defname>field_md</defname>
        </param>
        <param>
          <type>field</type>
          <defname>field</defname>
        </param>
        <param>
          <type>tstamp</type>
          <defname>tstamp</defname>
        </param>
        <param>
          <type>turns</type>
          <defname>turns</defname>
        </param>
        <briefdescription>
<para>Write the rotation of a 1d field to an FMS output file This function is provided to support the full FMS write_field interface. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" line="176" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" bodystart="177" bodyend="186"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
      </memberdef>
      <memberdef kind="function" id="namespacemom__transform__fms_1af475c9465236babeedb84a703a0a65e6" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_transform_fms::rotated_write_field_real_1d</definition>
        <argsstring>(io_unit, field_md, field, tstamp, turns)</argsstring>
        <name>rotated_write_field_real_1d</name>
        <param>
          <type>io_unit</type>
          <defname>io_unit</defname>
        </param>
        <param>
          <type>field_md</type>
          <defname>field_md</defname>
        </param>
        <param>
          <type>field</type>
          <defname>field</defname>
        </param>
        <param>
          <type>tstamp</type>
          <defname>tstamp</defname>
        </param>
        <param>
          <type>turns</type>
          <defname>turns</defname>
        </param>
        <briefdescription>
<para>Write the rotation of a 1d field to an FMS output file This function is provided to support the full FMS write_field interface. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" line="192" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" bodystart="193" bodyend="202"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
      </memberdef>
      <memberdef kind="function" id="namespacemom__transform__fms_1a8faa32cfee12ceeeeed48c5f7feafe11" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_transform_fms::rotated_write_field_real_2d</definition>
        <argsstring>(io_unit, field_md, domain, field, tstamp, tile_count, default_data, turns)</argsstring>
        <name>rotated_write_field_real_2d</name>
        <param>
          <type>io_unit</type>
          <defname>io_unit</defname>
        </param>
        <param>
          <type>field_md</type>
          <defname>field_md</defname>
        </param>
        <param>
          <type>domain</type>
          <defname>domain</defname>
        </param>
        <param>
          <type>field</type>
          <defname>field</defname>
        </param>
        <param>
          <type>tstamp</type>
          <defname>tstamp</defname>
        </param>
        <param>
          <type>tile_count</type>
          <defname>tile_count</defname>
        </param>
        <param>
          <type>default_data</type>
          <defname>default_data</defname>
        </param>
        <param>
          <type>turns</type>
          <defname>turns</defname>
        </param>
        <briefdescription>
<para>Write the rotation of a 2d field to an FMS output file. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" line="207" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" bodystart="209" bodyend="234"/>
      </memberdef>
      <memberdef kind="function" id="namespacemom__transform__fms_1a77136bafb407a14836b5c0dd3a379eac" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_transform_fms::rotated_write_field_real_3d</definition>
        <argsstring>(io_unit, field_md, domain, field, tstamp, tile_count, default_data, turns)</argsstring>
        <name>rotated_write_field_real_3d</name>
        <param>
          <type>io_unit</type>
          <defname>io_unit</defname>
        </param>
        <param>
          <type>field_md</type>
          <defname>field_md</defname>
        </param>
        <param>
          <type>domain</type>
          <defname>domain</defname>
        </param>
        <param>
          <type>field</type>
          <defname>field</defname>
        </param>
        <param>
          <type>tstamp</type>
          <defname>tstamp</defname>
        </param>
        <param>
          <type>tile_count</type>
          <defname>tile_count</defname>
        </param>
        <param>
          <type>default_data</type>
          <defname>default_data</defname>
        </param>
        <param>
          <type>turns</type>
          <defname>turns</defname>
        </param>
        <briefdescription>
<para>Write the rotation of a 3d field to an FMS output file. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" line="239" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" bodystart="241" bodyend="266"/>
      </memberdef>
      <memberdef kind="function" id="namespacemom__transform__fms_1aa5379a4ba4767f7c616d110d210c76e2" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_transform_fms::rotated_write_field_real_4d</definition>
        <argsstring>(io_unit, field_md, domain, field, tstamp, tile_count, default_data, turns)</argsstring>
        <name>rotated_write_field_real_4d</name>
        <param>
          <type>io_unit</type>
          <defname>io_unit</defname>
        </param>
        <param>
          <type>field_md</type>
          <defname>field_md</defname>
        </param>
        <param>
          <type>domain</type>
          <defname>domain</defname>
        </param>
        <param>
          <type>field</type>
          <defname>field</defname>
        </param>
        <param>
          <type>tstamp</type>
          <defname>tstamp</defname>
        </param>
        <param>
          <type>tile_count</type>
          <defname>tile_count</defname>
        </param>
        <param>
          <type>default_data</type>
          <defname>default_data</defname>
        </param>
        <param>
          <type>turns</type>
          <defname>turns</defname>
        </param>
        <briefdescription>
<para>Write the rotation of a 4d field to an FMS output file. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" line="271" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" bodystart="273" bodyend="298"/>
      </memberdef>
      <memberdef kind="function" id="namespacemom__transform__fms_1acbcce06da1a4e4899ce3a05b1955bbda" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_transform_fms::rotated_time_interp_external_0d</definition>
        <argsstring>(fms_id, time, data_in, verbose, turns)</argsstring>
        <name>rotated_time_interp_external_0d</name>
        <param>
          <type>fms_id</type>
          <defname>fms_id</defname>
        </param>
        <param>
          <type>time</type>
          <defname>time</defname>
        </param>
        <param>
          <type>data_in</type>
          <defname>data_in</defname>
        </param>
        <param>
          <type>verbose</type>
          <defname>verbose</defname>
        </param>
        <param>
          <type>turns</type>
          <defname>turns</defname>
        </param>
        <briefdescription>
<para>Read a scalar field based on model time This function is provided to support the full FMS time_interp_external interface. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">fms_id</parametername>
</parameternamelist>
<parameterdescription>
<para>FMS field ID </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">time</parametername>
</parameternamelist>
<parameterdescription>
<para>Model time </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">data_in</parametername>
</parameternamelist>
<parameterdescription>
<para>field to write data </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">verbose</parametername>
</parameternamelist>
<parameterdescription>
<para>Verbose output </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">turns</parametername>
</parameternamelist>
<parameterdescription>
<para>Number of quarter turns </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" line="305" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" bodystart="307" bodyend="316"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
      </memberdef>
      <memberdef kind="function" id="namespacemom__transform__fms_1a71c1e653207f1f1332578266cd2bf624" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_transform_fms::rotated_time_interp_external_2d</definition>
        <argsstring>(fms_id, time, data_in, interp, verbose, horz_interp, mask_out, is_in, ie_in, js_in, je_in, window_id, turns)</argsstring>
        <name>rotated_time_interp_external_2d</name>
        <param>
          <type>fms_id</type>
          <defname>fms_id</defname>
        </param>
        <param>
          <type>time</type>
          <defname>time</defname>
        </param>
        <param>
          <type>data_in</type>
          <defname>data_in</defname>
        </param>
        <param>
          <type>interp</type>
          <defname>interp</defname>
        </param>
        <param>
          <type>verbose</type>
          <defname>verbose</defname>
        </param>
        <param>
          <type>horz_interp</type>
          <defname>horz_interp</defname>
        </param>
        <param>
          <type>mask_out</type>
          <defname>mask_out</defname>
        </param>
        <param>
          <type>is_in</type>
          <defname>is_in</defname>
        </param>
        <param>
          <type>ie_in</type>
          <defname>ie_in</defname>
        </param>
        <param>
          <type>js_in</type>
          <defname>js_in</defname>
        </param>
        <param>
          <type>je_in</type>
          <defname>je_in</defname>
        </param>
        <param>
          <type>window_id</type>
          <defname>window_id</defname>
        </param>
        <param>
          <type>turns</type>
          <defname>turns</defname>
        </param>
        <briefdescription>
<para>Read a 2d field based on model time, and rotate to the model grid. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" line="320" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" bodystart="323" bodyend="359"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
      </memberdef>
      <memberdef kind="function" id="namespacemom__transform__fms_1a1599edc1aeed5a2ce7df0f953c2dda0e" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_transform_fms::rotated_time_interp_external_3d</definition>
        <argsstring>(fms_id, time, data_in, interp, verbose, horz_interp, mask_out, is_in, ie_in, js_in, je_in, window_id, turns)</argsstring>
        <name>rotated_time_interp_external_3d</name>
        <param>
          <type>fms_id</type>
          <defname>fms_id</defname>
        </param>
        <param>
          <type>time</type>
          <defname>time</defname>
        </param>
        <param>
          <type>data_in</type>
          <defname>data_in</defname>
        </param>
        <param>
          <type>interp</type>
          <defname>interp</defname>
        </param>
        <param>
          <type>verbose</type>
          <defname>verbose</defname>
        </param>
        <param>
          <type>horz_interp</type>
          <defname>horz_interp</defname>
        </param>
        <param>
          <type>mask_out</type>
          <defname>mask_out</defname>
        </param>
        <param>
          <type>is_in</type>
          <defname>is_in</defname>
        </param>
        <param>
          <type>ie_in</type>
          <defname>ie_in</defname>
        </param>
        <param>
          <type>js_in</type>
          <defname>js_in</defname>
        </param>
        <param>
          <type>je_in</type>
          <defname>je_in</defname>
        </param>
        <param>
          <type>window_id</type>
          <defname>window_id</defname>
        </param>
        <param>
          <type>turns</type>
          <defname>turns</defname>
        </param>
        <briefdescription>
<para>Read a 3d field based on model time, and rotate to the model grid. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" line="364" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" bodystart="367" bodyend="402"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Support functions and interfaces to permit transformed model domains to interact with FMS operations registered on the non-transformed domains. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_transform_FMS.F90" line="4" column="1"/>
  </compounddef>
</doxygen>
