<?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.19" xml:lang="en-US">
  <compounddef id="namespaceshelfwave__initialization" kind="namespace" language="Fortran">
    <compoundname>shelfwave_initialization</compoundname>
    <innerclass refid="structshelfwave__initialization_1_1shelfwave__obc__cs" prot="public">shelfwave_initialization::shelfwave_obc_cs</innerclass>
      <sectiondef kind="var">
      <memberdef kind="variable" id="namespaceshelfwave__initialization_1afe4d5b9d225219ff02cf99e70bf4f519" prot="private" static="no" mutable="no">
        <type><ref refid="version__variable_8h_1acda997fe1761de4c6bca0f27dc786964" kindref="member">character</ref>(len=40)</type>
        <definition>character(len=40) shelfwave_initialization::mdl</definition>
        <argsstring></argsstring>
        <name>mdl</name>
        <initializer>= &quot;shelfwave_initialization&quot;</initializer>
        <briefdescription>
<para>This module&apos;s name. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/shelfwave_initialization.F90" line="21" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/shelfwave_initialization.F90" bodystart="21" bodyend="21"/>
        <referencedby refid="namespaceshelfwave__initialization_1a00e944446bb66181ac86fd959534d043" compoundref="shelfwave__initialization_8F90" startline="44" endline="84">register_shelfwave_obc</referencedby>
        <referencedby refid="namespaceshelfwave__initialization_1ac2db4043726cb7eed851c69d6190b8dd" compoundref="shelfwave__initialization_8F90" startline="98" endline="124">shelfwave_initialize_topography</referencedby>
      </memberdef>
      </sectiondef>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespaceshelfwave__initialization_1a00e944446bb66181ac86fd959534d043" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>logical function, public</type>
        <definition>logical function, public shelfwave_initialization::register_shelfwave_obc</definition>
        <argsstring>(param_file, CS, OBC_Reg)</argsstring>
        <name>register_shelfwave_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 shelfwave 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>shelfwave 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/shelfwave_initialization.F90" line="43" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/shelfwave_initialization.F90" bodystart="44" bodyend="84"/>
        <references refid="namespaceshelfwave__initialization_1afe4d5b9d225219ff02cf99e70bf4f519" compoundref="shelfwave__initialization_8F90" startline="21" endline="21">mdl</references>
        <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="namespaceshelfwave__initialization_1ae1b5550c3ac2a4ae131c504d4765905d" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public shelfwave_initialization::shelfwave_obc_end</definition>
        <argsstring>(CS)</argsstring>
        <name>shelfwave_obc_end</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>Clean up the shelfwave OBC from registry. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>shelfwave control structure. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/shelfwave_initialization.F90" line="88" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/shelfwave_initialization.F90" bodystart="89" bodyend="93"/>
      </memberdef>
      <memberdef kind="function" id="namespaceshelfwave__initialization_1ac2db4043726cb7eed851c69d6190b8dd" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public shelfwave_initialization::shelfwave_initialize_topography</definition>
        <argsstring>(D, G, param_file, max_depth, US)</argsstring>
        <name>shelfwave_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>Initialization of topography. </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/shelfwave_initialization.F90" line="97" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/shelfwave_initialization.F90" bodystart="98" bodyend="124"/>
        <references refid="namespaceshelfwave__initialization_1afe4d5b9d225219ff02cf99e70bf4f519" compoundref="shelfwave__initialization_8F90" startline="21" endline="21">mdl</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="namespaceshelfwave__initialization_1a237669eac665275c69ede1c64c139956" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public shelfwave_initialization::shelfwave_set_obc_data</definition>
        <argsstring>(OBC, CS, G, h, Time)</argsstring>
        <name>shelfwave_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/shelfwave_initialization.F90" line="128" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/shelfwave_initialization.F90" bodystart="129" bodyend="180"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Configures the model for the idealized shelfwave test case. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/user/shelfwave_initialization.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
