<?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.15">
  <compounddef id="namespacebfb__initialization" kind="namespace" language="Fortran">
    <compoundname>bfb_initialization</compoundname>
      <sectiondef kind="var">
      <memberdef kind="variable" id="namespacebfb__initialization_1a8e08501c7f85819406ff2e7f5cc6bb6b" prot="private" static="no" mutable="no">
        <type>logical</type>
        <definition>logical bfb_initialization::first_call</definition>
        <argsstring></argsstring>
        <name>first_call</name>
        <initializer>= .true.</initializer>
        <briefdescription>
<para>Unsafe model variable. </para>
        </briefdescription>
        <detaileddescription>
<para><xrefsect id="todo_1_todo000009"><xreftitle>Todo</xreftitle><xrefdescription><para>Remove this module variable </para>
</xrefdescription></xrefsect></para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/BFB_initialization.F90" line="30" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/BFB_initialization.F90" bodystart="30" bodyend="30"/>
        <referencedby refid="namespacebfb__initialization_1af1bf4c8e60817f03359d3fd31aab5a90" compoundref="BFB__initialization_8F90" startline="80" endline="170">bfb_initialize_sponges_southonly</referencedby>
        <referencedby refid="namespacebfb__initialization_1a4c4812e80bffdd0501b93c123503d913" compoundref="BFB__initialization_8F90" startline="39" endline="74">bfb_set_coord</referencedby>
        <referencedby refid="namespacebfb__initialization_1acf4641a95e7aa3b9953db2b04a627c97" compoundref="BFB__initialization_8F90" startline="175" endline="185">write_bfb_log</referencedby>
      </memberdef>
      </sectiondef>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacebfb__initialization_1a4c4812e80bffdd0501b93c123503d913" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public bfb_initialization::bfb_set_coord</definition>
        <argsstring>(Rlay, g_prime, GV, US, param_file, eqn_of_state)</argsstring>
        <name>bfb_set_coord</name>
        <param>
          <type>Rlay</type>
          <defname>Rlay</defname>
        </param>
        <param>
          <type>g_prime</type>
          <defname>g_prime</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>eqn_of_state</type>
          <defname>eqn_of_state</defname>
        </param>
        <briefdescription>
<para>This subroutine specifies the vertical coordinate in terms of temperature at the surface and at the bottom. This case is set up in such a way that the temperature of the topmost layer is equal to the SST at the southern edge of the domain. The temperatures are then converted to densities of the top and bottom layers and linearly interpolated for the intermediate layers. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>The ocean&apos;s vertical grid structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">rlay</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer potential density [R ~&gt; kg m-3]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">g_prime</parametername>
</parameternamelist>
<parameterdescription>
<para>The reduced gravity at each interface [L2 Z-1 T-2 ~&gt; m s-2]. </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">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure to parse for run-time parameters </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>eqn_of_state</parametername>
</parameternamelist>
<parameterdescription>
<para>Equation of state structure </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/BFB_initialization.F90" line="38" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/BFB_initialization.F90" bodystart="39" bodyend="74"/>
        <references refid="namespacebfb__initialization_1a8e08501c7f85819406ff2e7f5cc6bb6b" compoundref="BFB__initialization_8F90" startline="30" endline="30">first_call</references>
        <references refid="namespacebfb__initialization_1acf4641a95e7aa3b9953db2b04a627c97" compoundref="BFB__initialization_8F90" startline="175" endline="185">write_bfb_log</references>
        <referencedby refid="namespacemom__coord__initialization_1a08150041e51696069c49248793248c77" compoundref="MOM__coord__initialization_8F90" startline="40" endline="123">mom_coord_initialization::mom_initialize_coord</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacebfb__initialization_1af1bf4c8e60817f03359d3fd31aab5a90" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public bfb_initialization::bfb_initialize_sponges_southonly</definition>
        <argsstring>(G, GV, US, use_temperature, tv, param_file, CSp, h)</argsstring>
        <name>bfb_initialize_sponges_southonly</name>
        <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>use_temperature</type>
          <defname>use_temperature</defname>
        </param>
        <param>
          <type>tv</type>
          <defname>tv</defname>
        </param>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>CSp</type>
          <defname>CSp</defname>
        </param>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <briefdescription>
<para>This subroutine sets up the sponges for the southern bouundary of the domain. Maximum damping occurs within 2 degrees lat of the boundary. The damping linearly decreases northward over the next 2 degrees. </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="in">use_temperature</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, temperature and salinity are used as state variables. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">tv</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure pointing to various thermodynamic variables </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure to parse for run-time parameters </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>csp</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to the sponge control structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thicknesses [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/BFB_initialization.F90" line="79" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/BFB_initialization.F90" bodystart="80" bodyend="170"/>
        <references refid="namespacebfb__initialization_1a8e08501c7f85819406ff2e7f5cc6bb6b" compoundref="BFB__initialization_8F90" startline="30" endline="30">first_call</references>
        <references refid="namespacemom__sponge_1a2c3c6a03d98c13221031af667b42428d" compoundref="MOM__sponge_8F90" startline="90" endline="187">mom_sponge::initialize_sponge</references>
        <references refid="namespacebfb__initialization_1acf4641a95e7aa3b9953db2b04a627c97" compoundref="BFB__initialization_8F90" startline="175" endline="185">write_bfb_log</references>
        <referencedby refid="namespacemom__state__initialization_1a81503d4f1855cb185f122d6314e4f06c" compoundref="MOM__state__initialization_8F90" startline="117" endline="615">mom_state_initialization::mom_initialize_state</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacebfb__initialization_1acf4641a95e7aa3b9953db2b04a627c97" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine bfb_initialization::write_bfb_log</definition>
        <argsstring>(param_file)</argsstring>
        <name>write_bfb_log</name>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <briefdescription>
<para>Write output about the parameter values being used. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><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>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/BFB_initialization.F90" line="174" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/BFB_initialization.F90" bodystart="175" bodyend="185"/>
        <references refid="namespacebfb__initialization_1a8e08501c7f85819406ff2e7f5cc6bb6b" compoundref="BFB__initialization_8F90" startline="30" endline="30">first_call</references>
        <referencedby refid="namespacebfb__initialization_1af1bf4c8e60817f03359d3fd31aab5a90" compoundref="BFB__initialization_8F90" startline="80" endline="170">bfb_initialize_sponges_southonly</referencedby>
        <referencedby refid="namespacebfb__initialization_1a4c4812e80bffdd0501b93c123503d913" compoundref="BFB__initialization_8F90" startline="39" endline="74">bfb_set_coord</referencedby>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Initialization of the boundary-forced-basing configuration. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/user/BFB_initialization.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
