<?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.20" xml:lang="en-US">
  <compounddef id="namespacesoliton__initialization" kind="namespace" language="Fortran">
    <compoundname>soliton_initialization</compoundname>
      <sectiondef kind="var">
      <memberdef kind="variable" id="namespacesoliton__initialization_1abd5846899bb175c4e2c84986c6e4168b" prot="private" static="no" mutable="no">
        <type><ref refid="version__variable_8h_1acda997fe1761de4c6bca0f27dc786964" kindref="member">character</ref>(len=40)</type>
        <definition>character(len=40) soliton_initialization::mdl</definition>
        <argsstring></argsstring>
        <name>mdl</name>
        <initializer>= &quot;soliton_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/soliton_initialization.F90" line="23" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/soliton_initialization.F90" bodystart="23" bodyend="23"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacesoliton__initialization_1aafb0cddd1b46af87cc7dcb5e08c58fa3" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public soliton_initialization::soliton_initialize_thickness</definition>
        <argsstring>(h, G, GV, US)</argsstring>
        <name>soliton_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>
        <briefdescription>
<para>Initialization of thicknesses in Equatorial Rossby soliton test. </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>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/soliton_initialization.F90" line="31" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/soliton_initialization.F90" bodystart="32" bodyend="61"/>
        <references refid="namespacemom__error__handler_1a1c462df7b61f1296407b4af51dfeceab" compoundref="MOM__error__handler_8F90" startline="53" endline="66">mom_error_handler::mom_mesg</references>
        <referencedby refid="namespacemom__state__initialization_1a81503d4f1855cb185f122d6314e4f06c" compoundref="MOM__state__initialization_8F90" startline="117" endline="615">mom_state_initialization::mom_initialize_state</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacesoliton__initialization_1a0baf019ffa8cbb6754cd197af8a377b8" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public soliton_initialization::soliton_initialize_velocity</definition>
        <argsstring>(u, v, h, G, US)</argsstring>
        <name>soliton_initialize_velocity</name>
        <param>
          <type>u</type>
          <defname>u</defname>
        </param>
        <param>
          <type>v</type>
          <defname>v</defname>
        </param>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <briefdescription>
<para>Initialization of u and v in the equatorial Rossby soliton test. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Grid structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">u</parametername>
</parameternamelist>
<parameterdescription>
<para>i-component of velocity [L T-1 ~&gt; m s-1] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">v</parametername>
</parameternamelist>
<parameterdescription>
<para>j-component of velocity [L T-1 ~&gt; m s-1] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h</parametername>
</parameternamelist>
<parameterdescription>
<para>Thickness [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">us</parametername>
</parameternamelist>
<parameterdescription>
<para>A dimensional unit scaling type </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/soliton_initialization.F90" line="66" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/soliton_initialization.F90" bodystart="67" bodyend="110"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Initial conditions for the Equatorial Rossby soliton test (Boyd). </para>
    </briefdescription>
    <detaileddescription>
<sect1 id="namespacesoliton__initialization_1section_soliton">
<title>Description of the equatorial Rossby soliton initial</title>
<para>conditions </para>
</sect1>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/user/soliton_initialization.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
