<?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="namespacedense__water__initialization" kind="namespace" language="Fortran">
    <compoundname>dense_water_initialization</compoundname>
      <sectiondef kind="var">
      <memberdef kind="variable" id="namespacedense__water__initialization_1a8996fccad16389cd1b688f83ebf3a630" prot="private" static="no" mutable="no">
        <type><ref refid="version__variable_8h_1acda997fe1761de4c6bca0f27dc786964" kindref="member">character</ref>(len=40)</type>
        <definition>character(len=40) dense_water_initialization::mdl</definition>
        <argsstring></argsstring>
        <name>mdl</name>
        <initializer>= &quot;dense_water_initialization&quot;</initializer>
        <briefdescription>
<para>Module name. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/dense_water_initialization.F90" line="26" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dense_water_initialization.F90" bodystart="26" bodyend="26"/>
        <referencedby refid="namespacedense__water__initialization_1aa663ab693084a07cf066806d6b529c14" compoundref="dense__water__initialization_8F90" startline="156" endline="285">dense_water_initialize_sponges</referencedby>
        <referencedby refid="namespacedense__water__initialization_1ae2a5062c406c66b1917f2ad564d4a5e6" compoundref="dense__water__initialization_8F90" startline="36" endline="94">dense_water_initialize_topography</referencedby>
        <referencedby refid="namespacedense__water__initialization_1a0e1384953bfbb302a7b93dd7abb6cb7b" compoundref="dense__water__initialization_8F90" startline="99" endline="151">dense_water_initialize_ts</referencedby>
      </memberdef>
      <memberdef kind="variable" id="namespacedense__water__initialization_1a2411cd7a7a8c202a345e66ae25a6f5a0" prot="private" static="no" mutable="no">
        <type>real, parameter</type>
        <definition>real, parameter dense_water_initialization::default_sill</definition>
        <argsstring></argsstring>
        <name>default_sill</name>
        <initializer>= 0.2</initializer>
        <briefdescription>
<para>Default depth of the sill [nondim]. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/dense_water_initialization.F90" line="28" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dense_water_initialization.F90" bodystart="28" bodyend="28"/>
        <referencedby refid="namespacedense__water__initialization_1aa663ab693084a07cf066806d6b529c14" compoundref="dense__water__initialization_8F90" startline="156" endline="285">dense_water_initialize_sponges</referencedby>
        <referencedby refid="namespacedense__water__initialization_1ae2a5062c406c66b1917f2ad564d4a5e6" compoundref="dense__water__initialization_8F90" startline="36" endline="94">dense_water_initialize_topography</referencedby>
      </memberdef>
      <memberdef kind="variable" id="namespacedense__water__initialization_1aa43e2347923c52d91a9ca2fc07b49949" prot="private" static="no" mutable="no">
        <type>real, parameter</type>
        <definition>real, parameter dense_water_initialization::default_shelf</definition>
        <argsstring></argsstring>
        <name>default_shelf</name>
        <initializer>= 0.4</initializer>
        <briefdescription>
<para>Default depth of the shelf [nondim]. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/dense_water_initialization.F90" line="29" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dense_water_initialization.F90" bodystart="29" bodyend="29"/>
        <referencedby refid="namespacedense__water__initialization_1ae2a5062c406c66b1917f2ad564d4a5e6" compoundref="dense__water__initialization_8F90" startline="36" endline="94">dense_water_initialize_topography</referencedby>
      </memberdef>
      <memberdef kind="variable" id="namespacedense__water__initialization_1a8dde2a4823fdb9aa5e4911dcb965176f" prot="private" static="no" mutable="no">
        <type>real, parameter</type>
        <definition>real, parameter dense_water_initialization::default_mld</definition>
        <argsstring></argsstring>
        <name>default_mld</name>
        <initializer>= 0.25</initializer>
        <briefdescription>
<para>Default depth of the mixed layer [nondim]. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/dense_water_initialization.F90" line="30" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dense_water_initialization.F90" bodystart="30" bodyend="30"/>
        <referencedby refid="namespacedense__water__initialization_1aa663ab693084a07cf066806d6b529c14" compoundref="dense__water__initialization_8F90" startline="156" endline="285">dense_water_initialize_sponges</referencedby>
        <referencedby refid="namespacedense__water__initialization_1a0e1384953bfbb302a7b93dd7abb6cb7b" compoundref="dense__water__initialization_8F90" startline="99" endline="151">dense_water_initialize_ts</referencedby>
      </memberdef>
      </sectiondef>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacedense__water__initialization_1ae2a5062c406c66b1917f2ad564d4a5e6" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public dense_water_initialization::dense_water_initialize_topography</definition>
        <argsstring>(D, G, param_file, max_depth)</argsstring>
        <name>dense_water_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>Initialize the topography field for the dense water experiment. </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/dense_water_initialization.F90" line="35" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dense_water_initialization.F90" bodystart="36" bodyend="94"/>
        <references refid="namespacedense__water__initialization_1aa43e2347923c52d91a9ca2fc07b49949" compoundref="dense__water__initialization_8F90" startline="29" endline="29">default_shelf</references>
        <references refid="namespacedense__water__initialization_1a2411cd7a7a8c202a345e66ae25a6f5a0" compoundref="dense__water__initialization_8F90" startline="28" endline="28">default_sill</references>
        <references refid="namespacedense__water__initialization_1a8996fccad16389cd1b688f83ebf3a630" compoundref="dense__water__initialization_8F90" startline="26" endline="26">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="namespacedense__water__initialization_1a0e1384953bfbb302a7b93dd7abb6cb7b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public dense_water_initialization::dense_water_initialize_ts</definition>
        <argsstring>(G, GV, param_file, eqn_of_state, T, S, h, just_read_params)</argsstring>
        <name>dense_water_initialize_ts</name>
        <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>T</type>
          <defname>T</defname>
        </param>
        <param>
          <type>S</type>
          <defname>S</defname>
        </param>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>just_read_params</type>
          <defname>just_read_params</defname>
        </param>
        <briefdescription>
<para>Initialize the temperature and salinity for the dense water experiment. </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">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>Parameter file structure</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>eqn_of_state</parametername>
</parameternamelist>
<parameterdescription>
<para>EOS structure</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">t</parametername>
</parameternamelist>
<parameterdescription>
<para>Output temperature [degC]</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">s</parametername>
</parameternamelist>
<parameterdescription>
<para>Output salinity [ppt]</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>
<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/dense_water_initialization.F90" line="98" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dense_water_initialization.F90" bodystart="99" bodyend="151"/>
        <references refid="namespacedense__water__initialization_1a8dde2a4823fdb9aa5e4911dcb965176f" compoundref="dense__water__initialization_8F90" startline="30" endline="30">default_mld</references>
        <references refid="namespacedense__water__initialization_1a8996fccad16389cd1b688f83ebf3a630" compoundref="dense__water__initialization_8F90" startline="26" endline="26">mdl</references>
      </memberdef>
      <memberdef kind="function" id="namespacedense__water__initialization_1aa663ab693084a07cf066806d6b529c14" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public dense_water_initialization::dense_water_initialize_sponges</definition>
        <argsstring>(G, GV, US, tv, param_file, use_ALE, CSp, ACSp)</argsstring>
        <name>dense_water_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 dense water experiment. </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/dense_water_initialization.F90" line="155" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dense_water_initialization.F90" bodystart="156" bodyend="285"/>
        <references refid="namespacedense__water__initialization_1a8dde2a4823fdb9aa5e4911dcb965176f" compoundref="dense__water__initialization_8F90" startline="30" endline="30">default_mld</references>
        <references refid="namespacedense__water__initialization_1a2411cd7a7a8c202a345e66ae25a6f5a0" compoundref="dense__water__initialization_8F90" startline="28" endline="28">default_sill</references>
        <references refid="namespacedense__water__initialization_1a8996fccad16389cd1b688f83ebf3a630" compoundref="dense__water__initialization_8F90" startline="26" endline="26">mdl</references>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</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>Initialization routines for the dense water formation and overflow experiment. </para>    </briefdescription>
    <detaileddescription>
<para>This experiment consists of a shelf accumulating dense water, which spills over an upward slope and a sill, before flowing down a slope into an open ocean region. It&apos;s intended as a test of one of the motivating situations for the adaptive coordinate.</para><para>The nondimensional widths of the 5 regions are controlled by the <computeroutput>DENSE_WATER_DOMAIN_PARAMS</computeroutput>, and the heights of the sill and shelf as a fraction of the total domain depth are controlled by <computeroutput>DENSE_WATER_SILL_HEIGHT</computeroutput> and <computeroutput>DENSE_WATER_SHELF_HEIGHT</computeroutput>.</para><para>The density in the domain is governed by a linear equation of state, and is set up with a mixed layer of non-dimensional depth <computeroutput>DENSE_WATER_MLD</computeroutput> below which there is a linear stratification from <computeroutput>S_REF</computeroutput>, increasing by <computeroutput>S_RANGE</computeroutput> to the bottom.</para><para>To force the experiment, there are sponges on the inflow and outflow of the domain. The inflow sponge has a salinity anomaly of <computeroutput>DENSE_WATER_EAST_SPONGE_SALT</computeroutput> through the entire depth. The outflow sponge simply restores to the initial condition. Both sponges have controllable widths and restoring timescales. </para>    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/user/dense_water_initialization.F90" line="3" column="1"/>
  </compounddef>
</doxygen>
