<?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="structbfb__surface__forcing_1_1bfb__surface__forcing__cs" kind="type" language="Fortran" prot="public">
    <compoundname>bfb_surface_forcing::bfb_surface_forcing_cs</compoundname>
      <sectiondef kind="public-attrib">
      <memberdef kind="variable" id="structbfb__surface__forcing_1_1bfb__surface__forcing__cs_1a9d8298f0d9baa4dbc7ef067a88473c1b" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical bfb_surface_forcing::bfb_surface_forcing_cs::use_temperature</definition>
        <argsstring></argsstring>
        <name>use_temperature</name>
        <briefdescription>
<para>If true, temperature and salinity are used as state variables. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" line="28" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" bodystart="28" bodyend="28"/>
      </memberdef>
      <memberdef kind="variable" id="structbfb__surface__forcing_1_1bfb__surface__forcing__cs_1a995fa1e7f0f02afa1a731ccce03cb1ba" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical bfb_surface_forcing::bfb_surface_forcing_cs::restorebuoy</definition>
        <argsstring></argsstring>
        <name>restorebuoy</name>
        <briefdescription>
<para>If true, use restoring surface buoyancy forcing. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" line="29" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" bodystart="29" bodyend="29"/>
      </memberdef>
      <memberdef kind="variable" id="structbfb__surface__forcing_1_1bfb__surface__forcing__cs_1acf4ead44cf324cb1798d27abfc03def4" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real bfb_surface_forcing::bfb_surface_forcing_cs::rho0</definition>
        <argsstring></argsstring>
        <name>rho0</name>
        <briefdescription>
<para>The density used in the Boussinesq approximation [R ~&gt; kg m-3]. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" line="30" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" bodystart="30" bodyend="30"/>
      </memberdef>
      <memberdef kind="variable" id="structbfb__surface__forcing_1_1bfb__surface__forcing__cs_1a5b2bdb89b0cef7a04cfc47274ca492ca" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real bfb_surface_forcing::bfb_surface_forcing_cs::g_earth</definition>
        <argsstring></argsstring>
        <name>g_earth</name>
        <briefdescription>
<para>The gravitational acceleration [L2 Z-1 T-2 ~&gt; m s-2]. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" line="31" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" bodystart="31" bodyend="31"/>
      </memberdef>
      <memberdef kind="variable" id="structbfb__surface__forcing_1_1bfb__surface__forcing__cs_1aebaf2725d4613951b70b7281c1674800" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real bfb_surface_forcing::bfb_surface_forcing_cs::flux_const</definition>
        <argsstring></argsstring>
        <name>flux_const</name>
        <briefdescription>
<para>The restoring rate at the surface [Z T-1 ~&gt; m s-1]. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" line="32" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" bodystart="32" bodyend="32"/>
      </memberdef>
      <memberdef kind="variable" id="structbfb__surface__forcing_1_1bfb__surface__forcing__cs_1a11a488f46f527f9b66726e7af8f09731" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real bfb_surface_forcing::bfb_surface_forcing_cs::gust_const</definition>
        <argsstring></argsstring>
        <name>gust_const</name>
        <briefdescription>
<para>A constant unresolved background gustiness that contributes to ustar [Pa]. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" line="33" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" bodystart="33" bodyend="33"/>
      </memberdef>
      <memberdef kind="variable" id="structbfb__surface__forcing_1_1bfb__surface__forcing__cs_1a62398fd7c3014e6a3ac9e48e131cedbd" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real bfb_surface_forcing::bfb_surface_forcing_cs::sst_s</definition>
        <argsstring></argsstring>
        <name>sst_s</name>
        <briefdescription>
<para>SST at the southern edge of the linear forcing ramp [degC]. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" line="35" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" bodystart="35" bodyend="35"/>
      </memberdef>
      <memberdef kind="variable" id="structbfb__surface__forcing_1_1bfb__surface__forcing__cs_1ae438d1a88e31a92e35b1691e3f00daaa" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real bfb_surface_forcing::bfb_surface_forcing_cs::sst_n</definition>
        <argsstring></argsstring>
        <name>sst_n</name>
        <briefdescription>
<para>SST at the northern edge of the linear forcing ramp [degC]. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" line="36" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" bodystart="36" bodyend="36"/>
      </memberdef>
      <memberdef kind="variable" id="structbfb__surface__forcing_1_1bfb__surface__forcing__cs_1a2cca416165fb576986e953c6e40a09ff" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real bfb_surface_forcing::bfb_surface_forcing_cs::lfrslat</definition>
        <argsstring></argsstring>
        <name>lfrslat</name>
        <briefdescription>
<para>Southern latitude where the linear forcing ramp begins [degLat]. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" line="37" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" bodystart="37" bodyend="37"/>
      </memberdef>
      <memberdef kind="variable" id="structbfb__surface__forcing_1_1bfb__surface__forcing__cs_1a280a34ff4218c35b00f58342bcd246a7" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real bfb_surface_forcing::bfb_surface_forcing_cs::lfrnlat</definition>
        <argsstring></argsstring>
        <name>lfrnlat</name>
        <briefdescription>
<para>Northern latitude where the linear forcing ramp ends [degLat]. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" line="38" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" bodystart="38" bodyend="38"/>
      </memberdef>
      <memberdef kind="variable" id="structbfb__surface__forcing_1_1bfb__surface__forcing__cs_1aab9a1d93a105f6fb9a19e17e3bd52d81" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real bfb_surface_forcing::bfb_surface_forcing_cs::drho_dt</definition>
        <argsstring></argsstring>
        <name>drho_dt</name>
        <briefdescription>
<para>Rate of change of density with temperature [R degC-1 ~&gt; kg m-3 degC-1]. Note that temperature is being used as a dummy variable here. All temperatures are converted into density. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" line="39" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" bodystart="39" bodyend="39"/>
      </memberdef>
      <memberdef kind="variable" id="structbfb__surface__forcing_1_1bfb__surface__forcing__cs_1afd9ff45c707bb6648c86183815106bc4" prot="public" static="no" mutable="no">
        <type>type(diag_ctrl), pointer</type>
        <definition>type(diag_ctrl), pointer bfb_surface_forcing::bfb_surface_forcing_cs::diag</definition>
        <argsstring></argsstring>
        <name>diag</name>
        <initializer>=&gt; NULL()</initializer>
        <briefdescription>
<para>A structure that is used to regulate the timing of diagnostic output. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" line="43" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" bodystart="43" bodyend="43"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Control structure for BFB_surface_forcing. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <collaborationgraph>
      <node id="4">
        <label>real</label>
      </node>
      <node id="2">
        <label>logical</label>
      </node>
      <node id="1">
        <label>bfb_surface_forcing::bfb_surface_forcing_cs</label>
        <link refid="structbfb__surface__forcing_1_1bfb__surface__forcing__cs"/>
        <childnode refid="2" relation="usage">
          <edgelabel>restorebuoy</edgelabel>
          <edgelabel>use_temperature</edgelabel>
        </childnode>
        <childnode refid="3" relation="usage">
          <edgelabel>diag</edgelabel>
        </childnode>
        <childnode refid="4" relation="usage">
          <edgelabel>sst_s</edgelabel>
          <edgelabel>lfrnlat</edgelabel>
          <edgelabel>flux_const</edgelabel>
          <edgelabel>gust_const</edgelabel>
          <edgelabel>drho_dt</edgelabel>
          <edgelabel>sst_n</edgelabel>
          <edgelabel>rho0</edgelabel>
          <edgelabel>lfrslat</edgelabel>
          <edgelabel>g_earth</edgelabel>
        </childnode>
      </node>
      <node id="3">
        <label>diag_ctrl</label>
      </node>
    </collaborationgraph>
    <location file="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" line="26" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/BFB_surface_forcing.F90" bodystart="26" bodyend="45"/>
    <listofallmembers>
      <member refid="structbfb__surface__forcing_1_1bfb__surface__forcing__cs_1afd9ff45c707bb6648c86183815106bc4" prot="public" virt="non-virtual"><scope>bfb_surface_forcing::bfb_surface_forcing_cs</scope><name>diag</name></member>
      <member refid="structbfb__surface__forcing_1_1bfb__surface__forcing__cs_1aab9a1d93a105f6fb9a19e17e3bd52d81" prot="public" virt="non-virtual"><scope>bfb_surface_forcing::bfb_surface_forcing_cs</scope><name>drho_dt</name></member>
      <member refid="structbfb__surface__forcing_1_1bfb__surface__forcing__cs_1aebaf2725d4613951b70b7281c1674800" prot="public" virt="non-virtual"><scope>bfb_surface_forcing::bfb_surface_forcing_cs</scope><name>flux_const</name></member>
      <member refid="structbfb__surface__forcing_1_1bfb__surface__forcing__cs_1a5b2bdb89b0cef7a04cfc47274ca492ca" prot="public" virt="non-virtual"><scope>bfb_surface_forcing::bfb_surface_forcing_cs</scope><name>g_earth</name></member>
      <member refid="structbfb__surface__forcing_1_1bfb__surface__forcing__cs_1a11a488f46f527f9b66726e7af8f09731" prot="public" virt="non-virtual"><scope>bfb_surface_forcing::bfb_surface_forcing_cs</scope><name>gust_const</name></member>
      <member refid="structbfb__surface__forcing_1_1bfb__surface__forcing__cs_1a280a34ff4218c35b00f58342bcd246a7" prot="public" virt="non-virtual"><scope>bfb_surface_forcing::bfb_surface_forcing_cs</scope><name>lfrnlat</name></member>
      <member refid="structbfb__surface__forcing_1_1bfb__surface__forcing__cs_1a2cca416165fb576986e953c6e40a09ff" prot="public" virt="non-virtual"><scope>bfb_surface_forcing::bfb_surface_forcing_cs</scope><name>lfrslat</name></member>
      <member refid="structbfb__surface__forcing_1_1bfb__surface__forcing__cs_1a995fa1e7f0f02afa1a731ccce03cb1ba" prot="public" virt="non-virtual"><scope>bfb_surface_forcing::bfb_surface_forcing_cs</scope><name>restorebuoy</name></member>
      <member refid="structbfb__surface__forcing_1_1bfb__surface__forcing__cs_1acf4ead44cf324cb1798d27abfc03def4" prot="public" virt="non-virtual"><scope>bfb_surface_forcing::bfb_surface_forcing_cs</scope><name>rho0</name></member>
      <member refid="structbfb__surface__forcing_1_1bfb__surface__forcing__cs_1ae438d1a88e31a92e35b1691e3f00daaa" prot="public" virt="non-virtual"><scope>bfb_surface_forcing::bfb_surface_forcing_cs</scope><name>sst_n</name></member>
      <member refid="structbfb__surface__forcing_1_1bfb__surface__forcing__cs_1a62398fd7c3014e6a3ac9e48e131cedbd" prot="public" virt="non-virtual"><scope>bfb_surface_forcing::bfb_surface_forcing_cs</scope><name>sst_s</name></member>
      <member refid="structbfb__surface__forcing_1_1bfb__surface__forcing__cs_1a9d8298f0d9baa4dbc7ef067a88473c1b" prot="public" virt="non-virtual"><scope>bfb_surface_forcing::bfb_surface_forcing_cs</scope><name>use_temperature</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
