<?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.14">
  <compounddef id="structdumbbell__surface__forcing_1_1dumbbell__surface__forcing__cs" kind="type" language="Fortran" prot="public">
    <compoundname>dumbbell_surface_forcing::dumbbell_surface_forcing_cs</compoundname>
      <sectiondef kind="public-attrib">
      <memberdef kind="variable" id="structdumbbell__surface__forcing_1_1dumbbell__surface__forcing__cs_1a28a4aad1cd356a8a569bc6209e22219a" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical dumbbell_surface_forcing::dumbbell_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/dumbbell_surface_forcing.F90" line="27" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dumbbell_surface_forcing.F90" bodystart="27" bodyend="27"/>
      </memberdef>
      <memberdef kind="variable" id="structdumbbell__surface__forcing_1_1dumbbell__surface__forcing__cs_1a78f6e09b7ff4bb597a0289686e8dc611" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical dumbbell_surface_forcing::dumbbell_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/dumbbell_surface_forcing.F90" line="28" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dumbbell_surface_forcing.F90" bodystart="28" bodyend="28"/>
      </memberdef>
      <memberdef kind="variable" id="structdumbbell__surface__forcing_1_1dumbbell__surface__forcing__cs_1a8c2030b12953198e71131e63854deb1e" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real dumbbell_surface_forcing::dumbbell_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/dumbbell_surface_forcing.F90" line="29" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dumbbell_surface_forcing.F90" bodystart="29" bodyend="29"/>
      </memberdef>
      <memberdef kind="variable" id="structdumbbell__surface__forcing_1_1dumbbell__surface__forcing__cs_1ae10f2b13b3e6c0eae95b30e752183eec" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real dumbbell_surface_forcing::dumbbell_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/dumbbell_surface_forcing.F90" line="30" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dumbbell_surface_forcing.F90" bodystart="30" bodyend="30"/>
      </memberdef>
      <memberdef kind="variable" id="structdumbbell__surface__forcing_1_1dumbbell__surface__forcing__cs_1a08f4cf03c500a2f4521addca33f4230d" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real dumbbell_surface_forcing::dumbbell_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/dumbbell_surface_forcing.F90" line="31" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dumbbell_surface_forcing.F90" bodystart="31" bodyend="31"/>
      </memberdef>
      <memberdef kind="variable" id="structdumbbell__surface__forcing_1_1dumbbell__surface__forcing__cs_1af96a0283b9442a7e58c64d5539b7606d" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real dumbbell_surface_forcing::dumbbell_surface_forcing_cs::slp_amplitude</definition>
        <argsstring></argsstring>
        <name>slp_amplitude</name>
        <briefdescription>
<para>The amplitude of pressure loading [R L2 T-2 ~&gt; Pa] applied to the reservoirs. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/dumbbell_surface_forcing.F90" line="34" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dumbbell_surface_forcing.F90" bodystart="34" bodyend="34"/>
      </memberdef>
      <memberdef kind="variable" id="structdumbbell__surface__forcing_1_1dumbbell__surface__forcing__cs_1a7c7849fedc366b7c71fbda8fe20d87b0" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real dumbbell_surface_forcing::dumbbell_surface_forcing_cs::slp_period</definition>
        <argsstring></argsstring>
        <name>slp_period</name>
        <briefdescription>
<para>Period of sinusoidal pressure wave [days]. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/dumbbell_surface_forcing.F90" line="36" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dumbbell_surface_forcing.F90" bodystart="36" bodyend="36"/>
      </memberdef>
      <memberdef kind="variable" id="structdumbbell__surface__forcing_1_1dumbbell__surface__forcing__cs_1a5eec78da4be31359bc38d420e231868d" prot="public" static="no" mutable="no">
        <type>real, dimension(:,:), allocatable</type>
        <definition>real, dimension(:,:), allocatable dumbbell_surface_forcing::dumbbell_surface_forcing_cs::forcing_mask</definition>
        <argsstring></argsstring>
        <name>forcing_mask</name>
        <briefdescription>
<para>A mask regulating where forcing occurs. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/dumbbell_surface_forcing.F90" line="37" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dumbbell_surface_forcing.F90" bodystart="37" bodyend="38"/>
      </memberdef>
      <memberdef kind="variable" id="structdumbbell__surface__forcing_1_1dumbbell__surface__forcing__cs_1ae793870abdd5dd3b5bbbdba10fac3271" prot="public" static="no" mutable="no">
        <type>real, dimension(:,:), allocatable</type>
        <definition>real, dimension(:,:), allocatable dumbbell_surface_forcing::dumbbell_surface_forcing_cs::s_restore</definition>
        <argsstring></argsstring>
        <name>s_restore</name>
        <briefdescription>
<para>The surface salinity field toward which to restore [ppt]. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/dumbbell_surface_forcing.F90" line="39" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dumbbell_surface_forcing.F90" bodystart="39" bodyend="40"/>
      </memberdef>
      <memberdef kind="variable" id="structdumbbell__surface__forcing_1_1dumbbell__surface__forcing__cs_1a2a2e468953193fe2aa81bdaf39a3794a" prot="public" static="no" mutable="no">
        <type>type(diag_ctrl), pointer</type>
        <definition>type(diag_ctrl), pointer dumbbell_surface_forcing::dumbbell_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/dumbbell_surface_forcing.F90" line="41" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dumbbell_surface_forcing.F90" bodystart="41" bodyend="41"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Control structure for the dumbbell test case forcing. </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <collaborationgraph>
      <node id="407">
        <label>real</label>
      </node>
      <node id="404">
        <label>dumbbell_surface_forcing::dumbbell_surface_forcing_cs</label>
        <link refid="structdumbbell__surface__forcing_1_1dumbbell__surface__forcing__cs"/>
        <childnode refid="405" relation="usage">
          <edgelabel>restorebuoy</edgelabel>
          <edgelabel>use_temperature</edgelabel>
        </childnode>
        <childnode refid="406" relation="usage">
          <edgelabel>diag</edgelabel>
        </childnode>
        <childnode refid="407" relation="usage">
          <edgelabel>slp_amplitude</edgelabel>
          <edgelabel>flux_const</edgelabel>
          <edgelabel>slp_period</edgelabel>
          <edgelabel>rho0</edgelabel>
          <edgelabel>forcing_mask</edgelabel>
          <edgelabel>s_restore</edgelabel>
          <edgelabel>g_earth</edgelabel>
        </childnode>
      </node>
      <node id="405">
        <label>logical</label>
      </node>
      <node id="406">
        <label>diag_ctrl</label>
      </node>
    </collaborationgraph>
    <location file="/home/cermak/src/MOM6.devrob/src/user/dumbbell_surface_forcing.F90" line="26" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dumbbell_surface_forcing.F90" bodystart="26" bodyend="43"/>
    <listofallmembers>
      <member refid="structdumbbell__surface__forcing_1_1dumbbell__surface__forcing__cs_1a2a2e468953193fe2aa81bdaf39a3794a" prot="public" virt="non-virtual"><scope>dumbbell_surface_forcing::dumbbell_surface_forcing_cs</scope><name>diag</name></member>
      <member refid="structdumbbell__surface__forcing_1_1dumbbell__surface__forcing__cs_1a08f4cf03c500a2f4521addca33f4230d" prot="public" virt="non-virtual"><scope>dumbbell_surface_forcing::dumbbell_surface_forcing_cs</scope><name>flux_const</name></member>
      <member refid="structdumbbell__surface__forcing_1_1dumbbell__surface__forcing__cs_1a5eec78da4be31359bc38d420e231868d" prot="public" virt="non-virtual"><scope>dumbbell_surface_forcing::dumbbell_surface_forcing_cs</scope><name>forcing_mask</name></member>
      <member refid="structdumbbell__surface__forcing_1_1dumbbell__surface__forcing__cs_1ae10f2b13b3e6c0eae95b30e752183eec" prot="public" virt="non-virtual"><scope>dumbbell_surface_forcing::dumbbell_surface_forcing_cs</scope><name>g_earth</name></member>
      <member refid="structdumbbell__surface__forcing_1_1dumbbell__surface__forcing__cs_1a78f6e09b7ff4bb597a0289686e8dc611" prot="public" virt="non-virtual"><scope>dumbbell_surface_forcing::dumbbell_surface_forcing_cs</scope><name>restorebuoy</name></member>
      <member refid="structdumbbell__surface__forcing_1_1dumbbell__surface__forcing__cs_1a8c2030b12953198e71131e63854deb1e" prot="public" virt="non-virtual"><scope>dumbbell_surface_forcing::dumbbell_surface_forcing_cs</scope><name>rho0</name></member>
      <member refid="structdumbbell__surface__forcing_1_1dumbbell__surface__forcing__cs_1ae793870abdd5dd3b5bbbdba10fac3271" prot="public" virt="non-virtual"><scope>dumbbell_surface_forcing::dumbbell_surface_forcing_cs</scope><name>s_restore</name></member>
      <member refid="structdumbbell__surface__forcing_1_1dumbbell__surface__forcing__cs_1af96a0283b9442a7e58c64d5539b7606d" prot="public" virt="non-virtual"><scope>dumbbell_surface_forcing::dumbbell_surface_forcing_cs</scope><name>slp_amplitude</name></member>
      <member refid="structdumbbell__surface__forcing_1_1dumbbell__surface__forcing__cs_1a7c7849fedc366b7c71fbda8fe20d87b0" prot="public" virt="non-virtual"><scope>dumbbell_surface_forcing::dumbbell_surface_forcing_cs</scope><name>slp_period</name></member>
      <member refid="structdumbbell__surface__forcing_1_1dumbbell__surface__forcing__cs_1a28a4aad1cd356a8a569bc6209e22219a" prot="public" virt="non-virtual"><scope>dumbbell_surface_forcing::dumbbell_surface_forcing_cs</scope><name>use_temperature</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
