<?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.13">
  <compounddef id="interfacemom__horizontal__regridding_1_1horiz__interp__and__extrap__tracer" kind="interface" language="Fortran" prot="private">
    <compoundname>mom_horizontal_regridding::horiz_interp_and_extrap_tracer</compoundname>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="interfacemom__horizontal__regridding_1_1horiz__interp__and__extrap__tracer_1ae5a5c16a37650f58c7a1f3e990ac7d07" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_horizontal_regridding::horiz_interp_and_extrap_tracer::horiz_interp_and_extrap_tracer_record</definition>
        <argsstring>(filename, varnam, conversion, recnum, G, tr_z, mask_z, z_in, z_edges_in, missing_value, reentrant_x, tripolar_n, homogenize, m_to_Z, answers_2018, ongrid)</argsstring>
        <name>horiz_interp_and_extrap_tracer_record</name>
        <param>
          <type>filename</type>
          <defname>filename</defname>
        </param>
        <param>
          <type>varnam</type>
          <defname>varnam</defname>
        </param>
        <param>
          <type>conversion</type>
          <defname>conversion</defname>
        </param>
        <param>
          <type>recnum</type>
          <defname>recnum</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>tr_z</type>
          <defname>tr_z</defname>
        </param>
        <param>
          <type>mask_z</type>
          <defname>mask_z</defname>
        </param>
        <param>
          <type>z_in</type>
          <defname>z_in</defname>
        </param>
        <param>
          <type>z_edges_in</type>
          <defname>z_edges_in</defname>
        </param>
        <param>
          <type>missing_value</type>
          <defname>missing_value</defname>
        </param>
        <param>
          <type>reentrant_x</type>
          <defname>reentrant_x</defname>
        </param>
        <param>
          <type>tripolar_n</type>
          <defname>tripolar_n</defname>
        </param>
        <param>
          <type>homogenize</type>
          <defname>homogenize</defname>
        </param>
        <param>
          <type>m_to_Z</type>
          <defname>m_to_Z</defname>
        </param>
        <param>
          <type>answers_2018</type>
          <defname>answers_2018</defname>
        </param>
        <param>
          <type>ongrid</type>
          <defname>ongrid</defname>
        </param>
        <briefdescription>
<para>Extrapolate and interpolate from a file record. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">filename</parametername>
</parameternamelist>
<parameterdescription>
<para>Path to file containing tracer to be interpolated.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">varnam</parametername>
</parameternamelist>
<parameterdescription>
<para>Name of tracer in filee.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">conversion</parametername>
</parameternamelist>
<parameterdescription>
<para>Conversion factor for tracer.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">recnum</parametername>
</parameternamelist>
<parameterdescription>
<para>Record number of tracer to be read.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Grid object</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>tr_z</parametername>
</parameternamelist>
<parameterdescription>
<para>pointer to allocatable tracer array on local model grid and input-file vertical levels.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>mask_z</parametername>
</parameternamelist>
<parameterdescription>
<para>pointer to allocatable tracer mask array on local model grid and input-file vertical levels.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>z_in</parametername>
</parameternamelist>
<parameterdescription>
<para>Cell grid values for input data.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>z_edges_in</parametername>
</parameternamelist>
<parameterdescription>
<para>Cell grid edge values for input data.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">missing_value</parametername>
</parameternamelist>
<parameterdescription>
<para>The missing value in the returned array.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">reentrant_x</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, this grid is reentrant in the x-direction</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">tripolar_n</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, this is a northern tripolar grid</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">homogenize</parametername>
</parameternamelist>
<parameterdescription>
<para>If present and true, horizontally homogenize data to produce perfectly &quot;flat&quot; initial conditions</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">m_to_z</parametername>
</parameternamelist>
<parameterdescription>
<para>A conversion factor from meters to the units of depth. If missing, GbathyT must be in m.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">answers_2018</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, use expressions that give the same answers as the code did in late 2018. Otherwise add parentheses for rotational symmetry.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ongrid</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, then data are assumed to have been interpolated to the model horizontal grid. In this case, only extrapolation is performed by this routine </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_horizontal_regridding.F90" line="274" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_horizontal_regridding.F90" bodystart="277" bodyend="629"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__horizontal__regridding_1_1horiz__interp__and__extrap__tracer_1a98eb8d64a7d2d7c52cca004c10d51ff4" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_horizontal_regridding::horiz_interp_and_extrap_tracer::horiz_interp_and_extrap_tracer_fms_id</definition>
        <argsstring>(fms_id, Time, conversion, G, tr_z, mask_z, z_in, z_edges_in, missing_value, reentrant_x, tripolar_n, homogenize, spongeOngrid, m_to_Z, answers_2018)</argsstring>
        <name>horiz_interp_and_extrap_tracer_fms_id</name>
        <param>
          <type>fms_id</type>
          <defname>fms_id</defname>
        </param>
        <param>
          <type>Time</type>
          <defname>Time</defname>
        </param>
        <param>
          <type>conversion</type>
          <defname>conversion</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>tr_z</type>
          <defname>tr_z</defname>
        </param>
        <param>
          <type>mask_z</type>
          <defname>mask_z</defname>
        </param>
        <param>
          <type>z_in</type>
          <defname>z_in</defname>
        </param>
        <param>
          <type>z_edges_in</type>
          <defname>z_edges_in</defname>
        </param>
        <param>
          <type>missing_value</type>
          <defname>missing_value</defname>
        </param>
        <param>
          <type>reentrant_x</type>
          <defname>reentrant_x</defname>
        </param>
        <param>
          <type>tripolar_n</type>
          <defname>tripolar_n</defname>
        </param>
        <param>
          <type>homogenize</type>
          <defname>homogenize</defname>
        </param>
        <param>
          <type>spongeOngrid</type>
          <defname>spongeOngrid</defname>
        </param>
        <param>
          <type>m_to_Z</type>
          <defname>m_to_Z</defname>
        </param>
        <param>
          <type>answers_2018</type>
          <defname>answers_2018</defname>
        </param>
        <briefdescription>
<para>Extrapolate and interpolate using a FMS time interpolation handle. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">fms_id</parametername>
</parameternamelist>
<parameterdescription>
<para>A unique id used by the FMS time interpolator</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">time</parametername>
</parameternamelist>
<parameterdescription>
<para>A FMS time type</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">conversion</parametername>
</parameternamelist>
<parameterdescription>
<para>Conversion factor for tracer.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Grid object</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>tr_z</parametername>
</parameternamelist>
<parameterdescription>
<para>pointer to allocatable tracer array on local model grid and native vertical levels.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>mask_z</parametername>
</parameternamelist>
<parameterdescription>
<para>pointer to allocatable tracer mask array on local model grid and native vertical levels.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>z_in</parametername>
</parameternamelist>
<parameterdescription>
<para>Cell grid values for input data.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>z_edges_in</parametername>
</parameternamelist>
<parameterdescription>
<para>Cell grid edge values for input data. (Intent out)</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">missing_value</parametername>
</parameternamelist>
<parameterdescription>
<para>The missing value in the returned array.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">reentrant_x</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, this grid is reentrant in the x-direction</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">tripolar_n</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, this is a northern tripolar grid</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">homogenize</parametername>
</parameternamelist>
<parameterdescription>
<para>If present and true, horizontally homogenize data to produce perfectly &quot;flat&quot; initial conditions</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">spongeongrid</parametername>
</parameternamelist>
<parameterdescription>
<para>If present and true, the sponge data are on the model grid</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">m_to_z</parametername>
</parameternamelist>
<parameterdescription>
<para>A conversion factor from meters to the units of depth. If missing, GbathyT must be in m.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">answers_2018</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, use expressions that give the same answers as the code did in late 2018. Otherwise add parentheses for rotational symmetry. </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_horizontal_regridding.F90" line="633" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_horizontal_regridding.F90" bodystart="636" bodyend="923"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Extrapolate and interpolate data. </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_horizontal_regridding.F90" line="53" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_horizontal_regridding.F90" bodystart="53" bodyend="55"/>
    <listofallmembers>
      <member refid="interfacemom__horizontal__regridding_1_1horiz__interp__and__extrap__tracer_1a98eb8d64a7d2d7c52cca004c10d51ff4" prot="private" virt="non-virtual"><scope>mom_horizontal_regridding::horiz_interp_and_extrap_tracer</scope><name>horiz_interp_and_extrap_tracer_fms_id</name></member>
      <member refid="interfacemom__horizontal__regridding_1_1horiz__interp__and__extrap__tracer_1ae5a5c16a37650f58c7a1f3e990ac7d07" prot="private" virt="non-virtual"><scope>mom_horizontal_regridding::horiz_interp_and_extrap_tracer</scope><name>horiz_interp_and_extrap_tracer_record</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
