<?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="namespacekelvin__initialization" kind="namespace" language="Fortran">
    <compoundname>kelvin_initialization</compoundname>
    <innerclass refid="structkelvin__initialization_1_1kelvin__obc__cs" prot="public">kelvin_initialization::kelvin_obc_cs</innerclass>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacekelvin__initialization_1a987148fd20c38f1f4897661a39c3120e" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>logical function, public</type>
        <definition>logical function, public kelvin_initialization::register_kelvin_obc</definition>
        <argsstring>(param_file, CS, OBC_Reg)</argsstring>
        <name>register_kelvin_obc</name>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>OBC_Reg</type>
          <defname>OBC_Reg</defname>
        </param>
        <briefdescription>
<para>Add Kelvin wave to OBC registry. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>parameter file. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Kelvin wave control structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>obc_reg</parametername>
</parameternamelist>
<parameterdescription>
<para>OBC registry. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/Kelvin_initialization.F90" line="53" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/Kelvin_initialization.F90" bodystart="54" bodyend="106"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
      </memberdef>
      <memberdef kind="function" id="namespacekelvin__initialization_1a9c8e0745879d099cef92df7f16c67f9c" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public kelvin_initialization::kelvin_obc_end</definition>
        <argsstring>(CS)</argsstring>
        <name>kelvin_obc_end</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>Clean up the Kelvin wave OBC from registry. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Kelvin wave control structure. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/Kelvin_initialization.F90" line="110" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/Kelvin_initialization.F90" bodystart="111" bodyend="115"/>
        <referencedby refid="namespacemom__boundary__update_1a32cfc645987cee827d4d193537b09c71" compoundref="MOM__boundary__update_8F90" startline="155" endline="161">mom_boundary_update::obc_register_end</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacekelvin__initialization_1abddff8dbfe770caf9b7d5564b3a0fc6d" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public kelvin_initialization::kelvin_initialize_topography</definition>
        <argsstring>(D, G, param_file, max_depth, US)</argsstring>
        <name>kelvin_initialize_topography</name>
        <param>
          <type>D</type>
          <defname>D</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>max_depth</type>
          <defname>max_depth</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <briefdescription>
<para>This subroutine sets up the Kelvin topography and land mask. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>The dynamic horizontal grid type </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">d</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean bottom depth in m or Z if US is present </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>Parameter file structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">max_depth</parametername>
</parameternamelist>
<parameterdescription>
<para>Maximum model depth in the units of D </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">us</parametername>
</parameternamelist>
<parameterdescription>
<para>A dimensional unit scaling type </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/Kelvin_initialization.F90" line="120" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/Kelvin_initialization.F90" bodystart="121" bodyend="168"/>
        <references refid="namespacemom__error__handler_1a1c462df7b61f1296407b4af51dfeceab" compoundref="MOM__error__handler_8F90" startline="53" endline="66">mom_error_handler::mom_mesg</references>
        <referencedby refid="namespacemom__fixed__initialization_1ae980c841ada6296d07df08442398e87b" compoundref="MOM__fixed__initialization_8F90" startline="175" endline="257">mom_fixed_initialization::mom_initialize_topography</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacekelvin__initialization_1a39f47303961021f5605578c00722add2" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public kelvin_initialization::kelvin_set_obc_data</definition>
        <argsstring>(OBC, CS, G, GV, US, h, Time)</argsstring>
        <name>kelvin_set_obc_data</name>
        <param>
          <type>OBC</type>
          <defname>OBC</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</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>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>Time</type>
          <defname>Time</defname>
        </param>
        <briefdescription>
<para>This subroutine sets the properties of flow at open boundary conditions. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>obc</parametername>
</parameternamelist>
<parameterdescription>
<para>This open boundary condition type specifies whether, where, and what open boundary conditions are used. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Kelvin wave control structure. </para>
</parameterdescription>
</parameteritem>
<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 thickness [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">time</parametername>
</parameternamelist>
<parameterdescription>
<para>model time. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/Kelvin_initialization.F90" line="172" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/Kelvin_initialization.F90" bodystart="173" bodyend="358"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Configures the model for the Kelvin wave experiment. </para>
    </briefdescription>
    <detaileddescription>
<para>Kelvin = coastally-trapped Kelvin waves from the ROMS examples. Initialize with level surfaces and drive the wave in at the west, radiate out at the east. </para>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/user/Kelvin_initialization.F90" line="6" column="1"/>
  </compounddef>
</doxygen>
