<?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="namespacesloshing__initialization" kind="namespace" language="Fortran">
    <compoundname>sloshing_initialization</compoundname>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacesloshing__initialization_1a0ecf019d4e63415fc16ce5ca4158f7f3" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public sloshing_initialization::sloshing_initialize_topography</definition>
        <argsstring>(D, G, param_file, max_depth)</argsstring>
        <name>sloshing_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/sloshing_initialization.F90" line="31" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/sloshing_initialization.F90" bodystart="32" bodyend="44"/>
        <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="namespacesloshing__initialization_1a5f999277fd41bc2730d6ef1dffffdb59" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public sloshing_initialization::sloshing_initialize_thickness</definition>
        <argsstring>(h, G, GV, US, param_file, just_read_params)</argsstring>
        <name>sloshing_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>Initialization of thicknesses This routine is called when THICKNESS_CONFIG is set to &apos;sloshing&apos;. </para>        </briefdescription>
        <detaileddescription>
<para>This routine initializes layer positions to set off a sloshing motion in the zonal direction in a rectangular basin. All layers have initially the same thickness but all interfaces (except bottom and sea surface) are displaced according to a half-period cosine, with maximum value on the left and minimum value on the right. This sets off a regular sloshing motion.</para><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/sloshing_initialization.F90" line="56" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/sloshing_initialization.F90" bodystart="57" bodyend="169"/>
      </memberdef>
      <memberdef kind="function" id="namespacesloshing__initialization_1a7806e9a52f01ac49906e7285e2c2bb3b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public sloshing_initialization::sloshing_initialize_temperature_salinity</definition>
        <argsstring>(T, S, h, G, GV, param_file, eqn_of_state, just_read_params)</argsstring>
        <name>sloshing_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>Initialization of temperature and salinity. </para>        </briefdescription>
        <detaileddescription>
<para>This subroutine initializes linear profiles for T and S according to reference surface layer salinity and temperature and a specified range. Note that the linear distribution is set up with respect to the layer number, not the physical position).</para><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>The ocean&apos;s 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>A structure indicating the open file to parse for model parameter values.</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/sloshing_initialization.F90" line="179" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/sloshing_initialization.F90" bodystart="181" bodyend="250"/>
        <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 for the &quot;sloshing&quot; internal waves configuration. </para>    </briefdescription>
    <detaileddescription>
<para>The module configures the model for the non-rotating sloshing test case. </para>    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/user/sloshing_initialization.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
