<?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.13">
  <compounddef id="structuser__surface__forcing_1_1user__surface__forcing__cs" kind="type" language="Fortran" prot="public">
    <compoundname>user_surface_forcing::user_surface_forcing_cs</compoundname>
      <sectiondef kind="public-attrib">
      <memberdef kind="variable" id="structuser__surface__forcing_1_1user__surface__forcing__cs_1a5698ed77f97ac92c4bfebef34fde9112" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical user_surface_forcing::user_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/config_src/solo_driver/user_surface_forcing.F90" line="34" column="1" bodyfile="/home/cermak/src/MOM6.devrob/config_src/solo_driver/user_surface_forcing.F90" bodystart="34" bodyend="34"/>
      </memberdef>
      <memberdef kind="variable" id="structuser__surface__forcing_1_1user__surface__forcing__cs_1a60f2f5986996da2123599e98fb7ec69d" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical user_surface_forcing::user_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/config_src/solo_driver/user_surface_forcing.F90" line="35" column="1" bodyfile="/home/cermak/src/MOM6.devrob/config_src/solo_driver/user_surface_forcing.F90" bodystart="35" bodyend="35"/>
      </memberdef>
      <memberdef kind="variable" id="structuser__surface__forcing_1_1user__surface__forcing__cs_1a43f0a904949433b92fd4bdfb928ddc18" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real user_surface_forcing::user_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/config_src/solo_driver/user_surface_forcing.F90" line="36" column="1" bodyfile="/home/cermak/src/MOM6.devrob/config_src/solo_driver/user_surface_forcing.F90" bodystart="36" bodyend="36"/>
      </memberdef>
      <memberdef kind="variable" id="structuser__surface__forcing_1_1user__surface__forcing__cs_1a6e8efdbcbd5da036365f9107d16bd6ce" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real user_surface_forcing::user_surface_forcing_cs::g_earth</definition>
        <argsstring></argsstring>
        <name>g_earth</name>
        <briefdescription>
<para>The gravitational acceleration [L2 Z-1 s-2 ~&gt; m s-2]. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/config_src/solo_driver/user_surface_forcing.F90" line="37" column="1" bodyfile="/home/cermak/src/MOM6.devrob/config_src/solo_driver/user_surface_forcing.F90" bodystart="37" bodyend="37"/>
      </memberdef>
      <memberdef kind="variable" id="structuser__surface__forcing_1_1user__surface__forcing__cs_1acb400174bd3d123baca84a15ee7f1a76" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real user_surface_forcing::user_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/config_src/solo_driver/user_surface_forcing.F90" line="38" column="1" bodyfile="/home/cermak/src/MOM6.devrob/config_src/solo_driver/user_surface_forcing.F90" bodystart="38" bodyend="38"/>
      </memberdef>
      <memberdef kind="variable" id="structuser__surface__forcing_1_1user__surface__forcing__cs_1a5dcc9dd4140027d7f789d1746eea99a9" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real user_surface_forcing::user_surface_forcing_cs::gust_const</definition>
        <argsstring></argsstring>
        <name>gust_const</name>
        <briefdescription>
<para>A constant unresolved background gustiness that contributes to ustar [R L Z T-1 ~&gt; Pa]. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/config_src/solo_driver/user_surface_forcing.F90" line="39" column="1" bodyfile="/home/cermak/src/MOM6.devrob/config_src/solo_driver/user_surface_forcing.F90" bodystart="39" bodyend="39"/>
      </memberdef>
      <memberdef kind="variable" id="structuser__surface__forcing_1_1user__surface__forcing__cs_1a5f642d3fe218315f6b1f9b7d926db18c" prot="public" static="no" mutable="no">
        <type>type(diag_ctrl), pointer</type>
        <definition>type(diag_ctrl), pointer user_surface_forcing::user_surface_forcing_cs::diag</definition>
        <argsstring></argsstring>
        <name>diag</name>
        <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/config_src/solo_driver/user_surface_forcing.F90" line="42" column="1" bodyfile="/home/cermak/src/MOM6.devrob/config_src/solo_driver/user_surface_forcing.F90" bodystart="42" bodyend="42"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>This control structure should be used to store any run-time variables associated with the user-specified forcing. </para>    </briefdescription>
    <detaileddescription>
<para>It can be readily modified for a specific case, and because it is private there will be no changes needed in other code (although they will have to be recompiled). </para>    </detaileddescription>
    <collaborationgraph>
      <node id="1487">
        <label>real</label>
      </node>
      <node id="1485">
        <label>logical</label>
      </node>
      <node id="1484">
        <label>user_surface_forcing::user_surface_forcing_cs</label>
        <link refid="structuser__surface__forcing_1_1user__surface__forcing__cs"/>
        <childnode refid="1485" relation="usage">
          <edgelabel>restorebuoy</edgelabel>
          <edgelabel>use_temperature</edgelabel>
        </childnode>
        <childnode refid="1486" relation="usage">
          <edgelabel>diag</edgelabel>
        </childnode>
        <childnode refid="1487" relation="usage">
          <edgelabel>flux_const</edgelabel>
          <edgelabel>gust_const</edgelabel>
          <edgelabel>rho0</edgelabel>
          <edgelabel>g_earth</edgelabel>
        </childnode>
      </node>
      <node id="1486">
        <label>diag_ctrl</label>
      </node>
    </collaborationgraph>
    <location file="/home/cermak/src/MOM6.devrob/config_src/solo_driver/user_surface_forcing.F90" line="30" column="1" bodyfile="/home/cermak/src/MOM6.devrob/config_src/solo_driver/user_surface_forcing.F90" bodystart="30" bodyend="44"/>
    <listofallmembers>
      <member refid="structuser__surface__forcing_1_1user__surface__forcing__cs_1a5f642d3fe218315f6b1f9b7d926db18c" prot="public" virt="non-virtual"><scope>user_surface_forcing::user_surface_forcing_cs</scope><name>diag</name></member>
      <member refid="structuser__surface__forcing_1_1user__surface__forcing__cs_1acb400174bd3d123baca84a15ee7f1a76" prot="public" virt="non-virtual"><scope>user_surface_forcing::user_surface_forcing_cs</scope><name>flux_const</name></member>
      <member refid="structuser__surface__forcing_1_1user__surface__forcing__cs_1a6e8efdbcbd5da036365f9107d16bd6ce" prot="public" virt="non-virtual"><scope>user_surface_forcing::user_surface_forcing_cs</scope><name>g_earth</name></member>
      <member refid="structuser__surface__forcing_1_1user__surface__forcing__cs_1a5dcc9dd4140027d7f789d1746eea99a9" prot="public" virt="non-virtual"><scope>user_surface_forcing::user_surface_forcing_cs</scope><name>gust_const</name></member>
      <member refid="structuser__surface__forcing_1_1user__surface__forcing__cs_1a60f2f5986996da2123599e98fb7ec69d" prot="public" virt="non-virtual"><scope>user_surface_forcing::user_surface_forcing_cs</scope><name>restorebuoy</name></member>
      <member refid="structuser__surface__forcing_1_1user__surface__forcing__cs_1a43f0a904949433b92fd4bdfb928ddc18" prot="public" virt="non-virtual"><scope>user_surface_forcing::user_surface_forcing_cs</scope><name>rho0</name></member>
      <member refid="structuser__surface__forcing_1_1user__surface__forcing__cs_1a5698ed77f97ac92c4bfebef34fde9112" prot="public" virt="non-virtual"><scope>user_surface_forcing::user_surface_forcing_cs</scope><name>use_temperature</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
