<?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="namespacemom__full__convection" kind="namespace" language="Fortran">
    <compoundname>mom_full_convection</compoundname>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacemom__full__convection_1aee19e41a18bd855cd01c4ebf4eefcaad" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_full_convection::full_convection</definition>
        <argsstring>(G, GV, US, h, tv, T_adj, S_adj, p_surf, Kddt_smooth, Kddt_convect, halo)</argsstring>
        <name>full_convection</name>
        <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>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>tv</type>
          <defname>tv</defname>
        </param>
        <param>
          <type>T_adj</type>
          <defname>T_adj</defname>
        </param>
        <param>
          <type>S_adj</type>
          <defname>S_adj</defname>
        </param>
        <param>
          <type>p_surf</type>
          <defname>p_surf</defname>
        </param>
        <param>
          <type>Kddt_smooth</type>
          <defname>Kddt_smooth</defname>
        </param>
        <param>
          <type>Kddt_convect</type>
          <defname>Kddt_convect</defname>
        </param>
        <param>
          <type>halo</type>
          <defname>halo</defname>
        </param>
        <briefdescription>
<para>Calculate new temperatures and salinities that have been subject to full convective mixing. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><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>The ocean&apos;s 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">h</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thicknesses [H ~&gt; m or kg m-2]</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">tv</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure pointing to various thermodynamic variables</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">t_adj</parametername>
</parameternamelist>
<parameterdescription>
<para>Adjusted potential temperature [degC].</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">s_adj</parametername>
</parameternamelist>
<parameterdescription>
<para>Adjusted salinity [ppt].</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>p_surf</parametername>
</parameternamelist>
<parameterdescription>
<para>The pressure at the ocean surface [R L2 T-2 ~&gt; Pa] (or NULL).</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">kddt_smooth</parametername>
</parameternamelist>
<parameterdescription>
<para>A smoothing vertical diffusivity times a timestep [H2 ~&gt; m2 or kg2 m-4].</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">kddt_convect</parametername>
</parameternamelist>
<parameterdescription>
<para>A large convecting vertical diffusivity times a timestep [H2 ~&gt; m2 or kg2 m-4].</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">halo</parametername>
</parameternamelist>
<parameterdescription>
<para>Halo width over which to compute </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_full_convection.F90" line="21" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_full_convection.F90" bodystart="23" bodyend="278"/>
        <references refid="namespacemom__full__convection_1a2d2d4f8f10e25a0d9dc9bdfbf6729fe0" compoundref="MOM__full__convection_8F90" startline="286" endline="316">is_unstable</references>
        <references refid="namespacemom__full__convection_1af762a0514a81af81b0acc7553dbcffe3" compoundref="MOM__full__convection_8F90" startline="323" endline="424">smoothed_drdt_drds</references>
        <referencedby refid="namespacemom__set__diffusivity_1a87687e318bfe2d594ce1f57cb5d191e4" compoundref="MOM__set__diffusivity_8F90" startline="213" endline="698">mom_set_diffusivity::set_diffusivity</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__full__convection_1a2d2d4f8f10e25a0d9dc9bdfbf6729fe0" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>logical function</type>
        <definition>logical function mom_full_convection::is_unstable</definition>
        <argsstring>(dRho_dT, dRho_dS, h_a, h_b, mix_A, mix_B, T_a, T_b, S_a, S_b, Te_aa, Te_bb, Se_aa, Se_bb, d_A, d_B)</argsstring>
        <name>is_unstable</name>
        <param>
          <type>dRho_dT</type>
          <defname>dRho_dT</defname>
        </param>
        <param>
          <type>dRho_dS</type>
          <defname>dRho_dS</defname>
        </param>
        <param>
          <type>h_a</type>
          <defname>h_a</defname>
        </param>
        <param>
          <type>h_b</type>
          <defname>h_b</defname>
        </param>
        <param>
          <type>mix_A</type>
          <defname>mix_A</defname>
        </param>
        <param>
          <type>mix_B</type>
          <defname>mix_B</defname>
        </param>
        <param>
          <type>T_a</type>
          <defname>T_a</defname>
        </param>
        <param>
          <type>T_b</type>
          <defname>T_b</defname>
        </param>
        <param>
          <type>S_a</type>
          <defname>S_a</defname>
        </param>
        <param>
          <type>S_b</type>
          <defname>S_b</defname>
        </param>
        <param>
          <type>Te_aa</type>
          <defname>Te_aa</defname>
        </param>
        <param>
          <type>Te_bb</type>
          <defname>Te_bb</defname>
        </param>
        <param>
          <type>Se_aa</type>
          <defname>Se_aa</defname>
        </param>
        <param>
          <type>Se_bb</type>
          <defname>Se_bb</defname>
        </param>
        <param>
          <type>d_A</type>
          <defname>d_A</defname>
        </param>
        <param>
          <type>d_B</type>
          <defname>d_B</defname>
        </param>
        <briefdescription>
<para>This function returns True if the profiles around the given interface will be statically unstable after mixing above below. The arguments are the ocean state above and below, including partial calculations from a tridiagonal solver. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">drho_dt</parametername>
</parameternamelist>
<parameterdescription>
<para>The derivative of in situ density with temperature [R degC-1 ~&gt; kg m-3 degC-1]</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">drho_ds</parametername>
</parameternamelist>
<parameterdescription>
<para>The derivative of in situ density with salinity [R ppt-1 ~&gt; kg m-3 ppt-1]</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_a</parametername>
</parameternamelist>
<parameterdescription>
<para>The thickness of the layer above [H ~&gt; m or kg m-2]</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_b</parametername>
</parameternamelist>
<parameterdescription>
<para>The thickness of the layer below [H ~&gt; m or kg m-2]</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">mix_a</parametername>
</parameternamelist>
<parameterdescription>
<para>The time integrated mixing rate of the interface above [H ~&gt; m or kg m-2]</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">mix_b</parametername>
</parameternamelist>
<parameterdescription>
<para>The time integrated mixing rate of the interface below [H ~&gt; m or kg m-2]</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">t_a</parametername>
</parameternamelist>
<parameterdescription>
<para>The initial temperature of the layer above [degC]</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">t_b</parametername>
</parameternamelist>
<parameterdescription>
<para>The initial temperature of the layer below [degC]</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">s_a</parametername>
</parameternamelist>
<parameterdescription>
<para>The initial salinity of the layer below [ppt]</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">s_b</parametername>
</parameternamelist>
<parameterdescription>
<para>The initial salinity of the layer below [ppt]</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">te_aa</parametername>
</parameternamelist>
<parameterdescription>
<para>The estimated temperature two layers above rescaled by d_A [degC]</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">te_bb</parametername>
</parameternamelist>
<parameterdescription>
<para>The estimated temperature two layers below rescaled by d_B [degC]</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">se_aa</parametername>
</parameternamelist>
<parameterdescription>
<para>The estimated salinity two layers above rescaled by d_A [ppt]</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">se_bb</parametername>
</parameternamelist>
<parameterdescription>
<para>The estimated salinity two layers below rescaled by d_B [ppt]</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">d_a</parametername>
</parameternamelist>
<parameterdescription>
<para>The rescaling dependency across the interface above, nondim.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">d_b</parametername>
</parameternamelist>
<parameterdescription>
<para>The rescaling dependency across the interface below, nondim.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>The return value, true if the profile is statically unstable around the interface in question. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_full_convection.F90" line="284" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_full_convection.F90" bodystart="286" bodyend="316"/>
        <referencedby refid="namespacemom__full__convection_1aee19e41a18bd855cd01c4ebf4eefcaad" compoundref="MOM__full__convection_8F90" startline="23" endline="278">full_convection</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__full__convection_1af762a0514a81af81b0acc7553dbcffe3" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_full_convection::smoothed_drdt_drds</definition>
        <argsstring>(h, tv, Kddt, dR_dT, dR_dS, G, GV, US, j, p_surf, halo)</argsstring>
        <name>smoothed_drdt_drds</name>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>tv</type>
          <defname>tv</defname>
        </param>
        <param>
          <type>Kddt</type>
          <defname>Kddt</defname>
        </param>
        <param>
          <type>dR_dT</type>
          <defname>dR_dT</defname>
        </param>
        <param>
          <type>dR_dS</type>
          <defname>dR_dS</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>j</type>
          <defname>j</defname>
        </param>
        <param>
          <type>p_surf</type>
          <defname>p_surf</defname>
        </param>
        <param>
          <type>halo</type>
          <defname>halo</defname>
        </param>
        <briefdescription>
<para>Returns the partial derivatives of locally referenced potential density with temperature and salinity after the properties have been smoothed with a small constant diffusivity. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><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>The ocean&apos;s vertical grid structure</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thicknesses [H ~&gt; m or kg m-2]</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">tv</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure pointing to various thermodynamic variables</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">kddt</parametername>
</parameternamelist>
<parameterdescription>
<para>A diffusivity times a time increment [H2 ~&gt; m2 or kg2 m-4].</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">dr_dt</parametername>
</parameternamelist>
<parameterdescription>
<para>Derivative of locally referenced</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">dr_ds</parametername>
</parameternamelist>
<parameterdescription>
<para>Derivative of locally referenced</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>The j-point to work on.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>p_surf</parametername>
</parameternamelist>
<parameterdescription>
<para>The pressure at the ocean surface [R L2 T-2 ~&gt; Pa].</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">halo</parametername>
</parameternamelist>
<parameterdescription>
<para>Halo width over which to compute </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_full_convection.F90" line="322" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_full_convection.F90" bodystart="323" bodyend="424"/>
        <references refid="namespacemom__eos_1a782d326108e390902e520efc078e8296" compoundref="MOM__EOS_8F90" startline="1163" endline="1175">mom_eos::eos_domain</references>
        <referencedby refid="namespacemom__full__convection_1aee19e41a18bd855cd01c4ebf4eefcaad" compoundref="MOM__full__convection_8F90" startline="23" endline="278">full_convection</referencedby>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Does full convective adjustment of unstable regions via a strong diffusivity. </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_full_convection.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
