<?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.18">
  <compounddef id="structmom__regularize__layers_1_1regularize__layers__cs" kind="type" language="Fortran" prot="public">
    <compoundname>mom_regularize_layers::regularize_layers_cs</compoundname>
      <sectiondef kind="public-attrib">
      <memberdef kind="variable" id="structmom__regularize__layers_1_1regularize__layers__cs_1ad83519bd2a2b9648f662bb1931e299ef" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical mom_regularize_layers::regularize_layers_cs::regularize_surface_layers</definition>
        <argsstring></argsstring>
        <name>regularize_surface_layers</name>
        <briefdescription>
<para>If true, vertically restructure the near-surface layers when they have too much lateral variations to allow for sensible lateral barotropic transports. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" line="26" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" bodystart="26" bodyend="26"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__regularize__layers_1_1regularize__layers__cs_1ad1a0d5bbc0ca40585b74255cf394830f" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical mom_regularize_layers::regularize_layers_cs::reg_sfc_detrain</definition>
        <argsstring></argsstring>
        <name>reg_sfc_detrain</name>
        <briefdescription>
<para>If true, allow the buffer layers to detrain into the interior as a part of the restructuring when regularize_surface_layers is true. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" line="30" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" bodystart="30" bodyend="30"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__regularize__layers_1_1regularize__layers__cs_1a75526c31bc2fe89c8a7e7296c2b7ea97" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real mom_regularize_layers::regularize_layers_cs::density_match_tol</definition>
        <argsstring></argsstring>
        <name>density_match_tol</name>
        <briefdescription>
<para>A relative tolerance for how well the densities must match with the target densities during detrainment when regularizing the near-surface layers [nondim]. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" line="33" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" bodystart="33" bodyend="33"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__regularize__layers_1_1regularize__layers__cs_1af4e972c32db3a7c5574028877e69d9bb" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real mom_regularize_layers::regularize_layers_cs::h_def_tol1</definition>
        <argsstring></argsstring>
        <name>h_def_tol1</name>
        <briefdescription>
<para>The value of the relative thickness deficit at which to start modifying the structure, 0.5 by default (or a thickness ratio of 5.83) [nondim]. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" line="36" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" bodystart="36" bodyend="36"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__regularize__layers_1_1regularize__layers__cs_1ab5761320c8fb1161b6b1080e5475016e" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real mom_regularize_layers::regularize_layers_cs::h_def_tol2</definition>
        <argsstring></argsstring>
        <name>h_def_tol2</name>
        <briefdescription>
<para>The value of the relative thickness deficit at which to the structure modification is in full force, now 20% of the way from h_def_tol1 to 1 [nondim]. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" line="39" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" bodystart="39" bodyend="39"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__regularize__layers_1_1regularize__layers__cs_1ae1e3073963072a72fb81928547947923" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real mom_regularize_layers::regularize_layers_cs::h_def_tol3</definition>
        <argsstring></argsstring>
        <name>h_def_tol3</name>
        <briefdescription>
<para>The value of the relative thickness deficit at which to start detrainment from the buffer layers to the interior, now 30% of the way from h_def_tol1 to 1 [nondim]. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" line="42" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" bodystart="42" bodyend="42"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__regularize__layers_1_1regularize__layers__cs_1a529924d2068909a4c2e1fd507b1a1a70" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real mom_regularize_layers::regularize_layers_cs::h_def_tol4</definition>
        <argsstring></argsstring>
        <name>h_def_tol4</name>
        <briefdescription>
<para>The value of the relative thickness deficit at which to do detrainment from the buffer layers to the interior at full force, now 50% of the way from h_def_tol1 to 1 [nondim]. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" line="45" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" bodystart="45" bodyend="45"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__regularize__layers_1_1regularize__layers__cs_1a4faf3f607257aab3e24cbc618311fa57" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real mom_regularize_layers::regularize_layers_cs::hmix_min</definition>
        <argsstring></argsstring>
        <name>hmix_min</name>
        <briefdescription>
<para>The minimum mixed layer thickness [H ~&gt; m or kg m-2]. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" line="48" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" bodystart="48" bodyend="48"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__regularize__layers_1_1regularize__layers__cs_1a95482c46a962839e3bfed3f7be53fb38" prot="public" static="no" mutable="no">
        <type>type(time_type), pointer</type>
        <definition>type(time_type), pointer mom_regularize_layers::regularize_layers_cs::time</definition>
        <argsstring></argsstring>
        <name>time</name>
        <initializer>=&gt; NULL()</initializer>
        <briefdescription>
<para>A pointer to the ocean model&apos;s clock. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" line="49" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" bodystart="49" bodyend="49"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__regularize__layers_1_1regularize__layers__cs_1a06e221446e549e4651cac30995b74aa2" prot="public" static="no" mutable="no">
        <type>type(diag_ctrl), pointer</type>
        <definition>type(diag_ctrl), pointer mom_regularize_layers::regularize_layers_cs::diag</definition>
        <argsstring></argsstring>
        <name>diag</name>
        <initializer>=&gt; NULL()</initializer>
        <briefdescription>
<para>A structure that is used to regulate the timing of diagnostic output. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" line="50" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" bodystart="50" bodyend="50"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__regularize__layers_1_1regularize__layers__cs_1adc6b7c68fe98ce0567387811cc5078da" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical mom_regularize_layers::regularize_layers_cs::answers_2018</definition>
        <argsstring></argsstring>
        <name>answers_2018</name>
        <briefdescription>
<para>If true, use the order of arithmetic and expressions that recover the answers from the end of 2018. Otherwise, use updated and more robust forms of the same expressions. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" line="52" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" bodystart="52" bodyend="52"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__regularize__layers_1_1regularize__layers__cs_1a36102474b2f015503ada8fdc58d65e74" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical mom_regularize_layers::regularize_layers_cs::debug</definition>
        <argsstring></argsstring>
        <name>debug</name>
        <briefdescription>
<para>If true, do more thorough checks for debugging purposes. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" line="55" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" bodystart="55" bodyend="55"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__regularize__layers_1_1regularize__layers__cs_1abd92e2ce17915b98773182103afb207a" prot="public" static="no" mutable="no">
        <type>integer</type>
        <definition>integer mom_regularize_layers::regularize_layers_cs::id_def_rat</definition>
        <argsstring></argsstring>
        <name>id_def_rat</name>
        <initializer>= -1</initializer>
        <briefdescription>
<para>A diagnostic ID. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" line="57" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" bodystart="57" bodyend="57"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__regularize__layers_1_1regularize__layers__cs_1a4f2aa201a5c5c8babeba562daf7465b5" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical mom_regularize_layers::regularize_layers_cs::allow_clocks_in_omp_loops</definition>
        <argsstring></argsstring>
        <name>allow_clocks_in_omp_loops</name>
        <briefdescription>
<para>If true, clocks can be called from inside loops that can be threaded. To run with multiple threads, set to False. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" line="58" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" bodystart="58" bodyend="58"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>This control structure holds parameters used by the MOM_regularize_layers module. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <collaborationgraph>
      <node id="6">
        <label>real</label>
      </node>
      <node id="2">
        <label>logical</label>
      </node>
      <node id="3">
        <label>time_type</label>
      </node>
      <node id="4">
        <label>diag_ctrl</label>
      </node>
      <node id="1">
        <label>mom_regularize_layers::regularize_layers_cs</label>
        <link refid="structmom__regularize__layers_1_1regularize__layers__cs"/>
        <childnode refid="2" relation="usage">
          <edgelabel>answers_2018</edgelabel>
          <edgelabel>regularize_surface_layers</edgelabel>
          <edgelabel>allow_clocks_in_omp_loops</edgelabel>
          <edgelabel>debug</edgelabel>
          <edgelabel>reg_sfc_detrain</edgelabel>
        </childnode>
        <childnode refid="3" relation="usage">
          <edgelabel>time</edgelabel>
        </childnode>
        <childnode refid="4" relation="usage">
          <edgelabel>diag</edgelabel>
        </childnode>
        <childnode refid="5" relation="usage">
          <edgelabel>id_def_rat</edgelabel>
        </childnode>
        <childnode refid="6" relation="usage">
          <edgelabel>density_match_tol</edgelabel>
          <edgelabel>h_def_tol1</edgelabel>
          <edgelabel>h_def_tol2</edgelabel>
          <edgelabel>h_def_tol3</edgelabel>
          <edgelabel>h_def_tol4</edgelabel>
          <edgelabel>hmix_min</edgelabel>
        </childnode>
      </node>
      <node id="5">
        <label>integer</label>
      </node>
    </collaborationgraph>
    <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" line="25" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_regularize_layers.F90" bodystart="25" bodyend="60"/>
    <listofallmembers>
      <member refid="structmom__regularize__layers_1_1regularize__layers__cs_1a4f2aa201a5c5c8babeba562daf7465b5" prot="public" virt="non-virtual"><scope>mom_regularize_layers::regularize_layers_cs</scope><name>allow_clocks_in_omp_loops</name></member>
      <member refid="structmom__regularize__layers_1_1regularize__layers__cs_1adc6b7c68fe98ce0567387811cc5078da" prot="public" virt="non-virtual"><scope>mom_regularize_layers::regularize_layers_cs</scope><name>answers_2018</name></member>
      <member refid="structmom__regularize__layers_1_1regularize__layers__cs_1a36102474b2f015503ada8fdc58d65e74" prot="public" virt="non-virtual"><scope>mom_regularize_layers::regularize_layers_cs</scope><name>debug</name></member>
      <member refid="structmom__regularize__layers_1_1regularize__layers__cs_1a75526c31bc2fe89c8a7e7296c2b7ea97" prot="public" virt="non-virtual"><scope>mom_regularize_layers::regularize_layers_cs</scope><name>density_match_tol</name></member>
      <member refid="structmom__regularize__layers_1_1regularize__layers__cs_1a06e221446e549e4651cac30995b74aa2" prot="public" virt="non-virtual"><scope>mom_regularize_layers::regularize_layers_cs</scope><name>diag</name></member>
      <member refid="structmom__regularize__layers_1_1regularize__layers__cs_1af4e972c32db3a7c5574028877e69d9bb" prot="public" virt="non-virtual"><scope>mom_regularize_layers::regularize_layers_cs</scope><name>h_def_tol1</name></member>
      <member refid="structmom__regularize__layers_1_1regularize__layers__cs_1ab5761320c8fb1161b6b1080e5475016e" prot="public" virt="non-virtual"><scope>mom_regularize_layers::regularize_layers_cs</scope><name>h_def_tol2</name></member>
      <member refid="structmom__regularize__layers_1_1regularize__layers__cs_1ae1e3073963072a72fb81928547947923" prot="public" virt="non-virtual"><scope>mom_regularize_layers::regularize_layers_cs</scope><name>h_def_tol3</name></member>
      <member refid="structmom__regularize__layers_1_1regularize__layers__cs_1a529924d2068909a4c2e1fd507b1a1a70" prot="public" virt="non-virtual"><scope>mom_regularize_layers::regularize_layers_cs</scope><name>h_def_tol4</name></member>
      <member refid="structmom__regularize__layers_1_1regularize__layers__cs_1a4faf3f607257aab3e24cbc618311fa57" prot="public" virt="non-virtual"><scope>mom_regularize_layers::regularize_layers_cs</scope><name>hmix_min</name></member>
      <member refid="structmom__regularize__layers_1_1regularize__layers__cs_1abd92e2ce17915b98773182103afb207a" prot="public" virt="non-virtual"><scope>mom_regularize_layers::regularize_layers_cs</scope><name>id_def_rat</name></member>
      <member refid="structmom__regularize__layers_1_1regularize__layers__cs_1ad1a0d5bbc0ca40585b74255cf394830f" prot="public" virt="non-virtual"><scope>mom_regularize_layers::regularize_layers_cs</scope><name>reg_sfc_detrain</name></member>
      <member refid="structmom__regularize__layers_1_1regularize__layers__cs_1ad83519bd2a2b9648f662bb1931e299ef" prot="public" virt="non-virtual"><scope>mom_regularize_layers::regularize_layers_cs</scope><name>regularize_surface_layers</name></member>
      <member refid="structmom__regularize__layers_1_1regularize__layers__cs_1a95482c46a962839e3bfed3f7be53fb38" prot="public" virt="non-virtual"><scope>mom_regularize_layers::regularize_layers_cs</scope><name>time</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
