<?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.13">
  <compounddef id="namespacelock__exchange__initialization" kind="namespace" language="Fortran">
    <compoundname>lock_exchange_initialization</compoundname>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacelock__exchange__initialization_1a031749f6391fa3a8e517889e96ad6115" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public lock_exchange_initialization::lock_exchange_initialize_thickness</definition>
        <argsstring>(h, G, GV, US, param_file, just_read_params)</argsstring>
        <name>lock_exchange_initialize_thickness</name>
        <param>
          <type>h</type>
          <defname>h</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>just_read_params</type>
          <defname>just_read_params</defname>
        </param>
        <briefdescription>
<para>This subroutine initializes layer thicknesses for the lock_exchange experiment. </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="out">h</parametername>
</parameternamelist>
<parameterdescription>
<para>The thickness that is being initialized [H ~&gt; m or kg m-2].</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure indicating the open file to parse for model parameter values.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">just_read_params</parametername>
</parameternamelist>
<parameterdescription>
<para>If present and true, this call will only read parameters without changing h. </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/lock_exchange_initialization.F90" line="26" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/lock_exchange_initialization.F90" bodystart="27" bodyend="92"/>
        <references refid="namespacemom__error__handler_1a1c462df7b61f1296407b4af51dfeceab" compoundref="MOM__error__handler_8F90" startline="53" endline="66">mom_error_handler::mom_mesg</references>
        <referencedby refid="namespacemom__state__initialization_1a81503d4f1855cb185f122d6314e4f06c" compoundref="MOM__state__initialization_8F90" startline="117" endline="615">mom_state_initialization::mom_initialize_state</referencedby>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Initialization of the &quot;lock exchange&quot; experiment. lock_exchange = A 2-d density driven hydraulic exchange flow. </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/user/lock_exchange_initialization.F90" line="3" column="1"/>
  </compounddef>
</doxygen>
