<?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.20" xml:lang="en-US">
  <compounddef id="namespacemom__continuity" kind="namespace" language="Fortran">
    <compoundname>mom_continuity</compoundname>
    <innerclass refid="structmom__continuity_1_1continuity__cs" prot="public">mom_continuity::continuity_cs</innerclass>
      <sectiondef kind="var">
      <memberdef kind="variable" id="namespacemom__continuity_1a89cc7674e8c8f8f248a02eca930c4ec8" prot="public" static="no" mutable="no">
        <type>integer, parameter</type>
        <definition>integer, parameter mom_continuity::ppm_scheme</definition>
        <argsstring></argsstring>
        <name>ppm_scheme</name>
        <initializer>= 1</initializer>
        <briefdescription>
<para>Enumerated constant to select PPM. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity.F90" line="35" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity.F90" bodystart="35" bodyend="35"/>
        <referencedby refid="namespacemom__continuity_1af5199f6dd73755cc33c133723339a0ff" compoundref="MOM__continuity_8F90" startline="44" endline="104">continuity</referencedby>
        <referencedby refid="namespacemom__continuity_1aa91ed69484f54d0bba361bfe60d89d60" compoundref="MOM__continuity_8F90" startline="170" endline="177">continuity_end</referencedby>
        <referencedby refid="namespacemom__continuity_1a458ebf2ce1b5dede05607b2d644dcfad" compoundref="MOM__continuity_8F90" startline="109" endline="151">continuity_init</referencedby>
        <referencedby refid="namespacemom__continuity_1afb0ed16b38c098805a3a9caf4b60ceff" compoundref="MOM__continuity_8F90" startline="157" endline="165">continuity_stencil</referencedby>
      </memberdef>
      <memberdef kind="variable" id="namespacemom__continuity_1aa812945b4fe598341c19e296ec4a89ef" prot="private" static="no" mutable="no">
        <type><ref refid="version__variable_8h_1acda997fe1761de4c6bca0f27dc786964" kindref="member">character</ref>(len=20), parameter</type>
        <definition>character(len=20), parameter mom_continuity::ppm_string</definition>
        <argsstring></argsstring>
        <name>ppm_string</name>
        <initializer>= &quot;PPM&quot;</initializer>
        <briefdescription>
<para>String to select PPM. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity.F90" line="36" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity.F90" bodystart="36" bodyend="36"/>
        <referencedby refid="namespacemom__continuity_1a458ebf2ce1b5dede05607b2d644dcfad" compoundref="MOM__continuity_8F90" startline="109" endline="151">continuity_init</referencedby>
      </memberdef>
      </sectiondef>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacemom__continuity_1af5199f6dd73755cc33c133723339a0ff" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_continuity::continuity</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</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 limited, 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>Ocean 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">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>Volume flux through zonal faces = </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">vh</parametername>
</parameternamelist>
<parameterdescription>
<para>Volume flux through meridional faces = </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>Control structure for <ref refid="namespacemom__continuity" kindref="compound">mom_continuity</ref>. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">uhbt</parametername>
</parameternamelist>
<parameterdescription>
<para>The vertically summed volume </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">vhbt</parametername>
</parameternamelist>
<parameterdescription>
<para>The vertically summed volume </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>Both the fraction of </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">visc_rem_v</parametername>
</parameternamelist>
<parameterdescription>
<para>Both the fraction of </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">u_cor</parametername>
</parameternamelist>
<parameterdescription>
<para>The zonal velocities that </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">v_cor</parametername>
</parameternamelist>
<parameterdescription>
<para>The meridional velocities that </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>bt_cont</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure with elements </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity.F90" line="42" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity.F90" bodystart="44" bodyend="104"/>
        <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_1a89cc7674e8c8f8f248a02eca930c4ec8" compoundref="MOM__continuity_8F90" startline="35" endline="35">ppm_scheme</references>
        <referencedby refid="namespacemom__dynamics__unsplit_1ab72d911d187f9247b6cc72d87e815370" compoundref="MOM__dynamics__unsplit_8F90" startline="192" endline="507">mom_dynamics_unsplit::step_mom_dyn_unsplit</referencedby>
        <referencedby refid="namespacemom__dynamics__unsplit__rk2_1a25424d65cc3339442e528c0a92b173a3" compoundref="MOM__dynamics__unsplit__RK2_8F90" startline="194" endline="452">mom_dynamics_unsplit_rk2::step_mom_dyn_unsplit_rk2</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__continuity_1a458ebf2ce1b5dede05607b2d644dcfad" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_continuity::continuity_init</definition>
        <argsstring>(Time, G, GV, US, param_file, diag, CS)</argsstring>
        <name>continuity_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_1_1continuity__cs" kindref="compound">continuity_cs</ref>. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">time</parametername>
</parameternamelist>
<parameterdescription>
<para>Current model time. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean 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>Parameter file handles. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">diag</parametername>
</parameternamelist>
<parameterdescription>
<para>Diagnostics control structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Control structure for <ref refid="namespacemom__continuity" kindref="compound">mom_continuity</ref>. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity.F90" line="108" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity.F90" bodystart="109" bodyend="151"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <references refid="namespacemom__error__handler_1a1c462df7b61f1296407b4af51dfeceab" compoundref="MOM__error__handler_8F90" startline="53" endline="66">mom_error_handler::mom_mesg</references>
        <references refid="namespacemom__continuity_1a89cc7674e8c8f8f248a02eca930c4ec8" compoundref="MOM__continuity_8F90" startline="35" endline="35">ppm_scheme</references>
        <references refid="namespacemom__continuity_1aa812945b4fe598341c19e296ec4a89ef" compoundref="MOM__continuity_8F90" startline="36" endline="36">ppm_string</references>
        <references refid="namespacemom__string__functions_1aca148baf726de2f028b7e7baad3c85d4" compoundref="MOM__string__functions_8F90" startline="44" endline="56">mom_string_functions::uppercase</references>
        <referencedby refid="namespacemom__dynamics__unsplit_1aa428b0ad5ed3e6cbbb1fd83484eba2f8" compoundref="MOM__dynamics__unsplit_8F90" startline="560" endline="704">mom_dynamics_unsplit::initialize_dyn_unsplit</referencedby>
        <referencedby refid="namespacemom__dynamics__unsplit__rk2_1a900ac5cb7e63b6b9872123de94f147d7" compoundref="MOM__dynamics__unsplit__RK2_8F90" startline="508" endline="661">mom_dynamics_unsplit_rk2::initialize_dyn_unsplit_rk2</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__continuity_1afb0ed16b38c098805a3a9caf4b60ceff" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>integer function, public</type>
        <definition>integer function, public mom_continuity::continuity_stencil</definition>
        <argsstring>(CS)</argsstring>
        <name>continuity_stencil</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>continuity_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.F90" line="156" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity.F90" bodystart="157" bodyend="165"/>
        <references refid="namespacemom__continuity_1a89cc7674e8c8f8f248a02eca930c4ec8" compoundref="MOM__continuity_8F90" startline="35" endline="35">ppm_scheme</references>
        <referencedby refid="namespacemom__dynamics__split__rk2_1a3995d7e0c8fb36abdc7166ea4fe586d1" compoundref="MOM__dynamics__split__RK2_8F90" startline="1077" endline="1438">mom_dynamics_split_rk2::initialize_dyn_split_rk2</referencedby>
        <referencedby refid="namespacemom__dynamics__unsplit_1aa428b0ad5ed3e6cbbb1fd83484eba2f8" compoundref="MOM__dynamics__unsplit_8F90" startline="560" endline="704">mom_dynamics_unsplit::initialize_dyn_unsplit</referencedby>
        <referencedby refid="namespacemom__dynamics__unsplit__rk2_1a900ac5cb7e63b6b9872123de94f147d7" compoundref="MOM__dynamics__unsplit__RK2_8F90" startline="508" endline="661">mom_dynamics_unsplit_rk2::initialize_dyn_unsplit_rk2</referencedby>
        <referencedby refid="namespacemom__dynamics__split__rk2_1a976e700971f232fc11bc69b31d611c32" compoundref="MOM__dynamics__split__RK2_8F90" startline="245" endline="994">mom_dynamics_split_rk2::step_mom_dyn_split_rk2</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__continuity_1aa91ed69484f54d0bba361bfe60d89d60" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_continuity::continuity_end</definition>
        <argsstring>(CS)</argsstring>
        <name>continuity_end</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>Destructor for <ref refid="structmom__continuity_1_1continuity__cs" kindref="compound">continuity_cs</ref>. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Control structure for <ref refid="namespacemom__continuity" kindref="compound">mom_continuity</ref>. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity.F90" line="169" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity.F90" bodystart="170" bodyend="177"/>
        <references refid="namespacemom__continuity__ppm_1a38ffbfd81e4bef4c789429fb843ed7cc" compoundref="MOM__continuity__PPM_8F90" startline="2335" endline="2336">mom_continuity_ppm::continuity_ppm_end</references>
        <references refid="namespacemom__continuity_1a89cc7674e8c8f8f248a02eca930c4ec8" compoundref="MOM__continuity_8F90" startline="35" endline="35">ppm_scheme</references>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Solve the layer continuity equation. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_continuity.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
