<?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.17">
  <compounddef id="namespacemom__continuity__ppm" kind="namespace" language="Fortran">
    <compoundname>mom_continuity_ppm</compoundname>
    <innerclass refid="structmom__continuity__ppm_1_1continuity__ppm__cs" prot="public">mom_continuity_ppm::continuity_ppm_cs</innerclass>
    <innerclass refid="structmom__continuity__ppm_1_1loop__bounds__type" prot="private">mom_continuity_ppm::loop_bounds_type</innerclass>
      <sectiondef kind="user-defined">
      <memberdef kind="variable" id="namespacemom__continuity__ppm_1a6002197c46343ec4d08cab937db87586" prot="private" static="no" mutable="no">
        <type>integer</type>
        <definition>integer mom_continuity_ppm::id_clock_update</definition>
        <argsstring></argsstring>
        <name>id_clock_update</name>
        <briefdescription>
<para>CPU time clock IDs. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="24" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="24" bodyend="24"/>
        <referencedby refid="namespacemom__continuity__ppm_1a665851a49a4bde77b4ef5e25332947f6" compoundref="MOM__continuity__PPM_8F90" startline="78" endline="207">continuity_ppm</referencedby>
        <referencedby refid="namespacemom__continuity__ppm_1a832c506364bca555b36409a91e0f5906" compoundref="MOM__continuity__PPM_8F90" startline="2230" endline="2321">continuity_ppm_init</referencedby>
        <referencedby refid="namespacemom__continuity__ppm_1ae64c4b7cd1756aa3c121fbcf637d5cae" compoundref="MOM__continuity__PPM_8F90" startline="1039" endline="1336">meridional_mass_flux</referencedby>
        <referencedby refid="namespacemom__continuity__ppm_1a5f5d6764ed315043d3b91b209db5c0a0" compoundref="MOM__continuity__PPM_8F90" startline="213" endline="517">zonal_mass_flux</referencedby>
      </memberdef>
      <memberdef kind="variable" id="namespacemom__continuity__ppm_1a4b409d0d89dbdbbea05f4a3ade088902" prot="private" static="no" mutable="no">
        <type>integer</type>
        <definition>integer mom_continuity_ppm::id_clock_correct</definition>
        <argsstring></argsstring>
        <name>id_clock_correct</name>
        <briefdescription>
<para>CPU time clock IDs. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="24" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="24" bodyend="-1"/>
        <referencedby refid="namespacemom__continuity__ppm_1a832c506364bca555b36409a91e0f5906" compoundref="MOM__continuity__PPM_8F90" startline="2230" endline="2321">continuity_ppm_init</referencedby>
        <referencedby refid="namespacemom__continuity__ppm_1ae64c4b7cd1756aa3c121fbcf637d5cae" compoundref="MOM__continuity__PPM_8F90" startline="1039" endline="1336">meridional_mass_flux</referencedby>
        <referencedby refid="namespacemom__continuity__ppm_1a5f5d6764ed315043d3b91b209db5c0a0" compoundref="MOM__continuity__PPM_8F90" startline="213" endline="517">zonal_mass_flux</referencedby>
      </memberdef>
      </sectiondef>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacemom__continuity__ppm_1a665851a49a4bde77b4ef5e25332947f6" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_continuity_ppm::continuity_ppm</definition>
        <argsstring>(u, v, hin, h, uh, vh, dt, G, GV, US, CS, uhbt, vhbt, OBC, visc_rem_u, visc_rem_v, u_cor, v_cor, BT_cont)</argsstring>
        <name>continuity_ppm</name>
        <param>
          <type>u</type>
          <defname>u</defname>
        </param>
        <param>
          <type>v</type>
          <defname>v</defname>
        </param>
        <param>
          <type>hin</type>
          <defname>hin</defname>
        </param>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>uh</type>
          <defname>uh</defname>
        </param>
        <param>
          <type>vh</type>
          <defname>vh</defname>
        </param>
        <param>
          <type>dt</type>
          <defname>dt</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>uhbt</type>
          <defname>uhbt</defname>
        </param>
        <param>
          <type>vhbt</type>
          <defname>vhbt</defname>
        </param>
        <param>
          <type>OBC</type>
          <defname>OBC</defname>
        </param>
        <param>
          <type>visc_rem_u</type>
          <defname>visc_rem_u</defname>
        </param>
        <param>
          <type>visc_rem_v</type>
          <defname>visc_rem_v</defname>
        </param>
        <param>
          <type>u_cor</type>
          <defname>u_cor</defname>
        </param>
        <param>
          <type>v_cor</type>
          <defname>v_cor</defname>
        </param>
        <param>
          <type>BT_cont</type>
          <defname>BT_cont</defname>
        </param>
        <briefdescription>
<para>Time steps the layer thicknesses, using a monotonically limit, directionally split PPM scheme, based on Lin (1994). </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">g</parametername>
</parameternamelist>
<parameterdescription>
<para>The ocean&apos;s grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Module&apos;s control structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">u</parametername>
</parameternamelist>
<parameterdescription>
<para>Zonal velocity [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">v</parametername>
</parameternamelist>
<parameterdescription>
<para>Meridional velocity [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">hin</parametername>
</parameternamelist>
<parameterdescription>
<para>Initial layer thickness [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">h</parametername>
</parameternamelist>
<parameterdescription>
<para>Final layer thickness [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">uh</parametername>
</parameternamelist>
<parameterdescription>
<para>Zonal volume flux, u*h*dy [H L2 T-1 ~&gt; m3 s-1 or kg s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">vh</parametername>
</parameternamelist>
<parameterdescription>
<para>Meridional volume flux, v*h*dx [H L2 T-1 ~&gt; m3 s-1 or kg s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dt</parametername>
</parameternamelist>
<parameterdescription>
<para>Time increment [T ~&gt; s]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>Vertical grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">us</parametername>
</parameternamelist>
<parameterdescription>
<para>A dimensional unit scaling type </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">uhbt</parametername>
</parameternamelist>
<parameterdescription>
<para>The summed volume flux through zonal faces </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">vhbt</parametername>
</parameternamelist>
<parameterdescription>
<para>The summed volume flux through meridional faces </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>obc</parametername>
</parameternamelist>
<parameterdescription>
<para>Open boundaries control structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">visc_rem_u</parametername>
</parameternamelist>
<parameterdescription>
<para>The fraction of zonal momentum originally in a layer that remains after a time-step of viscosity, and the fraction of a time-step&apos;s worth of a barotropic acceleration that a layer experiences after viscosity is applied. Non-dimensional between 0 (at the bottom) and 1 (far above the bottom). </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">visc_rem_v</parametername>
</parameternamelist>
<parameterdescription>
<para>The fraction of meridional momentum originally in a layer that remains after a time-step of viscosity, and the fraction of a time-step&apos;s worth of a barotropic acceleration that a layer experiences after viscosity is applied. Non-dimensional between 0 (at the bottom) and 1 (far above the bottom). </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">u_cor</parametername>
</parameternamelist>
<parameterdescription>
<para>The zonal velocities that give uhbt as the depth-integrated transport [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">v_cor</parametername>
</parameternamelist>
<parameterdescription>
<para>The meridional velocities that give vhbt as the depth-integrated transport [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>bt_cont</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure with elements that describe the effective open face areas as a function of barotropic flow. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="76" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="78" bodyend="207"/>
        <references refid="namespacemom__continuity__ppm_1a6002197c46343ec4d08cab937db87586" compoundref="MOM__continuity__PPM_8F90" startline="24" endline="24">id_clock_update</references>
        <references refid="namespacemom__continuity__ppm_1ae64c4b7cd1756aa3c121fbcf637d5cae" compoundref="MOM__continuity__PPM_8F90" startline="1039" endline="1336">meridional_mass_flux</references>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <references refid="namespacemom__continuity__ppm_1a5f5d6764ed315043d3b91b209db5c0a0" compoundref="MOM__continuity__PPM_8F90" startline="213" endline="517">zonal_mass_flux</references>
      </memberdef>
      <memberdef kind="function" id="namespacemom__continuity__ppm_1a5f5d6764ed315043d3b91b209db5c0a0" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_continuity_ppm::zonal_mass_flux</definition>
        <argsstring>(u, h_in, uh, dt, G, GV, US, CS, LB, uhbt, OBC, visc_rem_u, u_cor, BT_cont)</argsstring>
        <name>zonal_mass_flux</name>
        <param>
          <type>u</type>
          <defname>u</defname>
        </param>
        <param>
          <type>h_in</type>
          <defname>h_in</defname>
        </param>
        <param>
          <type>uh</type>
          <defname>uh</defname>
        </param>
        <param>
          <type>dt</type>
          <defname>dt</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>LB</type>
          <defname>LB</defname>
        </param>
        <param>
          <type>uhbt</type>
          <defname>uhbt</defname>
        </param>
        <param>
          <type>OBC</type>
          <defname>OBC</defname>
        </param>
        <param>
          <type>visc_rem_u</type>
          <defname>visc_rem_u</defname>
        </param>
        <param>
          <type>u_cor</type>
          <defname>u_cor</defname>
        </param>
        <param>
          <type>BT_cont</type>
          <defname>BT_cont</defname>
        </param>
        <briefdescription>
<para>Calculates the mass or volume fluxes through the zonal faces, and other related quantities. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean&apos;s grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean&apos;s vertical grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">u</parametername>
</parameternamelist>
<parameterdescription>
<para>Zonal velocity [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_in</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thickness used to calculate fluxes [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">uh</parametername>
</parameternamelist>
<parameterdescription>
<para>Volume flux through zonal faces = u*h*dy </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dt</parametername>
</parameternamelist>
<parameterdescription>
<para>Time increment [T ~&gt; s]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">us</parametername>
</parameternamelist>
<parameterdescription>
<para>A dimensional unit scaling type </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>This module&apos;s control structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">lb</parametername>
</parameternamelist>
<parameterdescription>
<para>Loop bounds structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>obc</parametername>
</parameternamelist>
<parameterdescription>
<para>Open boundaries control structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">visc_rem_u</parametername>
</parameternamelist>
<parameterdescription>
<para>The fraction of zonal momentum originally in a layer that remains after a time-step of viscosity, and the fraction of a time-step&apos;s worth of a barotropic acceleration that a layer experiences after viscosity is applied. Non-dimensional between 0 (at the bottom) and 1 (far above the bottom). </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">uhbt</parametername>
</parameternamelist>
<parameterdescription>
<para>The summed volume flux through zonal faces </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">u_cor</parametername>
</parameternamelist>
<parameterdescription>
<para>The zonal velocitiess (u with a barotropic correction) that give uhbt as the depth-integrated transport, m s-1. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>bt_cont</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure with elements that describe the effective open face areas as a function of barotropic flow. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="211" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="213" bodyend="517"/>
        <references refid="namespacemom__continuity__ppm_1a4b409d0d89dbdbbea05f4a3ade088902" compoundref="MOM__continuity__PPM_8F90" startline="24">id_clock_correct</references>
        <references refid="namespacemom__continuity__ppm_1a6002197c46343ec4d08cab937db87586" compoundref="MOM__continuity__PPM_8F90" startline="24" endline="24">id_clock_update</references>
        <references refid="namespacemom__open__boundary_1a876256dbb0556d7e04cdf091f1744b65" compoundref="MOM__open__boundary_8F90" startline="75" endline="75">mom_open_boundary::obc_direction_e</references>
        <references refid="namespacemom__continuity__ppm_1a9a7eac2a9b17d0e9ee9ca0a27d2f8fb6" compoundref="MOM__continuity__PPM_8F90" startline="1859" endline="1993">ppm_reconstruction_x</references>
        <references refid="namespacemom__continuity__ppm_1adf02002cf5951d7610b8643d2d401585" compoundref="MOM__continuity__PPM_8F90" startline="2216" endline="2225">ratio_max</references>
        <references refid="namespacemom__continuity__ppm_1a30e5aef71acbeef6afe5f6cf1ea30dcc" compoundref="MOM__continuity__PPM_8F90" startline="877" endline="1033">set_zonal_bt_cont</references>
        <references refid="namespacemom__continuity__ppm_1a9e76825c96ffca1ae0e84469ab46029b" compoundref="MOM__continuity__PPM_8F90" startline="605" endline="705">zonal_face_thickness</references>
        <references refid="namespacemom__continuity__ppm_1afad3f82b9824a13d3fe8792496e9b769" compoundref="MOM__continuity__PPM_8F90" startline="713" endline="869">zonal_flux_adjust</references>
        <references refid="namespacemom__continuity__ppm_1a713196d0cfe6cb4cc8a91239a8dba02d" compoundref="MOM__continuity__PPM_8F90" startline="523" endline="599">zonal_flux_layer</references>
        <referencedby refid="namespacemom__continuity__ppm_1a665851a49a4bde77b4ef5e25332947f6" compoundref="MOM__continuity__PPM_8F90" startline="78" endline="207">continuity_ppm</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__continuity__ppm_1a713196d0cfe6cb4cc8a91239a8dba02d" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_continuity_ppm::zonal_flux_layer</definition>
        <argsstring>(u, h, h_L, h_R, uh, duhdu, visc_rem, dt, G, US, j, ish, ieh, do_I, vol_CFL, OBC)</argsstring>
        <name>zonal_flux_layer</name>
        <param>
          <type>u</type>
          <defname>u</defname>
        </param>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>h_L</type>
          <defname>h_L</defname>
        </param>
        <param>
          <type>h_R</type>
          <defname>h_R</defname>
        </param>
        <param>
          <type>uh</type>
          <defname>uh</defname>
        </param>
        <param>
          <type>duhdu</type>
          <defname>duhdu</defname>
        </param>
        <param>
          <type>visc_rem</type>
          <defname>visc_rem</defname>
        </param>
        <param>
          <type>dt</type>
          <defname>dt</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>j</type>
          <defname>j</defname>
        </param>
        <param>
          <type>ish</type>
          <defname>ish</defname>
        </param>
        <param>
          <type>ieh</type>
          <defname>ieh</defname>
        </param>
        <param>
          <type>do_I</type>
          <defname>do_I</defname>
        </param>
        <param>
          <type>vol_CFL</type>
          <defname>vol_CFL</defname>
        </param>
        <param>
          <type>OBC</type>
          <defname>OBC</defname>
        </param>
        <briefdescription>
<para>Evaluates the zonal mass or volume fluxes in a layer. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean&apos;s grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">u</parametername>
</parameternamelist>
<parameterdescription>
<para>Zonal velocity [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">visc_rem</parametername>
</parameternamelist>
<parameterdescription>
<para>Both the fraction of the momentum originally in a layer that remains after a time-step of viscosity, and the fraction of a time-step&apos;s worth of a barotropic acceleration that a layer experiences after viscosity is applied. Non-dimensional between 0 (at the bottom) and 1 (far above the bottom). </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thickness [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_l</parametername>
</parameternamelist>
<parameterdescription>
<para>Left thickness [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_r</parametername>
</parameternamelist>
<parameterdescription>
<para>Right thickness [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">uh</parametername>
</parameternamelist>
<parameterdescription>
<para>Zonal mass or volume transport [H L2 T-1 ~&gt; m3 s-1 or kg s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">duhdu</parametername>
</parameternamelist>
<parameterdescription>
<para>Partial derivative of uh with u [H L ~&gt; m2 or kg m-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dt</parametername>
</parameternamelist>
<parameterdescription>
<para>Time increment [T ~&gt; s]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">us</parametername>
</parameternamelist>
<parameterdescription>
<para>A dimensional unit scaling type </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">j</parametername>
</parameternamelist>
<parameterdescription>
<para>Spatial index. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ish</parametername>
</parameternamelist>
<parameterdescription>
<para>Start of index range. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ieh</parametername>
</parameternamelist>
<parameterdescription>
<para>End of index range. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">do_i</parametername>
</parameternamelist>
<parameterdescription>
<para>Which i values to work on. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">vol_cfl</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, rescale the ratio of face areas to the cell areas when estimating the CFL number. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>obc</parametername>
</parameternamelist>
<parameterdescription>
<para>Open boundaries control structure. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="521" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="523" bodyend="599"/>
        <references refid="namespacemom__open__boundary_1a876256dbb0556d7e04cdf091f1744b65" compoundref="MOM__open__boundary_8F90" startline="75" endline="75">mom_open_boundary::obc_direction_e</references>
        <referencedby refid="namespacemom__continuity__ppm_1a30e5aef71acbeef6afe5f6cf1ea30dcc" compoundref="MOM__continuity__PPM_8F90" startline="877" endline="1033">set_zonal_bt_cont</referencedby>
        <referencedby refid="namespacemom__continuity__ppm_1afad3f82b9824a13d3fe8792496e9b769" compoundref="MOM__continuity__PPM_8F90" startline="713" endline="869">zonal_flux_adjust</referencedby>
        <referencedby refid="namespacemom__continuity__ppm_1a5f5d6764ed315043d3b91b209db5c0a0" compoundref="MOM__continuity__PPM_8F90" startline="213" endline="517">zonal_mass_flux</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__continuity__ppm_1a9e76825c96ffca1ae0e84469ab46029b" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_continuity_ppm::zonal_face_thickness</definition>
        <argsstring>(u, h, h_L, h_R, h_u, dt, G, US, LB, vol_CFL, marginal, visc_rem_u, OBC)</argsstring>
        <name>zonal_face_thickness</name>
        <param>
          <type>u</type>
          <defname>u</defname>
        </param>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>h_L</type>
          <defname>h_L</defname>
        </param>
        <param>
          <type>h_R</type>
          <defname>h_R</defname>
        </param>
        <param>
          <type>h_u</type>
          <defname>h_u</defname>
        </param>
        <param>
          <type>dt</type>
          <defname>dt</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>LB</type>
          <defname>LB</defname>
        </param>
        <param>
          <type>vol_CFL</type>
          <defname>vol_CFL</defname>
        </param>
        <param>
          <type>marginal</type>
          <defname>marginal</defname>
        </param>
        <param>
          <type>visc_rem_u</type>
          <defname>visc_rem_u</defname>
        </param>
        <param>
          <type>OBC</type>
          <defname>OBC</defname>
        </param>
        <briefdescription>
<para>Sets the effective interface thickness at each zonal velocity point. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean&apos;s grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">u</parametername>
</parameternamelist>
<parameterdescription>
<para>Zonal velocity [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thickness used to calculate fluxes [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_l</parametername>
</parameternamelist>
<parameterdescription>
<para>Left thickness in the reconstruction [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_r</parametername>
</parameternamelist>
<parameterdescription>
<para>Right thickness in the reconstruction [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">h_u</parametername>
</parameternamelist>
<parameterdescription>
<para>Thickness at zonal faces [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dt</parametername>
</parameternamelist>
<parameterdescription>
<para>Time increment [T ~&gt; s]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">us</parametername>
</parameternamelist>
<parameterdescription>
<para>A dimensional unit scaling type </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">lb</parametername>
</parameternamelist>
<parameterdescription>
<para>Loop bounds structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">vol_cfl</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, rescale the ratio of face areas to the cell areas when estimating the CFL number. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">marginal</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, report the marginal face thicknesses; otherwise report transport-averaged thicknesses. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">visc_rem_u</parametername>
</parameternamelist>
<parameterdescription>
<para>Both the fraction of the momentum originally in a layer that remains after a time-step of viscosity, and the fraction of a time-step&apos;s worth of a barotropic acceleration that a layer experiences after viscosity is applied. Non-dimensional between 0 (at the bottom) and 1 (far above the bottom). </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>obc</parametername>
</parameternamelist>
<parameterdescription>
<para>Open boundaries control structure. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="603" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="605" bodyend="705"/>
        <references refid="namespacemom__open__boundary_1a876256dbb0556d7e04cdf091f1744b65" compoundref="MOM__open__boundary_8F90" startline="75" endline="75">mom_open_boundary::obc_direction_e</references>
        <referencedby refid="namespacemom__continuity__ppm_1a5f5d6764ed315043d3b91b209db5c0a0" compoundref="MOM__continuity__PPM_8F90" startline="213" endline="517">zonal_mass_flux</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__continuity__ppm_1afad3f82b9824a13d3fe8792496e9b769" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_continuity_ppm::zonal_flux_adjust</definition>
        <argsstring>(u, h_in, h_L, h_R, uhbt, uh_tot_0, duhdu_tot_0, du, du_max_CFL, du_min_CFL, dt, G, US, CS, visc_rem, j, ish, ieh, do_I_in, full_precision, uh_3d, OBC)</argsstring>
        <name>zonal_flux_adjust</name>
        <param>
          <type>u</type>
          <defname>u</defname>
        </param>
        <param>
          <type>h_in</type>
          <defname>h_in</defname>
        </param>
        <param>
          <type>h_L</type>
          <defname>h_L</defname>
        </param>
        <param>
          <type>h_R</type>
          <defname>h_R</defname>
        </param>
        <param>
          <type>uhbt</type>
          <defname>uhbt</defname>
        </param>
        <param>
          <type>uh_tot_0</type>
          <defname>uh_tot_0</defname>
        </param>
        <param>
          <type>duhdu_tot_0</type>
          <defname>duhdu_tot_0</defname>
        </param>
        <param>
          <type>du</type>
          <defname>du</defname>
        </param>
        <param>
          <type>du_max_CFL</type>
          <defname>du_max_CFL</defname>
        </param>
        <param>
          <type>du_min_CFL</type>
          <defname>du_min_CFL</defname>
        </param>
        <param>
          <type>dt</type>
          <defname>dt</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>visc_rem</type>
          <defname>visc_rem</defname>
        </param>
        <param>
          <type>j</type>
          <defname>j</defname>
        </param>
        <param>
          <type>ish</type>
          <defname>ish</defname>
        </param>
        <param>
          <type>ieh</type>
          <defname>ieh</defname>
        </param>
        <param>
          <type>do_I_in</type>
          <defname>do_I_in</defname>
        </param>
        <param>
          <type>full_precision</type>
          <defname>full_precision</defname>
        </param>
        <param>
          <type>uh_3d</type>
          <defname>uh_3d</defname>
        </param>
        <param>
          <type>OBC</type>
          <defname>OBC</defname>
        </param>
        <briefdescription>
<para>Returns the barotropic velocity adjustment that gives the desired barotropic (layer-summed) transport. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean&apos;s grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">u</parametername>
</parameternamelist>
<parameterdescription>
<para>Zonal velocity [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_in</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thickness used to calculate fluxes [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_l</parametername>
</parameternamelist>
<parameterdescription>
<para>Left thickness in the reconstruction [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_r</parametername>
</parameternamelist>
<parameterdescription>
<para>Right thickness in the reconstruction [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">visc_rem</parametername>
</parameternamelist>
<parameterdescription>
<para>Both the fraction of the momentum originally in a layer that remains after a time-step of viscosity, and the fraction of a time-step&apos;s worth of a barotropic acceleration that a layer experiences after viscosity is applied. Non-dimensional between 0 (at the bottom) and 1 (far above the bottom). </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">uhbt</parametername>
</parameternamelist>
<parameterdescription>
<para>The summed volume flux through zonal faces [H L2 T-1 ~&gt; m3 s-1 or kg s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">du_max_cfl</parametername>
</parameternamelist>
<parameterdescription>
<para>Maximum acceptable value of du [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">du_min_cfl</parametername>
</parameternamelist>
<parameterdescription>
<para>Minimum acceptable value of du [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">uh_tot_0</parametername>
</parameternamelist>
<parameterdescription>
<para>The summed transport with 0 adjustment [H L2 T-1 ~&gt; m3 s-1 or kg s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">duhdu_tot_0</parametername>
</parameternamelist>
<parameterdescription>
<para>The partial derivative of du_err with du at 0 adjustment [H L ~&gt; m2 or kg m-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">du</parametername>
</parameternamelist>
<parameterdescription>
<para>The barotropic velocity adjustment [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dt</parametername>
</parameternamelist>
<parameterdescription>
<para>Time increment [T ~&gt; s]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">us</parametername>
</parameternamelist>
<parameterdescription>
<para>A dimensional unit scaling type </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>This module&apos;s control structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">j</parametername>
</parameternamelist>
<parameterdescription>
<para>Spatial index. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ish</parametername>
</parameternamelist>
<parameterdescription>
<para>Start of index range. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ieh</parametername>
</parameternamelist>
<parameterdescription>
<para>End of index range. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">do_i_in</parametername>
</parameternamelist>
<parameterdescription>
<para>A logical flag indicating which I values to work on. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">full_precision</parametername>
</parameternamelist>
<parameterdescription>
<para>A flag indicating how carefully to iterate. The default is .true. (more accurate). </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">uh_3d</parametername>
</parameternamelist>
<parameterdescription>
<para>Volume flux through zonal faces = u*h*dy [H L2 T-1 ~&gt; m3 s-1 or kg s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>obc</parametername>
</parameternamelist>
<parameterdescription>
<para>Open boundaries control structure. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="710" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="713" bodyend="869"/>
        <references refid="namespacemom__continuity__ppm_1a713196d0cfe6cb4cc8a91239a8dba02d" compoundref="MOM__continuity__PPM_8F90" startline="523" endline="599">zonal_flux_layer</references>
        <referencedby refid="namespacemom__continuity__ppm_1a30e5aef71acbeef6afe5f6cf1ea30dcc" compoundref="MOM__continuity__PPM_8F90" startline="877" endline="1033">set_zonal_bt_cont</referencedby>
        <referencedby refid="namespacemom__continuity__ppm_1a5f5d6764ed315043d3b91b209db5c0a0" compoundref="MOM__continuity__PPM_8F90" startline="213" endline="517">zonal_mass_flux</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__continuity__ppm_1a30e5aef71acbeef6afe5f6cf1ea30dcc" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_continuity_ppm::set_zonal_bt_cont</definition>
        <argsstring>(u, h_in, h_L, h_R, BT_cont, uh_tot_0, duhdu_tot_0, du_max_CFL, du_min_CFL, dt, G, US, CS, visc_rem, visc_rem_max, j, ish, ieh, do_I)</argsstring>
        <name>set_zonal_bt_cont</name>
        <param>
          <type>u</type>
          <defname>u</defname>
        </param>
        <param>
          <type>h_in</type>
          <defname>h_in</defname>
        </param>
        <param>
          <type>h_L</type>
          <defname>h_L</defname>
        </param>
        <param>
          <type>h_R</type>
          <defname>h_R</defname>
        </param>
        <param>
          <type>BT_cont</type>
          <defname>BT_cont</defname>
        </param>
        <param>
          <type>uh_tot_0</type>
          <defname>uh_tot_0</defname>
        </param>
        <param>
          <type>duhdu_tot_0</type>
          <defname>duhdu_tot_0</defname>
        </param>
        <param>
          <type>du_max_CFL</type>
          <defname>du_max_CFL</defname>
        </param>
        <param>
          <type>du_min_CFL</type>
          <defname>du_min_CFL</defname>
        </param>
        <param>
          <type>dt</type>
          <defname>dt</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>visc_rem</type>
          <defname>visc_rem</defname>
        </param>
        <param>
          <type>visc_rem_max</type>
          <defname>visc_rem_max</defname>
        </param>
        <param>
          <type>j</type>
          <defname>j</defname>
        </param>
        <param>
          <type>ish</type>
          <defname>ish</defname>
        </param>
        <param>
          <type>ieh</type>
          <defname>ieh</defname>
        </param>
        <param>
          <type>do_I</type>
          <defname>do_I</defname>
        </param>
        <briefdescription>
<para>Sets a structure that describes the zonal barotropic volume or mass fluxes as a function of barotropic flow to agree closely with the sum of the layer&apos;s transports. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean&apos;s grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">u</parametername>
</parameternamelist>
<parameterdescription>
<para>Zonal velocity [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_in</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thickness used to calculate fluxes [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_l</parametername>
</parameternamelist>
<parameterdescription>
<para>Left thickness in the reconstruction [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_r</parametername>
</parameternamelist>
<parameterdescription>
<para>Right thickness in the reconstruction [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">bt_cont</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure with elements that describe the effective open face areas as a function of barotropic flow. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">uh_tot_0</parametername>
</parameternamelist>
<parameterdescription>
<para>The summed transport with 0 adjustment [H L2 T-1 ~&gt; m3 s-1 or kg s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">duhdu_tot_0</parametername>
</parameternamelist>
<parameterdescription>
<para>The partial derivative of du_err with du at 0 adjustment [H L ~&gt; m2 or kg m-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">du_max_cfl</parametername>
</parameternamelist>
<parameterdescription>
<para>Maximum acceptable value of du [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">du_min_cfl</parametername>
</parameternamelist>
<parameterdescription>
<para>Minimum acceptable value of du [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dt</parametername>
</parameternamelist>
<parameterdescription>
<para>Time increment [T ~&gt; s]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">us</parametername>
</parameternamelist>
<parameterdescription>
<para>A dimensional unit scaling type </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>This module&apos;s control structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">visc_rem</parametername>
</parameternamelist>
<parameterdescription>
<para>Both the fraction of the momentum originally in a layer that remains after a time-step of viscosity, and the fraction of a time-step&apos;s worth of a barotropic acceleration that a layer experiences after viscosity is applied. Non-dimensional between 0 (at the bottom) and 1 (far above the bottom). </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">visc_rem_max</parametername>
</parameternamelist>
<parameterdescription>
<para>Maximum allowable visc_rem. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">j</parametername>
</parameternamelist>
<parameterdescription>
<para>Spatial index. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ish</parametername>
</parameternamelist>
<parameterdescription>
<para>Start of index range. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ieh</parametername>
</parameternamelist>
<parameterdescription>
<para>End of index range. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">do_i</parametername>
</parameternamelist>
<parameterdescription>
<para>A logical flag indicating which I values to work on. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="874" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="877" bodyend="1033"/>
        <references refid="namespacemom__continuity__ppm_1afad3f82b9824a13d3fe8792496e9b769" compoundref="MOM__continuity__PPM_8F90" startline="713" endline="869">zonal_flux_adjust</references>
        <references refid="namespacemom__continuity__ppm_1a713196d0cfe6cb4cc8a91239a8dba02d" compoundref="MOM__continuity__PPM_8F90" startline="523" endline="599">zonal_flux_layer</references>
        <referencedby refid="namespacemom__continuity__ppm_1a5f5d6764ed315043d3b91b209db5c0a0" compoundref="MOM__continuity__PPM_8F90" startline="213" endline="517">zonal_mass_flux</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__continuity__ppm_1ae64c4b7cd1756aa3c121fbcf637d5cae" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_continuity_ppm::meridional_mass_flux</definition>
        <argsstring>(v, h_in, vh, dt, G, GV, US, CS, LB, vhbt, OBC, visc_rem_v, v_cor, BT_cont)</argsstring>
        <name>meridional_mass_flux</name>
        <param>
          <type>v</type>
          <defname>v</defname>
        </param>
        <param>
          <type>h_in</type>
          <defname>h_in</defname>
        </param>
        <param>
          <type>vh</type>
          <defname>vh</defname>
        </param>
        <param>
          <type>dt</type>
          <defname>dt</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>LB</type>
          <defname>LB</defname>
        </param>
        <param>
          <type>vhbt</type>
          <defname>vhbt</defname>
        </param>
        <param>
          <type>OBC</type>
          <defname>OBC</defname>
        </param>
        <param>
          <type>visc_rem_v</type>
          <defname>visc_rem_v</defname>
        </param>
        <param>
          <type>v_cor</type>
          <defname>v_cor</defname>
        </param>
        <param>
          <type>BT_cont</type>
          <defname>BT_cont</defname>
        </param>
        <briefdescription>
<para>Calculates the mass or volume fluxes through the meridional faces, and other related quantities. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean&apos;s grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean&apos;s vertical grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">v</parametername>
</parameternamelist>
<parameterdescription>
<para>Meridional velocity [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_in</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thickness used to calculate fluxes [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">vh</parametername>
</parameternamelist>
<parameterdescription>
<para>Volume flux through meridional faces = v*h*dx [H m2 s-1 ~&gt; m3 s-1 or kg s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dt</parametername>
</parameternamelist>
<parameterdescription>
<para>Time increment [T ~&gt; s]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">us</parametername>
</parameternamelist>
<parameterdescription>
<para>A dimensional unit scaling type </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>This module&apos;s control structure.G </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">lb</parametername>
</parameternamelist>
<parameterdescription>
<para>Loop bounds structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>obc</parametername>
</parameternamelist>
<parameterdescription>
<para>Open boundary condition type specifies whether, where, and what open boundary conditions are used. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">visc_rem_v</parametername>
</parameternamelist>
<parameterdescription>
<para>Both the fraction of the momentum </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">vhbt</parametername>
</parameternamelist>
<parameterdescription>
<para>The summed volume flux through meridional faces [H L2 T-1 ~&gt; m3 s-1 or kg s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">v_cor</parametername>
</parameternamelist>
<parameterdescription>
<para>The meridional velocitiess (v with a barotropic correction) that give vhbt as the depth-integrated transport [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>bt_cont</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure with elements that describe the effective open face areas as a function of barotropic flow. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="1037" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="1039" bodyend="1336"/>
        <references refid="namespacemom__continuity__ppm_1a4b409d0d89dbdbbea05f4a3ade088902" compoundref="MOM__continuity__PPM_8F90" startline="24">id_clock_correct</references>
        <references refid="namespacemom__continuity__ppm_1a6002197c46343ec4d08cab937db87586" compoundref="MOM__continuity__PPM_8F90" startline="24" endline="24">id_clock_update</references>
        <references refid="namespacemom__continuity__ppm_1a293f7ab5bfd8f3f6a5a50903b05b6411" compoundref="MOM__continuity__PPM_8F90" startline="1428" endline="1530">merid_face_thickness</references>
        <references refid="namespacemom__continuity__ppm_1ac00aefda40cb9e22013e99cad342bb63" compoundref="MOM__continuity__PPM_8F90" startline="1342" endline="1422">merid_flux_layer</references>
        <references refid="namespacemom__continuity__ppm_1a6deb1b7de418a17cacd60dabc262ba29" compoundref="MOM__continuity__PPM_8F90" startline="1537" endline="1692">meridional_flux_adjust</references>
        <references refid="namespacemom__open__boundary_1a6ace8760d7fa465a59d8cbc3340a5b5e" compoundref="MOM__open__boundary_8F90" startline="73" endline="73">mom_open_boundary::obc_direction_n</references>
        <references refid="namespacemom__continuity__ppm_1af71fa5f7f4b849ec735e2049df2d0693" compoundref="MOM__continuity__PPM_8F90" startline="1998" endline="2130">ppm_reconstruction_y</references>
        <references refid="namespacemom__continuity__ppm_1adf02002cf5951d7610b8643d2d401585" compoundref="MOM__continuity__PPM_8F90" startline="2216" endline="2225">ratio_max</references>
        <references refid="namespacemom__continuity__ppm_1a77c6806e82a3634fff7b7480f77c2f02" compoundref="MOM__continuity__PPM_8F90" startline="1700" endline="1854">set_merid_bt_cont</references>
        <referencedby refid="namespacemom__continuity__ppm_1a665851a49a4bde77b4ef5e25332947f6" compoundref="MOM__continuity__PPM_8F90" startline="78" endline="207">continuity_ppm</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__continuity__ppm_1ac00aefda40cb9e22013e99cad342bb63" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_continuity_ppm::merid_flux_layer</definition>
        <argsstring>(v, h, h_L, h_R, vh, dvhdv, visc_rem, dt, G, US, J, ish, ieh, do_I, vol_CFL, OBC)</argsstring>
        <name>merid_flux_layer</name>
        <param>
          <type>v</type>
          <defname>v</defname>
        </param>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>h_L</type>
          <defname>h_L</defname>
        </param>
        <param>
          <type>h_R</type>
          <defname>h_R</defname>
        </param>
        <param>
          <type>vh</type>
          <defname>vh</defname>
        </param>
        <param>
          <type>dvhdv</type>
          <defname>dvhdv</defname>
        </param>
        <param>
          <type>visc_rem</type>
          <defname>visc_rem</defname>
        </param>
        <param>
          <type>dt</type>
          <defname>dt</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>J</type>
          <defname>J</defname>
        </param>
        <param>
          <type>ish</type>
          <defname>ish</defname>
        </param>
        <param>
          <type>ieh</type>
          <defname>ieh</defname>
        </param>
        <param>
          <type>do_I</type>
          <defname>do_I</defname>
        </param>
        <param>
          <type>vol_CFL</type>
          <defname>vol_CFL</defname>
        </param>
        <param>
          <type>OBC</type>
          <defname>OBC</defname>
        </param>
        <briefdescription>
<para>Evaluates the meridional mass or volume fluxes in a layer. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean&apos;s grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">v</parametername>
</parameternamelist>
<parameterdescription>
<para>Meridional velocity [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">visc_rem</parametername>
</parameternamelist>
<parameterdescription>
<para>Both the fraction of the momentum originally in a layer that remains after a time-step of viscosity, and the fraction of a time-step&apos;s worth of a barotropic acceleration that a layer experiences after viscosity is applied. Non-dimensional between 0 (at the bottom) and 1 (far above the bottom). </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thickness used to calculate fluxes, [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_l</parametername>
</parameternamelist>
<parameterdescription>
<para>Left thickness in the reconstruction [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_r</parametername>
</parameternamelist>
<parameterdescription>
<para>Right thickness in the reconstruction [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">vh</parametername>
</parameternamelist>
<parameterdescription>
<para>Meridional mass or volume transport [H L2 T-1 ~&gt; m3 s-1 or kg s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">dvhdv</parametername>
</parameternamelist>
<parameterdescription>
<para>Partial derivative of vh with v [H L ~&gt; m2 or kg m-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dt</parametername>
</parameternamelist>
<parameterdescription>
<para>Time increment [T ~&gt; s]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">us</parametername>
</parameternamelist>
<parameterdescription>
<para>A dimensional unit scaling type </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">j</parametername>
</parameternamelist>
<parameterdescription>
<para>Spatial index. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ish</parametername>
</parameternamelist>
<parameterdescription>
<para>Start of index range. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ieh</parametername>
</parameternamelist>
<parameterdescription>
<para>End of index range. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">do_i</parametername>
</parameternamelist>
<parameterdescription>
<para>Which i values to work on. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">vol_cfl</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, rescale the ratio of face areas to the cell areas when estimating the CFL number. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>obc</parametername>
</parameternamelist>
<parameterdescription>
<para>Open boundaries control structure. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="1340" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="1342" bodyend="1422"/>
        <references refid="namespacemom__open__boundary_1a6ace8760d7fa465a59d8cbc3340a5b5e" compoundref="MOM__open__boundary_8F90" startline="73" endline="73">mom_open_boundary::obc_direction_n</references>
        <referencedby refid="namespacemom__continuity__ppm_1a6deb1b7de418a17cacd60dabc262ba29" compoundref="MOM__continuity__PPM_8F90" startline="1537" endline="1692">meridional_flux_adjust</referencedby>
        <referencedby refid="namespacemom__continuity__ppm_1ae64c4b7cd1756aa3c121fbcf637d5cae" compoundref="MOM__continuity__PPM_8F90" startline="1039" endline="1336">meridional_mass_flux</referencedby>
        <referencedby refid="namespacemom__continuity__ppm_1a77c6806e82a3634fff7b7480f77c2f02" compoundref="MOM__continuity__PPM_8F90" startline="1700" endline="1854">set_merid_bt_cont</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__continuity__ppm_1a293f7ab5bfd8f3f6a5a50903b05b6411" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_continuity_ppm::merid_face_thickness</definition>
        <argsstring>(v, h, h_L, h_R, h_v, dt, G, US, LB, vol_CFL, marginal, visc_rem_v, OBC)</argsstring>
        <name>merid_face_thickness</name>
        <param>
          <type>v</type>
          <defname>v</defname>
        </param>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>h_L</type>
          <defname>h_L</defname>
        </param>
        <param>
          <type>h_R</type>
          <defname>h_R</defname>
        </param>
        <param>
          <type>h_v</type>
          <defname>h_v</defname>
        </param>
        <param>
          <type>dt</type>
          <defname>dt</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>LB</type>
          <defname>LB</defname>
        </param>
        <param>
          <type>vol_CFL</type>
          <defname>vol_CFL</defname>
        </param>
        <param>
          <type>marginal</type>
          <defname>marginal</defname>
        </param>
        <param>
          <type>visc_rem_v</type>
          <defname>visc_rem_v</defname>
        </param>
        <param>
          <type>OBC</type>
          <defname>OBC</defname>
        </param>
        <briefdescription>
<para>Sets the effective interface thickness at each meridional velocity point. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean&apos;s grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">v</parametername>
</parameternamelist>
<parameterdescription>
<para>Meridional velocity [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thickness used to calculate fluxes, [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_l</parametername>
</parameternamelist>
<parameterdescription>
<para>Left thickness in the reconstruction, [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_r</parametername>
</parameternamelist>
<parameterdescription>
<para>Right thickness in the reconstruction, [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">h_v</parametername>
</parameternamelist>
<parameterdescription>
<para>Thickness at meridional faces, [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dt</parametername>
</parameternamelist>
<parameterdescription>
<para>Time increment [T ~&gt; s]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">lb</parametername>
</parameternamelist>
<parameterdescription>
<para>Loop bounds structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">us</parametername>
</parameternamelist>
<parameterdescription>
<para>A dimensional unit scaling type </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">vol_cfl</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, rescale the ratio of face areas to the cell areas when estimating the CFL number. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">marginal</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, report the marginal face thicknesses; otherwise report transport-averaged thicknesses. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">visc_rem_v</parametername>
</parameternamelist>
<parameterdescription>
<para>Both the fraction of the momentum originally in a layer that remains after a time-step of viscosity, and the fraction of a time-step&apos;s worth of a barotropic acceleration that a layer experiences after viscosity is applied. Non-dimensional between 0 (at the bottom) and 1 (far above the bottom). </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>obc</parametername>
</parameternamelist>
<parameterdescription>
<para>Open boundaries control structure. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="1426" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="1428" bodyend="1530"/>
        <references refid="namespacemom__open__boundary_1a6ace8760d7fa465a59d8cbc3340a5b5e" compoundref="MOM__open__boundary_8F90" startline="73" endline="73">mom_open_boundary::obc_direction_n</references>
        <referencedby refid="namespacemom__continuity__ppm_1ae64c4b7cd1756aa3c121fbcf637d5cae" compoundref="MOM__continuity__PPM_8F90" startline="1039" endline="1336">meridional_mass_flux</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__continuity__ppm_1a6deb1b7de418a17cacd60dabc262ba29" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_continuity_ppm::meridional_flux_adjust</definition>
        <argsstring>(v, h_in, h_L, h_R, vhbt, vh_tot_0, dvhdv_tot_0, dv, dv_max_CFL, dv_min_CFL, dt, G, US, CS, visc_rem, j, ish, ieh, do_I_in, full_precision, vh_3d, OBC)</argsstring>
        <name>meridional_flux_adjust</name>
        <param>
          <type>v</type>
          <defname>v</defname>
        </param>
        <param>
          <type>h_in</type>
          <defname>h_in</defname>
        </param>
        <param>
          <type>h_L</type>
          <defname>h_L</defname>
        </param>
        <param>
          <type>h_R</type>
          <defname>h_R</defname>
        </param>
        <param>
          <type>vhbt</type>
          <defname>vhbt</defname>
        </param>
        <param>
          <type>vh_tot_0</type>
          <defname>vh_tot_0</defname>
        </param>
        <param>
          <type>dvhdv_tot_0</type>
          <defname>dvhdv_tot_0</defname>
        </param>
        <param>
          <type>dv</type>
          <defname>dv</defname>
        </param>
        <param>
          <type>dv_max_CFL</type>
          <defname>dv_max_CFL</defname>
        </param>
        <param>
          <type>dv_min_CFL</type>
          <defname>dv_min_CFL</defname>
        </param>
        <param>
          <type>dt</type>
          <defname>dt</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>visc_rem</type>
          <defname>visc_rem</defname>
        </param>
        <param>
          <type>j</type>
          <defname>j</defname>
        </param>
        <param>
          <type>ish</type>
          <defname>ish</defname>
        </param>
        <param>
          <type>ieh</type>
          <defname>ieh</defname>
        </param>
        <param>
          <type>do_I_in</type>
          <defname>do_I_in</defname>
        </param>
        <param>
          <type>full_precision</type>
          <defname>full_precision</defname>
        </param>
        <param>
          <type>vh_3d</type>
          <defname>vh_3d</defname>
        </param>
        <param>
          <type>OBC</type>
          <defname>OBC</defname>
        </param>
        <briefdescription>
<para>Returns the barotropic velocity adjustment that gives the desired barotropic (layer-summed) transport. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean&apos;s grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">v</parametername>
</parameternamelist>
<parameterdescription>
<para>Meridional velocity [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_in</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thickness used to calculate fluxes [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_l</parametername>
</parameternamelist>
<parameterdescription>
<para>Left thickness in the reconstruction [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_r</parametername>
</parameternamelist>
<parameterdescription>
<para>Right thickness in the reconstruction [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">visc_rem</parametername>
</parameternamelist>
<parameterdescription>
<para>Both the fraction of the momentum originally in a layer that remains after a time-step of viscosity, and the fraction of a time-step&apos;s worth of a barotropic acceleration that a layer experiences after viscosity is applied. Non-dimensional between 0 (at the bottom) and 1 (far above the bottom). </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">vhbt</parametername>
</parameternamelist>
<parameterdescription>
<para>The summed volume flux through meridional faces </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dv_max_cfl</parametername>
</parameternamelist>
<parameterdescription>
<para>Maximum acceptable value of dv [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dv_min_cfl</parametername>
</parameternamelist>
<parameterdescription>
<para>Minimum acceptable value of dv [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">vh_tot_0</parametername>
</parameternamelist>
<parameterdescription>
<para>The summed transport with 0 adjustment [H L2 T-1 ~&gt; m3 s-1 or kg s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dvhdv_tot_0</parametername>
</parameternamelist>
<parameterdescription>
<para>The partial derivative of dv_err with dv at 0 adjustment [H L ~&gt; m2 or kg m-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">dv</parametername>
</parameternamelist>
<parameterdescription>
<para>The barotropic velocity adjustment [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dt</parametername>
</parameternamelist>
<parameterdescription>
<para>Time increment [T ~&gt; s]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">us</parametername>
</parameternamelist>
<parameterdescription>
<para>A dimensional unit scaling type </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>This module&apos;s control structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">j</parametername>
</parameternamelist>
<parameterdescription>
<para>Spatial index. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ish</parametername>
</parameternamelist>
<parameterdescription>
<para>Start of index range. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ieh</parametername>
</parameternamelist>
<parameterdescription>
<para>End of index range. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">do_i_in</parametername>
</parameternamelist>
<parameterdescription>
<para>A flag indicating which I values to work on. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">full_precision</parametername>
</parameternamelist>
<parameterdescription>
<para>A flag indicating how carefully to iterate. The default is .true. (more accurate). </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">vh_3d</parametername>
</parameternamelist>
<parameterdescription>
<para>Volume flux through meridional </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>obc</parametername>
</parameternamelist>
<parameterdescription>
<para>Open boundaries control structure. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="1534" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="1537" bodyend="1692"/>
        <references refid="namespacemom__continuity__ppm_1ac00aefda40cb9e22013e99cad342bb63" compoundref="MOM__continuity__PPM_8F90" startline="1342" endline="1422">merid_flux_layer</references>
        <referencedby refid="namespacemom__continuity__ppm_1ae64c4b7cd1756aa3c121fbcf637d5cae" compoundref="MOM__continuity__PPM_8F90" startline="1039" endline="1336">meridional_mass_flux</referencedby>
        <referencedby refid="namespacemom__continuity__ppm_1a77c6806e82a3634fff7b7480f77c2f02" compoundref="MOM__continuity__PPM_8F90" startline="1700" endline="1854">set_merid_bt_cont</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__continuity__ppm_1a77c6806e82a3634fff7b7480f77c2f02" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_continuity_ppm::set_merid_bt_cont</definition>
        <argsstring>(v, h_in, h_L, h_R, BT_cont, vh_tot_0, dvhdv_tot_0, dv_max_CFL, dv_min_CFL, dt, G, US, CS, visc_rem, visc_rem_max, j, ish, ieh, do_I)</argsstring>
        <name>set_merid_bt_cont</name>
        <param>
          <type>v</type>
          <defname>v</defname>
        </param>
        <param>
          <type>h_in</type>
          <defname>h_in</defname>
        </param>
        <param>
          <type>h_L</type>
          <defname>h_L</defname>
        </param>
        <param>
          <type>h_R</type>
          <defname>h_R</defname>
        </param>
        <param>
          <type>BT_cont</type>
          <defname>BT_cont</defname>
        </param>
        <param>
          <type>vh_tot_0</type>
          <defname>vh_tot_0</defname>
        </param>
        <param>
          <type>dvhdv_tot_0</type>
          <defname>dvhdv_tot_0</defname>
        </param>
        <param>
          <type>dv_max_CFL</type>
          <defname>dv_max_CFL</defname>
        </param>
        <param>
          <type>dv_min_CFL</type>
          <defname>dv_min_CFL</defname>
        </param>
        <param>
          <type>dt</type>
          <defname>dt</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>visc_rem</type>
          <defname>visc_rem</defname>
        </param>
        <param>
          <type>visc_rem_max</type>
          <defname>visc_rem_max</defname>
        </param>
        <param>
          <type>j</type>
          <defname>j</defname>
        </param>
        <param>
          <type>ish</type>
          <defname>ish</defname>
        </param>
        <param>
          <type>ieh</type>
          <defname>ieh</defname>
        </param>
        <param>
          <type>do_I</type>
          <defname>do_I</defname>
        </param>
        <briefdescription>
<para>Sets of a structure that describes the meridional barotropic volume or mass fluxes as a function of barotropic flow to agree closely with the sum of the layer&apos;s transports. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean&apos;s grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">v</parametername>
</parameternamelist>
<parameterdescription>
<para>Meridional velocity [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_in</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thickness used to calculate fluxes, [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_l</parametername>
</parameternamelist>
<parameterdescription>
<para>Left thickness in the reconstruction, [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_r</parametername>
</parameternamelist>
<parameterdescription>
<para>Right thickness in the reconstruction, [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">bt_cont</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure with elements that describe the effective open face areas as a function of barotropic flow. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">vh_tot_0</parametername>
</parameternamelist>
<parameterdescription>
<para>The summed transport with 0 adjustment [H L2 T-1 ~&gt; m3 s-1 or kg s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dvhdv_tot_0</parametername>
</parameternamelist>
<parameterdescription>
<para>The partial derivative of du_err with dv at 0 adjustment [H L ~&gt; m2 or kg m-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dv_max_cfl</parametername>
</parameternamelist>
<parameterdescription>
<para>Maximum acceptable value of dv [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dv_min_cfl</parametername>
</parameternamelist>
<parameterdescription>
<para>Minimum acceptable value of dv [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dt</parametername>
</parameternamelist>
<parameterdescription>
<para>Time increment [T ~&gt; s]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">us</parametername>
</parameternamelist>
<parameterdescription>
<para>A dimensional unit scaling type </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>This module&apos;s control structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">visc_rem</parametername>
</parameternamelist>
<parameterdescription>
<para>Both the fraction of the momentum originally in a layer that remains after a time-step of viscosity, and the fraction of a time-step&apos;s worth of a barotropic acceleration that a layer experiences after viscosity is applied. Non-dimensional between 0 (at the bottom) and 1 (far above the bottom). </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">visc_rem_max</parametername>
</parameternamelist>
<parameterdescription>
<para>Maximum allowable visc_rem. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">j</parametername>
</parameternamelist>
<parameterdescription>
<para>Spatial index. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ish</parametername>
</parameternamelist>
<parameterdescription>
<para>Start of index range. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ieh</parametername>
</parameternamelist>
<parameterdescription>
<para>End of index range. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">do_i</parametername>
</parameternamelist>
<parameterdescription>
<para>A logical flag indicating which I values to work on. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="1697" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="1700" bodyend="1854"/>
        <references refid="namespacemom__continuity__ppm_1ac00aefda40cb9e22013e99cad342bb63" compoundref="MOM__continuity__PPM_8F90" startline="1342" endline="1422">merid_flux_layer</references>
        <references refid="namespacemom__continuity__ppm_1a6deb1b7de418a17cacd60dabc262ba29" compoundref="MOM__continuity__PPM_8F90" startline="1537" endline="1692">meridional_flux_adjust</references>
        <referencedby refid="namespacemom__continuity__ppm_1ae64c4b7cd1756aa3c121fbcf637d5cae" compoundref="MOM__continuity__PPM_8F90" startline="1039" endline="1336">meridional_mass_flux</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__continuity__ppm_1a9a7eac2a9b17d0e9ee9ca0a27d2f8fb6" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_continuity_ppm::ppm_reconstruction_x</definition>
        <argsstring>(h_in, h_L, h_R, G, LB, h_min, monotonic, simple_2nd, OBC)</argsstring>
        <name>ppm_reconstruction_x</name>
        <param>
          <type>h_in</type>
          <defname>h_in</defname>
        </param>
        <param>
          <type>h_L</type>
          <defname>h_L</defname>
        </param>
        <param>
          <type>h_R</type>
          <defname>h_R</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>LB</type>
          <defname>LB</defname>
        </param>
        <param>
          <type>h_min</type>
          <defname>h_min</defname>
        </param>
        <param>
          <type>monotonic</type>
          <defname>monotonic</defname>
        </param>
        <param>
          <type>simple_2nd</type>
          <defname>simple_2nd</defname>
        </param>
        <param>
          <type>OBC</type>
          <defname>OBC</defname>
        </param>
        <briefdescription>
<para>Calculates left/right edge values for PPM reconstruction. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean&apos;s grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_in</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thickness [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">h_l</parametername>
</parameternamelist>
<parameterdescription>
<para>Left thickness in the reconstruction, [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">h_r</parametername>
</parameternamelist>
<parameterdescription>
<para>Right thickness in the reconstruction, [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">lb</parametername>
</parameternamelist>
<parameterdescription>
<para>Active loop bounds structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_min</parametername>
</parameternamelist>
<parameterdescription>
<para>The minimum thickness that can be obtained by a concave parabolic fit. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">monotonic</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, use the Colella &amp; Woodward monotonic limiter. Otherwise use a simple positive-definite limiter. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">simple_2nd</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, use the arithmetic mean thicknesses as the default edge values for a simple 2nd order scheme. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>obc</parametername>
</parameternamelist>
<parameterdescription>
<para>Open boundaries control structure. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="1858" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="1859" bodyend="1993"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <references refid="namespacemom__open__boundary_1a876256dbb0556d7e04cdf091f1744b65" compoundref="MOM__open__boundary_8F90" startline="75" endline="75">mom_open_boundary::obc_direction_e</references>
        <references refid="namespacemom__open__boundary_1a015e27a65957919ea3cd67767b8f26f7" compoundref="MOM__open__boundary_8F90" startline="76" endline="76">mom_open_boundary::obc_direction_w</references>
        <references refid="namespacemom__continuity__ppm_1ab03786fff2550dd61282356608fc1352" compoundref="MOM__continuity__PPM_8F90" startline="2179" endline="2211">ppm_limit_cw84</references>
        <references refid="namespacemom__continuity__ppm_1a870edb0c5b2cb0464899430b6651260c" compoundref="MOM__continuity__PPM_8F90" startline="2138" endline="2173">ppm_limit_pos</references>
        <referencedby refid="namespacemom__continuity__ppm_1a5f5d6764ed315043d3b91b209db5c0a0" compoundref="MOM__continuity__PPM_8F90" startline="213" endline="517">zonal_mass_flux</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__continuity__ppm_1af71fa5f7f4b849ec735e2049df2d0693" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_continuity_ppm::ppm_reconstruction_y</definition>
        <argsstring>(h_in, h_L, h_R, G, LB, h_min, monotonic, simple_2nd, OBC)</argsstring>
        <name>ppm_reconstruction_y</name>
        <param>
          <type>h_in</type>
          <defname>h_in</defname>
        </param>
        <param>
          <type>h_L</type>
          <defname>h_L</defname>
        </param>
        <param>
          <type>h_R</type>
          <defname>h_R</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>LB</type>
          <defname>LB</defname>
        </param>
        <param>
          <type>h_min</type>
          <defname>h_min</defname>
        </param>
        <param>
          <type>monotonic</type>
          <defname>monotonic</defname>
        </param>
        <param>
          <type>simple_2nd</type>
          <defname>simple_2nd</defname>
        </param>
        <param>
          <type>OBC</type>
          <defname>OBC</defname>
        </param>
        <briefdescription>
<para>Calculates left/right edge values for PPM reconstruction. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean&apos;s grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_in</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thickness [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">h_l</parametername>
</parameternamelist>
<parameterdescription>
<para>Left thickness in the reconstruction, [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">h_r</parametername>
</parameternamelist>
<parameterdescription>
<para>Right thickness in the reconstruction, [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">lb</parametername>
</parameternamelist>
<parameterdescription>
<para>Active loop bounds structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_min</parametername>
</parameternamelist>
<parameterdescription>
<para>The minimum thickness that can be obtained by a concave parabolic fit. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">monotonic</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, use the Colella &amp; Woodward monotonic limiter. Otherwise use a simple positive-definite limiter. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">simple_2nd</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, use the arithmetic mean thicknesses as the default edge values for a simple 2nd order scheme. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>obc</parametername>
</parameternamelist>
<parameterdescription>
<para>Open boundaries control structure. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="1997" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="1998" bodyend="2130"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <references refid="namespacemom__open__boundary_1a6ace8760d7fa465a59d8cbc3340a5b5e" compoundref="MOM__open__boundary_8F90" startline="73" endline="73">mom_open_boundary::obc_direction_n</references>
        <references refid="namespacemom__open__boundary_1a29aee121a765fc751bd1c21adf80af10" compoundref="MOM__open__boundary_8F90" startline="74" endline="74">mom_open_boundary::obc_direction_s</references>
        <references refid="namespacemom__continuity__ppm_1ab03786fff2550dd61282356608fc1352" compoundref="MOM__continuity__PPM_8F90" startline="2179" endline="2211">ppm_limit_cw84</references>
        <references refid="namespacemom__continuity__ppm_1a870edb0c5b2cb0464899430b6651260c" compoundref="MOM__continuity__PPM_8F90" startline="2138" endline="2173">ppm_limit_pos</references>
        <referencedby refid="namespacemom__continuity__ppm_1ae64c4b7cd1756aa3c121fbcf637d5cae" compoundref="MOM__continuity__PPM_8F90" startline="1039" endline="1336">meridional_mass_flux</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__continuity__ppm_1a870edb0c5b2cb0464899430b6651260c" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_continuity_ppm::ppm_limit_pos</definition>
        <argsstring>(h_in, h_L, h_R, h_min, G, iis, iie, jis, jie)</argsstring>
        <name>ppm_limit_pos</name>
        <param>
          <type>h_in</type>
          <defname>h_in</defname>
        </param>
        <param>
          <type>h_L</type>
          <defname>h_L</defname>
        </param>
        <param>
          <type>h_R</type>
          <defname>h_R</defname>
        </param>
        <param>
          <type>h_min</type>
          <defname>h_min</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>iis</type>
          <defname>iis</defname>
        </param>
        <param>
          <type>iie</type>
          <defname>iie</defname>
        </param>
        <param>
          <type>jis</type>
          <defname>jis</defname>
        </param>
        <param>
          <type>jie</type>
          <defname>jie</defname>
        </param>
        <briefdescription>
<para>This subroutine limits the left/right edge values of the PPM reconstruction to give a reconstruction that is positive-definite. Here this is reinterpreted as giving a constant thickness if the mean thickness is less than h_min, with a minimum of h_min otherwise. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean&apos;s grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_in</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thickness [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">h_l</parametername>
</parameternamelist>
<parameterdescription>
<para>Left thickness in the reconstruction [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">h_r</parametername>
</parameternamelist>
<parameterdescription>
<para>Right thickness in the reconstruction [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_min</parametername>
</parameternamelist>
<parameterdescription>
<para>The minimum thickness that can be obtained by a concave parabolic fit. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">iis</parametername>
</parameternamelist>
<parameterdescription>
<para>Start of i index range. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">iie</parametername>
</parameternamelist>
<parameterdescription>
<para>End of i index range. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">jis</parametername>
</parameternamelist>
<parameterdescription>
<para>Start of j index range. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">jie</parametername>
</parameternamelist>
<parameterdescription>
<para>End of j index range. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="2137" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="2138" bodyend="2173"/>
        <referencedby refid="namespacemom__continuity__ppm_1a9a7eac2a9b17d0e9ee9ca0a27d2f8fb6" compoundref="MOM__continuity__PPM_8F90" startline="1859" endline="1993">ppm_reconstruction_x</referencedby>
        <referencedby refid="namespacemom__continuity__ppm_1af71fa5f7f4b849ec735e2049df2d0693" compoundref="MOM__continuity__PPM_8F90" startline="1998" endline="2130">ppm_reconstruction_y</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__continuity__ppm_1ab03786fff2550dd61282356608fc1352" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_continuity_ppm::ppm_limit_cw84</definition>
        <argsstring>(h_in, h_L, h_R, G, iis, iie, jis, jie)</argsstring>
        <name>ppm_limit_cw84</name>
        <param>
          <type>h_in</type>
          <defname>h_in</defname>
        </param>
        <param>
          <type>h_L</type>
          <defname>h_L</defname>
        </param>
        <param>
          <type>h_R</type>
          <defname>h_R</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>iis</type>
          <defname>iis</defname>
        </param>
        <param>
          <type>iie</type>
          <defname>iie</defname>
        </param>
        <param>
          <type>jis</type>
          <defname>jis</defname>
        </param>
        <param>
          <type>jie</type>
          <defname>jie</defname>
        </param>
        <briefdescription>
<para>This subroutine limits the left/right edge values of the PPM reconstruction according to the monotonic prescription of Colella and Woodward, 1984. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean&apos;s grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_in</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thickness [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">h_l</parametername>
</parameternamelist>
<parameterdescription>
<para>Left thickness in the reconstruction, [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">h_r</parametername>
</parameternamelist>
<parameterdescription>
<para>Right thickness in the reconstruction, [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">iis</parametername>
</parameternamelist>
<parameterdescription>
<para>Start of i index range. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">iie</parametername>
</parameternamelist>
<parameterdescription>
<para>End of i index range. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">jis</parametername>
</parameternamelist>
<parameterdescription>
<para>Start of j index range. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">jie</parametername>
</parameternamelist>
<parameterdescription>
<para>End of j index range. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="2178" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="2179" bodyend="2211"/>
        <referencedby refid="namespacemom__continuity__ppm_1a9a7eac2a9b17d0e9ee9ca0a27d2f8fb6" compoundref="MOM__continuity__PPM_8F90" startline="1859" endline="1993">ppm_reconstruction_x</referencedby>
        <referencedby refid="namespacemom__continuity__ppm_1af71fa5f7f4b849ec735e2049df2d0693" compoundref="MOM__continuity__PPM_8F90" startline="1998" endline="2130">ppm_reconstruction_y</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__continuity__ppm_1adf02002cf5951d7610b8643d2d401585" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>real function</type>
        <definition>real function mom_continuity_ppm::ratio_max</definition>
        <argsstring>(a, b, maxrat)</argsstring>
        <name>ratio_max</name>
        <param>
          <type>a</type>
          <defname>a</defname>
        </param>
        <param>
          <type>b</type>
          <defname>b</defname>
        </param>
        <param>
          <type>maxrat</type>
          <defname>maxrat</defname>
        </param>
        <briefdescription>
<para>Return the maximum ratio of a/b or maxrat. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">a</parametername>
</parameternamelist>
<parameterdescription>
<para>Numerator </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">b</parametername>
</parameternamelist>
<parameterdescription>
<para>Denominator </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">maxrat</parametername>
</parameternamelist>
<parameterdescription>
<para>Maximum value of ratio. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>Return value. </para>
</simplesect>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="2215" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="2216" bodyend="2225"/>
        <referencedby refid="namespacemom__continuity__ppm_1ae64c4b7cd1756aa3c121fbcf637d5cae" compoundref="MOM__continuity__PPM_8F90" startline="1039" endline="1336">meridional_mass_flux</referencedby>
        <referencedby refid="namespacemom__continuity__ppm_1a5f5d6764ed315043d3b91b209db5c0a0" compoundref="MOM__continuity__PPM_8F90" startline="213" endline="517">zonal_mass_flux</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__continuity__ppm_1a832c506364bca555b36409a91e0f5906" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_continuity_ppm::continuity_ppm_init</definition>
        <argsstring>(Time, G, GV, US, param_file, diag, CS)</argsstring>
        <name>continuity_ppm_init</name>
        <param>
          <type>Time</type>
          <defname>Time</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>diag</type>
          <defname>diag</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>Initializes <ref refid="structmom__continuity__ppm_1_1continuity__ppm__cs" kindref="compound">continuity_ppm_cs</ref>. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">time</parametername>
</parameternamelist>
<parameterdescription>
<para>The current model time. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>The ocean&apos;s grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>Vertical grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">us</parametername>
</parameternamelist>
<parameterdescription>
<para>A dimensional unit scaling type </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure indicating the open file to parse for model parameter values. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">diag</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure that is used to regulate diagnostic output. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Module&apos;s control structure. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
<para>This include declares and sets the variable &quot;version&quot;.</para>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="2229" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="2230" bodyend="2321"/>
        <references refid="namespacemom__cpu__clock_1a7fda795074ed5ec5b00a26e7531c14f3" compoundref="MOM__cpu__clock_8F90" startline="23" endline="39">mom_cpu_clock::cpu_clock_id</references>
        <references refid="namespacemom__continuity__ppm_1a4b409d0d89dbdbbea05f4a3ade088902" compoundref="MOM__continuity__PPM_8F90" startline="24">id_clock_correct</references>
        <references refid="namespacemom__continuity__ppm_1a6002197c46343ec4d08cab937db87586" compoundref="MOM__continuity__PPM_8F90" startline="24" endline="24">id_clock_update</references>
        <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__continuity__ppm_1a3e3ee193ee52b65a1413808eea703aee" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>integer function, public</type>
        <definition>integer function, public mom_continuity_ppm::continuity_ppm_stencil</definition>
        <argsstring>(CS)</argsstring>
        <name>continuity_ppm_stencil</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>continuity_PPM_stencil returns the continuity solver stencil size </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Module&apos;s control structure. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>The continuity solver stencil size with the current settings. </para>
</simplesect>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="2325" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="2326" bodyend="2330"/>
      </memberdef>
      <memberdef kind="function" id="namespacemom__continuity__ppm_1a38ffbfd81e4bef4c789429fb843ed7cc" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_continuity_ppm::continuity_ppm_end</definition>
        <argsstring>(CS)</argsstring>
        <name>continuity_ppm_end</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>Destructor for <ref refid="structmom__continuity__ppm_1_1continuity__ppm__cs" kindref="compound">continuity_ppm_cs</ref>. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Module&apos;s control structure. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="2334" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="2335" bodyend="2336"/>
        <referencedby refid="namespacemom__continuity_1aa91ed69484f54d0bba361bfe60d89d60" compoundref="MOM__continuity_8F90" startline="170" endline="177">mom_continuity::continuity_end</referencedby>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Solve the layer continuity equation using the PPM method for layer fluxes. </para>
    </briefdescription>
    <detaileddescription>
<para>This module contains the subroutines that advect layer thickness. The scheme here uses a Piecewise-Parabolic method with a positive definite limiter. </para>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
