<?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="namespacetidal__bay__initialization" kind="namespace" language="Fortran">
    <compoundname>tidal_bay_initialization</compoundname>
    <innerclass refid="structtidal__bay__initialization_1_1tidal__bay__obc__cs" prot="public">tidal_bay_initialization::tidal_bay_obc_cs</innerclass>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacetidal__bay__initialization_1a6a382dc13d49aa2d37577b8fbf5f7de2" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>logical function, public</type>
        <definition>logical function, public tidal_bay_initialization::register_tidal_bay_obc</definition>
        <argsstring>(param_file, CS, OBC_Reg)</argsstring>
        <name>register_tidal_bay_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 tidal bay 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>tidal bay 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/tidal_bay_initialization.F90" line="33" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/tidal_bay_initialization.F90" bodystart="34" bodyend="50"/>
        <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="namespacetidal__bay__initialization_1a0c8bd22e72376c9f9af5bc5f628393f9" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public tidal_bay_initialization::tidal_bay_obc_end</definition>
        <argsstring>(CS)</argsstring>
        <name>tidal_bay_obc_end</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>Clean up the tidal bay OBC from registry. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>tidal bay control structure. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/tidal_bay_initialization.F90" line="54" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/tidal_bay_initialization.F90" bodystart="55" bodyend="59"/>
        <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="namespacetidal__bay__initialization_1a874c04828e2652fbd356c8a89c8179da" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public tidal_bay_initialization::tidal_bay_set_obc_data</definition>
        <argsstring>(OBC, CS, G, h, Time)</argsstring>
        <name>tidal_bay_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>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>tidal bay 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">h</parametername>
</parameternamelist>
<parameterdescription>
<para>layer thickness. </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/tidal_bay_initialization.F90" line="63" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/tidal_bay_initialization.F90" bodystart="64" bodyend="117"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Configures the model for the &quot;tidal_bay&quot; experiment. tidal_bay = Tidally resonant bay from Zygmunt Kowalik&apos;s class on tides. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/user/tidal_bay_initialization.F90" line="3" column="1"/>
  </compounddef>
</doxygen>
