<?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.16">
  <compounddef id="namespacedumbbell__initialization" kind="namespace" language="Fortran">
    <compoundname>dumbbell_initialization</compoundname>
      <sectiondef kind="var">
      <memberdef kind="variable" id="namespacedumbbell__initialization_1a1a1ee45454d965674b4dfa06cccf4403" prot="private" static="no" mutable="no">
        <type><ref refid="version__variable_8h_1acda997fe1761de4c6bca0f27dc786964" kindref="member">character</ref>(len=40)</type>
        <definition>character(len=40) dumbbell_initialization::mdl</definition>
        <argsstring></argsstring>
        <name>mdl</name>
        <initializer>= &quot;dumbbell_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/dumbbell_initialization.F90" line="27" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dumbbell_initialization.F90" bodystart="27" bodyend="27"/>
        <referencedby refid="namespacedumbbell__initialization_1a13361a11ddf3cb55689b7899f281c273" compoundref="dumbbell__initialization_8F90" startline="288" endline="397">dumbbell_initialize_sponges</referencedby>
        <referencedby refid="namespacedumbbell__initialization_1ab755e35e9e8cda3c40922930ccf595f8" compoundref="dumbbell__initialization_8F90" startline="212" endline="283">dumbbell_initialize_temperature_salinity</referencedby>
        <referencedby refid="namespacedumbbell__initialization_1a265452b61d468b64683545f2bf0cf2c6" compoundref="dumbbell__initialization_8F90" startline="94" endline="206">dumbbell_initialize_thickness</referencedby>
        <referencedby refid="namespacedumbbell__initialization_1aba31e0ec02e4c1c0e5987d8843be5e76" compoundref="dumbbell__initialization_8F90" startline="43" endline="89">dumbbell_initialize_topography</referencedby>
      </memberdef>
      </sectiondef>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacedumbbell__initialization_1aba31e0ec02e4c1c0e5987d8843be5e76" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public dumbbell_initialization::dumbbell_initialize_topography</definition>
        <argsstring>(D, G, param_file, max_depth)</argsstring>
        <name>dumbbell_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>
        <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 the units of depth_max </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 ocean depth in arbitrary units </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/dumbbell_initialization.F90" line="42" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dumbbell_initialization.F90" bodystart="43" bodyend="89"/>
        <references refid="namespacedumbbell__initialization_1a1a1ee45454d965674b4dfa06cccf4403" compoundref="dumbbell__initialization_8F90" startline="27" endline="27">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="namespacedumbbell__initialization_1a265452b61d468b64683545f2bf0cf2c6" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public dumbbell_initialization::dumbbell_initialize_thickness</definition>
        <argsstring>(h, G, GV, US, param_file, just_read_params)</argsstring>
        <name>dumbbell_initialize_thickness</name>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <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>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>just_read_params</type>
          <defname>just_read_params</defname>
        </param>
        <briefdescription>
<para>Initializes the layer thicknesses to be uniform in the dumbbell test case. </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="out">h</parametername>
</parameternamelist>
<parameterdescription>
<para>The thickness that is being initialized [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<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>
<parameteritem>
<parameternamelist>
<parametername direction="in">just_read_params</parametername>
</parameternamelist>
<parameterdescription>
<para>If present and true, this call will only read parameters without changing h. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/dumbbell_initialization.F90" line="93" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dumbbell_initialization.F90" bodystart="94" bodyend="206"/>
        <references refid="namespacedumbbell__initialization_1a1a1ee45454d965674b4dfa06cccf4403" compoundref="dumbbell__initialization_8F90" startline="27" endline="27">mdl</references>
        <references refid="namespacemom__error__handler_1a1c462df7b61f1296407b4af51dfeceab" compoundref="MOM__error__handler_8F90" startline="53" endline="66">mom_error_handler::mom_mesg</references>
        <references refid="namespaceregrid__consts_1aef4186522ded3d18e67d332fddde5ea4" compoundref="regrid__consts_8F90" startline="15" endline="15">regrid_consts::regridding_rho</references>
        <references refid="namespaceregrid__consts_1acaaaed0d987a75852f7ef3d371e74094" compoundref="regrid__consts_8F90" startline="16" endline="16">regrid_consts::regridding_sigma</references>
      </memberdef>
      <memberdef kind="function" id="namespacedumbbell__initialization_1ab755e35e9e8cda3c40922930ccf595f8" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public dumbbell_initialization::dumbbell_initialize_temperature_salinity</definition>
        <argsstring>(T, S, h, G, GV, param_file, eqn_of_state, just_read_params)</argsstring>
        <name>dumbbell_initialize_temperature_salinity</name>
        <param>
          <type>T</type>
          <defname>T</defname>
        </param>
        <param>
          <type>S</type>
          <defname>S</defname>
        </param>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>eqn_of_state</type>
          <defname>eqn_of_state</defname>
        </param>
        <param>
          <type>just_read_params</type>
          <defname>just_read_params</defname>
        </param>
        <briefdescription>
<para>Initial values for temperature and salinity for the dumbbell test case. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean grid structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>Vertical grid structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">t</parametername>
</parameternamelist>
<parameterdescription>
<para>Potential temperature [degC] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">s</parametername>
</parameternamelist>
<parameterdescription>
<para>Salinity [ppt] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thickness [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>Parameter file structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>eqn_of_state</parametername>
</parameternamelist>
<parameterdescription>
<para>Equation of state structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">just_read_params</parametername>
</parameternamelist>
<parameterdescription>
<para>If present and true, this call will only read parameters without changing h. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/dumbbell_initialization.F90" line="210" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dumbbell_initialization.F90" bodystart="212" bodyend="283"/>
        <references refid="namespacedumbbell__initialization_1a1a1ee45454d965674b4dfa06cccf4403" compoundref="dumbbell__initialization_8F90" startline="27" endline="27">mdl</references>
      </memberdef>
      <memberdef kind="function" id="namespacedumbbell__initialization_1a13361a11ddf3cb55689b7899f281c273" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public dumbbell_initialization::dumbbell_initialize_sponges</definition>
        <argsstring>(G, GV, US, tv, param_file, use_ALE, CSp, ACSp)</argsstring>
        <name>dumbbell_initialize_sponges</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>tv</type>
          <defname>tv</defname>
        </param>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>use_ALE</type>
          <defname>use_ALE</defname>
        </param>
        <param>
          <type>CSp</type>
          <defname>CSp</defname>
        </param>
        <param>
          <type>ACSp</type>
          <defname>ACSp</defname>
        </param>
        <briefdescription>
<para>Initialize the restoring sponges for the dumbbell test case. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Horizontal grid control structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>Vertical grid control 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">tv</parametername>
</parameternamelist>
<parameterdescription>
<para>Thermodynamic variables </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">use_ale</parametername>
</parameternamelist>
<parameterdescription>
<para>ALE flag </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>csp</parametername>
</parameternamelist>
<parameterdescription>
<para>Layered sponge control structure pointer </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>acsp</parametername>
</parameternamelist>
<parameterdescription>
<para>ALE sponge control structure pointer </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/dumbbell_initialization.F90" line="287" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dumbbell_initialization.F90" bodystart="288" bodyend="397"/>
        <references refid="namespacedumbbell__initialization_1a1a1ee45454d965674b4dfa06cccf4403" compoundref="dumbbell__initialization_8F90" startline="27" endline="27">mdl</references>
        <referencedby refid="namespacemom__state__initialization_1a81503d4f1855cb185f122d6314e4f06c" compoundref="MOM__state__initialization_8F90" startline="117" endline="615">mom_state_initialization::mom_initialize_state</referencedby>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Configures the model for the idealized dumbbell test case. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/user/dumbbell_initialization.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
