<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.14">
  <compounddef id="structmom__continuity__ppm_1_1continuity__ppm__cs" kind="type" language="Fortran" prot="public">
    <compoundname>mom_continuity_ppm::continuity_ppm_cs</compoundname>
      <sectiondef kind="public-attrib">
      <memberdef kind="variable" id="structmom__continuity__ppm_1_1continuity__ppm__cs_1a7066076535193230aba1561690b468b7" prot="public" static="no" mutable="no">
        <type>type(diag_ctrl), pointer</type>
        <definition>type(diag_ctrl), pointer mom_continuity_ppm::continuity_ppm_cs::diag</definition>
        <argsstring></argsstring>
        <name>diag</name>
        <briefdescription>
<para>Diagnostics control structure. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="29" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="29" bodyend="29"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__continuity__ppm_1_1continuity__ppm__cs_1a2136b96f5c65788435e50622fcc18af5" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical mom_continuity_ppm::continuity_ppm_cs::upwind_1st</definition>
        <argsstring></argsstring>
        <name>upwind_1st</name>
        <briefdescription>
<para>If true, use a first-order upwind scheme. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="30" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="30" bodyend="30"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__continuity__ppm_1_1continuity__ppm__cs_1a1e30df6d78505ecfefd3718729254786" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical mom_continuity_ppm::continuity_ppm_cs::monotonic</definition>
        <argsstring></argsstring>
        <name>monotonic</name>
        <briefdescription>
<para>If true, use the Colella &amp; Woodward monotonic limiter; otherwise use a simple positive definite limiter. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="31" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="31" bodyend="31"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__continuity__ppm_1_1continuity__ppm__cs_1a41a8553c57fa386a4106298c92ec5a74" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical mom_continuity_ppm::continuity_ppm_cs::simple_2nd</definition>
        <argsstring></argsstring>
        <name>simple_2nd</name>
        <briefdescription>
<para>If true, use a simple second order (arithmetic mean) interpolation of the edge values instead of the higher order interpolation. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="34" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="34" bodyend="34"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__continuity__ppm_1_1continuity__ppm__cs_1ab57754ec3775fa331a36ccddf520151b" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real mom_continuity_ppm::continuity_ppm_cs::tol_eta</definition>
        <argsstring></argsstring>
        <name>tol_eta</name>
        <briefdescription>
<para>The tolerance for free-surface height discrepancies between the barotropic solution and the sum of the layer thicknesses [H ~&gt; m or kg m-2]. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="37" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="37" bodyend="37"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__continuity__ppm_1_1continuity__ppm__cs_1a52e602d24b0b68a0606231287e8eaf1d" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real mom_continuity_ppm::continuity_ppm_cs::tol_vel</definition>
        <argsstring></argsstring>
        <name>tol_vel</name>
        <briefdescription>
<para>The tolerance for barotropic velocity discrepancies between the barotropic solution and the sum of the layer thicknesses [L T-1 ~&gt; m s-1]. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="40" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="40" bodyend="40"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__continuity__ppm_1_1continuity__ppm__cs_1ab76d38d53b0ae9c68c0e4be1db69e99b" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real mom_continuity_ppm::continuity_ppm_cs::tol_eta_aux</definition>
        <argsstring></argsstring>
        <name>tol_eta_aux</name>
        <briefdescription>
<para>The tolerance for free-surface height discrepancies between the barotropic solution and the sum of the layer thicknesses when calculating the auxiliary corrected velocities [H ~&gt; m or kg m-2]. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="43" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="43" bodyend="43"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__continuity__ppm_1_1continuity__ppm__cs_1a96759dc2aedc80956a82cba3a4fc992f" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real mom_continuity_ppm::continuity_ppm_cs::cfl_limit_adjust</definition>
        <argsstring></argsstring>
        <name>cfl_limit_adjust</name>
        <briefdescription>
<para>The maximum CFL of the adjusted velocities [nondim]. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="47" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="47" bodyend="47"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__continuity__ppm_1_1continuity__ppm__cs_1ad84ba4de139ff6a3e92daaafcad49661" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical mom_continuity_ppm::continuity_ppm_cs::aggress_adjust</definition>
        <argsstring></argsstring>
        <name>aggress_adjust</name>
        <briefdescription>
<para>If true, allow the adjusted velocities to have a relative CFL change up to 0.5. False by default. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="48" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="48" bodyend="48"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__continuity__ppm_1_1continuity__ppm__cs_1ab908195205481a4bc600f096ec253202" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical mom_continuity_ppm::continuity_ppm_cs::vol_cfl</definition>
        <argsstring></argsstring>
        <name>vol_cfl</name>
        <briefdescription>
<para>If true, use the ratio of the open face lengths to the tracer cell areas when estimating CFL numbers. Without aggress_adjust, the default is false; it is always true with. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="50" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="50" bodyend="50"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__continuity__ppm_1_1continuity__ppm__cs_1ae3f694206cb1d66d575e235c4cf84520" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical mom_continuity_ppm::continuity_ppm_cs::better_iter</definition>
        <argsstring></argsstring>
        <name>better_iter</name>
        <briefdescription>
<para>If true, stop corrective iterations using a velocity-based criterion and only stop if the iteration is better than all predecessors. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="54" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="54" bodyend="54"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__continuity__ppm_1_1continuity__ppm__cs_1a5fe924e4127bbe2d9c80a664d1854b0b" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical mom_continuity_ppm::continuity_ppm_cs::use_visc_rem_max</definition>
        <argsstring></argsstring>
        <name>use_visc_rem_max</name>
        <briefdescription>
<para>If true, use more appropriate limiting bounds for corrections in strongly viscous columns. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="57" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="57" bodyend="57"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__continuity__ppm_1_1continuity__ppm__cs_1ae44744cc0d1bf318ad9655ea688dc248" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical mom_continuity_ppm::continuity_ppm_cs::marginal_faces</definition>
        <argsstring></argsstring>
        <name>marginal_faces</name>
        <briefdescription>
<para>If true, use the marginal face areas from the continuity solver for use as the weights in the barotropic solver. Otherwise use the transport averaged areas. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="59" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="59" bodyend="59"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Control structure for <ref refid="namespacemom__continuity__ppm" kindref="compound">mom_continuity_ppm</ref>. </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <collaborationgraph>
      <node id="201">
        <label>real</label>
      </node>
      <node id="198">
        <label>mom_continuity_ppm::continuity_ppm_cs</label>
        <link refid="structmom__continuity__ppm_1_1continuity__ppm__cs"/>
        <childnode refid="199" relation="usage">
          <edgelabel>aggress_adjust</edgelabel>
          <edgelabel>monotonic</edgelabel>
          <edgelabel>simple_2nd</edgelabel>
          <edgelabel>better_iter</edgelabel>
          <edgelabel>upwind_1st</edgelabel>
          <edgelabel>marginal_faces</edgelabel>
          <edgelabel>vol_cfl</edgelabel>
          <edgelabel>use_visc_rem_max</edgelabel>
        </childnode>
        <childnode refid="200" relation="usage">
          <edgelabel>diag</edgelabel>
        </childnode>
        <childnode refid="201" relation="usage">
          <edgelabel>tol_eta_aux</edgelabel>
          <edgelabel>tol_eta</edgelabel>
          <edgelabel>cfl_limit_adjust</edgelabel>
          <edgelabel>tol_vel</edgelabel>
        </childnode>
      </node>
      <node id="199">
        <label>logical</label>
      </node>
      <node id="200">
        <label>diag_ctrl</label>
      </node>
    </collaborationgraph>
    <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" line="28" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity_PPM.F90" bodystart="28" bodyend="63"/>
    <listofallmembers>
      <member refid="structmom__continuity__ppm_1_1continuity__ppm__cs_1ad84ba4de139ff6a3e92daaafcad49661" prot="public" virt="non-virtual"><scope>mom_continuity_ppm::continuity_ppm_cs</scope><name>aggress_adjust</name></member>
      <member refid="structmom__continuity__ppm_1_1continuity__ppm__cs_1ae3f694206cb1d66d575e235c4cf84520" prot="public" virt="non-virtual"><scope>mom_continuity_ppm::continuity_ppm_cs</scope><name>better_iter</name></member>
      <member refid="structmom__continuity__ppm_1_1continuity__ppm__cs_1a96759dc2aedc80956a82cba3a4fc992f" prot="public" virt="non-virtual"><scope>mom_continuity_ppm::continuity_ppm_cs</scope><name>cfl_limit_adjust</name></member>
      <member refid="structmom__continuity__ppm_1_1continuity__ppm__cs_1a7066076535193230aba1561690b468b7" prot="public" virt="non-virtual"><scope>mom_continuity_ppm::continuity_ppm_cs</scope><name>diag</name></member>
      <member refid="structmom__continuity__ppm_1_1continuity__ppm__cs_1ae44744cc0d1bf318ad9655ea688dc248" prot="public" virt="non-virtual"><scope>mom_continuity_ppm::continuity_ppm_cs</scope><name>marginal_faces</name></member>
      <member refid="structmom__continuity__ppm_1_1continuity__ppm__cs_1a1e30df6d78505ecfefd3718729254786" prot="public" virt="non-virtual"><scope>mom_continuity_ppm::continuity_ppm_cs</scope><name>monotonic</name></member>
      <member refid="structmom__continuity__ppm_1_1continuity__ppm__cs_1a41a8553c57fa386a4106298c92ec5a74" prot="public" virt="non-virtual"><scope>mom_continuity_ppm::continuity_ppm_cs</scope><name>simple_2nd</name></member>
      <member refid="structmom__continuity__ppm_1_1continuity__ppm__cs_1ab57754ec3775fa331a36ccddf520151b" prot="public" virt="non-virtual"><scope>mom_continuity_ppm::continuity_ppm_cs</scope><name>tol_eta</name></member>
      <member refid="structmom__continuity__ppm_1_1continuity__ppm__cs_1ab76d38d53b0ae9c68c0e4be1db69e99b" prot="public" virt="non-virtual"><scope>mom_continuity_ppm::continuity_ppm_cs</scope><name>tol_eta_aux</name></member>
      <member refid="structmom__continuity__ppm_1_1continuity__ppm__cs_1a52e602d24b0b68a0606231287e8eaf1d" prot="public" virt="non-virtual"><scope>mom_continuity_ppm::continuity_ppm_cs</scope><name>tol_vel</name></member>
      <member refid="structmom__continuity__ppm_1_1continuity__ppm__cs_1a2136b96f5c65788435e50622fcc18af5" prot="public" virt="non-virtual"><scope>mom_continuity_ppm::continuity_ppm_cs</scope><name>upwind_1st</name></member>
      <member refid="structmom__continuity__ppm_1_1continuity__ppm__cs_1a5fe924e4127bbe2d9c80a664d1854b0b" prot="public" virt="non-virtual"><scope>mom_continuity_ppm::continuity_ppm_cs</scope><name>use_visc_rem_max</name></member>
      <member refid="structmom__continuity__ppm_1_1continuity__ppm__cs_1ab908195205481a4bc600f096ec253202" prot="public" virt="non-virtual"><scope>mom_continuity_ppm::continuity_ppm_cs</scope><name>vol_cfl</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
