<?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__lateral__boundary__diffusion_1_1lateral__boundary__diffusion__cs" kind="type" language="Fortran" prot="public">
    <compoundname>mom_lateral_boundary_diffusion::lateral_boundary_diffusion_cs</compoundname>
      <sectiondef kind="public-attrib">
      <memberdef kind="variable" id="structmom__lateral__boundary__diffusion_1_1lateral__boundary__diffusion__cs_1a0f35ad344e47e472298459f6bf8a8bdf" prot="public" static="no" mutable="no">
        <type>integer</type>
        <definition>integer mom_lateral_boundary_diffusion::lateral_boundary_diffusion_cs::method</definition>
        <argsstring></argsstring>
        <name>method</name>
        <briefdescription>
<para>Determine which of the three methods calculate and apply near boundary layer fluxes. </para>
        </briefdescription>
        <detaileddescription>
<para><orderedlist>
<listitem><para>Along layer</para>
</listitem><listitem><para>Bulk-layer approach (not recommended) </para>
</listitem></orderedlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/MOM_lateral_boundary_diffusion.F90" line="40" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/MOM_lateral_boundary_diffusion.F90" bodystart="40" bodyend="40"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__lateral__boundary__diffusion_1_1lateral__boundary__diffusion__cs_1aabf2784090bb9e493287e58016a70e2f" prot="public" static="no" mutable="no">
        <type>integer</type>
        <definition>integer mom_lateral_boundary_diffusion::lateral_boundary_diffusion_cs::deg</definition>
        <argsstring></argsstring>
        <name>deg</name>
        <briefdescription>
<para>Degree of polynomial reconstruction. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/MOM_lateral_boundary_diffusion.F90" line="44" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/MOM_lateral_boundary_diffusion.F90" bodystart="44" bodyend="44"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__lateral__boundary__diffusion_1_1lateral__boundary__diffusion__cs_1a0f05aa2e76438de93652921a477eec94" prot="public" static="no" mutable="no">
        <type>integer</type>
        <definition>integer mom_lateral_boundary_diffusion::lateral_boundary_diffusion_cs::surface_boundary_scheme</definition>
        <argsstring></argsstring>
        <name>surface_boundary_scheme</name>
        <briefdescription>
<para>Which boundary layer scheme to use. </para>
        </briefdescription>
        <detaileddescription>
<para><orderedlist>
<listitem><para>ePBL; 2. KPP </para>
</listitem></orderedlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/MOM_lateral_boundary_diffusion.F90" line="45" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/MOM_lateral_boundary_diffusion.F90" bodystart="45" bodyend="45"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__lateral__boundary__diffusion_1_1lateral__boundary__diffusion__cs_1afca58198fb0188dca1244c5557e78d9b" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical mom_lateral_boundary_diffusion::lateral_boundary_diffusion_cs::limiter</definition>
        <argsstring></argsstring>
        <name>limiter</name>
        <briefdescription>
<para>Controls wether a flux limiter is applied. Only valid when method = 2. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/MOM_lateral_boundary_diffusion.F90" line="47" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/MOM_lateral_boundary_diffusion.F90" bodystart="47" bodyend="47"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__lateral__boundary__diffusion_1_1lateral__boundary__diffusion__cs_1afe08876162ae39aa7fc426e06ef89ca2" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical mom_lateral_boundary_diffusion::lateral_boundary_diffusion_cs::linear</definition>
        <argsstring></argsstring>
        <name>linear</name>
        <briefdescription>
<para>If True, apply a linear transition at the base/top of the boundary. The flux will be fully applied at k=k_min and zero at k=k_max. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/MOM_lateral_boundary_diffusion.F90" line="49" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/MOM_lateral_boundary_diffusion.F90" bodystart="49" bodyend="49"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__lateral__boundary__diffusion_1_1lateral__boundary__diffusion__cs_1ad9c837ad6d0928e9eee3b5dd3b39655b" prot="public" static="no" mutable="no">
        <type>type(remapping_cs)</type>
        <definition>type(remapping_cs) mom_lateral_boundary_diffusion::lateral_boundary_diffusion_cs::remap_cs</definition>
        <argsstring></argsstring>
        <name>remap_cs</name>
        <briefdescription>
<para>Control structure to hold remapping configuration. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/MOM_lateral_boundary_diffusion.F90" line="52" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/MOM_lateral_boundary_diffusion.F90" bodystart="52" bodyend="52"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__lateral__boundary__diffusion_1_1lateral__boundary__diffusion__cs_1a29f08a77261ff245936641829d8b202f" prot="public" static="no" mutable="no">
        <type>type(kpp_cs), pointer</type>
        <definition>type(kpp_cs), pointer mom_lateral_boundary_diffusion::lateral_boundary_diffusion_cs::kpp_csp</definition>
        <argsstring></argsstring>
        <name>kpp_csp</name>
        <initializer>=&gt; NULL()</initializer>
        <briefdescription>
<para>KPP control structure needed to get BLD. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/MOM_lateral_boundary_diffusion.F90" line="53" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/MOM_lateral_boundary_diffusion.F90" bodystart="53" bodyend="53"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__lateral__boundary__diffusion_1_1lateral__boundary__diffusion__cs_1ac63bd15caddb1af2efc1132cce2bd335" prot="public" static="no" mutable="no">
        <type>type(energetic_pbl_cs), pointer</type>
        <definition>type(energetic_pbl_cs), pointer mom_lateral_boundary_diffusion::lateral_boundary_diffusion_cs::energetic_pbl_csp</definition>
        <argsstring></argsstring>
        <name>energetic_pbl_csp</name>
        <initializer>=&gt; NULL()</initializer>
        <briefdescription>
<para>ePBL control structure needed to get BLD </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/MOM_lateral_boundary_diffusion.F90" line="54" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/MOM_lateral_boundary_diffusion.F90" bodystart="54" bodyend="54"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__lateral__boundary__diffusion_1_1lateral__boundary__diffusion__cs_1a9b361105c17f0e44700d48be96517e59" prot="public" static="no" mutable="no">
        <type>type(diag_ctrl), pointer</type>
        <definition>type(diag_ctrl), pointer mom_lateral_boundary_diffusion::lateral_boundary_diffusion_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/tracer/MOM_lateral_boundary_diffusion.F90" line="55" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/MOM_lateral_boundary_diffusion.F90" bodystart="55" bodyend="55"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Sets parameters for lateral boundary mixing module. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <collaborationgraph>
      <node id="3">
        <label>type(energetic_pbl_cs), pointer</label>
      </node>
      <node id="2">
        <label>logical</label>
      </node>
      <node id="4">
        <label>remapping_cs</label>
      </node>
      <node id="6">
        <label>type(kpp_cs), pointer</label>
      </node>
      <node id="5">
        <label>diag_ctrl</label>
      </node>
      <node id="7">
        <label>integer</label>
      </node>
      <node id="1">
        <label>mom_lateral_boundary_diffusion::lateral_boundary_diffusion_cs</label>
        <link refid="structmom__lateral__boundary__diffusion_1_1lateral__boundary__diffusion__cs"/>
        <childnode refid="2" relation="usage">
          <edgelabel>linear</edgelabel>
          <edgelabel>limiter</edgelabel>
        </childnode>
        <childnode refid="3" relation="usage">
          <edgelabel>energetic_pbl_csp</edgelabel>
        </childnode>
        <childnode refid="4" relation="usage">
          <edgelabel>remap_cs</edgelabel>
        </childnode>
        <childnode refid="5" relation="usage">
          <edgelabel>diag</edgelabel>
        </childnode>
        <childnode refid="6" relation="usage">
          <edgelabel>kpp_csp</edgelabel>
        </childnode>
        <childnode refid="7" relation="usage">
          <edgelabel>deg</edgelabel>
          <edgelabel>method</edgelabel>
          <edgelabel>surface_boundary_scheme</edgelabel>
        </childnode>
      </node>
    </collaborationgraph>
    <location file="/home/cermak/src/MOM6.devrob/src/tracer/MOM_lateral_boundary_diffusion.F90" line="39" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/MOM_lateral_boundary_diffusion.F90" bodystart="39" bodyend="57"/>
    <listofallmembers>
      <member refid="structmom__lateral__boundary__diffusion_1_1lateral__boundary__diffusion__cs_1aabf2784090bb9e493287e58016a70e2f" prot="public" virt="non-virtual"><scope>mom_lateral_boundary_diffusion::lateral_boundary_diffusion_cs</scope><name>deg</name></member>
      <member refid="structmom__lateral__boundary__diffusion_1_1lateral__boundary__diffusion__cs_1a9b361105c17f0e44700d48be96517e59" prot="public" virt="non-virtual"><scope>mom_lateral_boundary_diffusion::lateral_boundary_diffusion_cs</scope><name>diag</name></member>
      <member refid="structmom__lateral__boundary__diffusion_1_1lateral__boundary__diffusion__cs_1ac63bd15caddb1af2efc1132cce2bd335" prot="public" virt="non-virtual"><scope>mom_lateral_boundary_diffusion::lateral_boundary_diffusion_cs</scope><name>energetic_pbl_csp</name></member>
      <member refid="structmom__lateral__boundary__diffusion_1_1lateral__boundary__diffusion__cs_1a29f08a77261ff245936641829d8b202f" prot="public" virt="non-virtual"><scope>mom_lateral_boundary_diffusion::lateral_boundary_diffusion_cs</scope><name>kpp_csp</name></member>
      <member refid="structmom__lateral__boundary__diffusion_1_1lateral__boundary__diffusion__cs_1afca58198fb0188dca1244c5557e78d9b" prot="public" virt="non-virtual"><scope>mom_lateral_boundary_diffusion::lateral_boundary_diffusion_cs</scope><name>limiter</name></member>
      <member refid="structmom__lateral__boundary__diffusion_1_1lateral__boundary__diffusion__cs_1afe08876162ae39aa7fc426e06ef89ca2" prot="public" virt="non-virtual"><scope>mom_lateral_boundary_diffusion::lateral_boundary_diffusion_cs</scope><name>linear</name></member>
      <member refid="structmom__lateral__boundary__diffusion_1_1lateral__boundary__diffusion__cs_1a0f35ad344e47e472298459f6bf8a8bdf" prot="public" virt="non-virtual"><scope>mom_lateral_boundary_diffusion::lateral_boundary_diffusion_cs</scope><name>method</name></member>
      <member refid="structmom__lateral__boundary__diffusion_1_1lateral__boundary__diffusion__cs_1ad9c837ad6d0928e9eee3b5dd3b39655b" prot="public" virt="non-virtual"><scope>mom_lateral_boundary_diffusion::lateral_boundary_diffusion_cs</scope><name>remap_cs</name></member>
      <member refid="structmom__lateral__boundary__diffusion_1_1lateral__boundary__diffusion__cs_1a0f05aa2e76438de93652921a477eec94" prot="public" virt="non-virtual"><scope>mom_lateral_boundary_diffusion::lateral_boundary_diffusion_cs</scope><name>surface_boundary_scheme</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
