<?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.17">
  <compounddef id="namespacergc__initialization" kind="namespace" language="Fortran">
    <compoundname>rgc_initialization</compoundname>
      <sectiondef kind="var">
      <memberdef kind="variable" id="namespacergc__initialization_1adbef7f1eff10cb49f0db746d2a022cc9" prot="private" static="no" mutable="no">
        <type><ref refid="version__variable_8h_1acda997fe1761de4c6bca0f27dc786964" kindref="member">character</ref>(len=40)</type>
        <definition>character(len=40) rgc_initialization::mod</definition>
        <argsstring></argsstring>
        <name>mod</name>
        <initializer>= &quot;RGC_initialization&quot;</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/RGC_initialization.F90" line="43" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/RGC_initialization.F90" bodystart="43" bodyend="43"/>
        <referencedby refid="namespacergc__initialization_1aab8f879daf1bf72d05b7f7ccd8770256" compoundref="RGC__initialization_8F90" startline="51" endline="228">rgc_initialize_sponges</referencedby>
      </memberdef>
      </sectiondef>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacergc__initialization_1aab8f879daf1bf72d05b7f7ccd8770256" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public rgc_initialization::rgc_initialize_sponges</definition>
        <argsstring>(G, GV, US, tv, u, v, PF, use_ALE, CSp, ACSp)</argsstring>
        <name>rgc_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>u</type>
          <defname>u</defname>
        </param>
        <param>
          <type>v</type>
          <defname>v</defname>
        </param>
        <param>
          <type>PF</type>
          <defname>PF</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>Sets up the the inverse restoration time, and the values towards which the interface heights, velocities and tracers should be restored within the sponges for the RGC 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="in">tv</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure containing pointers to any available thermodynamic fields, potential temperature and salinity or mixed layer density. Absent fields have NULL ptrs. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">u</parametername>
</parameternamelist>
<parameterdescription>
<para>Array with the u velocity [L T-1 ~&gt; m s-1] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">v</parametername>
</parameternamelist>
<parameterdescription>
<para>Array with the v velocity [L T-1 ~&gt; m s-1] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">pf</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure indicating the open file to parse for model parameter values. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">use_ale</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, indicates model is in ALE mode </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>csp</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer-mode sponge structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>acsp</parametername>
</parameternamelist>
<parameterdescription>
<para>ALE-mode sponge structure </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/RGC_initialization.F90" line="50" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/RGC_initialization.F90" bodystart="51" bodyend="228"/>
        <references refid="namespacemom__eos_1a782d326108e390902e520efc078e8296" compoundref="MOM__EOS_8F90" startline="1163" endline="1175">mom_eos::eos_domain</references>
        <references refid="namespacergc__initialization_1adbef7f1eff10cb49f0db746d2a022cc9" compoundref="RGC__initialization_8F90" startline="43" endline="43">mod</references>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <references refid="namespacemom__sponge_1ac5a144fffdfc612c6e3de802261cc85c" compoundref="MOM__sponge_8F90" startline="277" endline="318">mom_sponge::set_up_sponge_ml_density</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>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/user/RGC_initialization.F90" line="1" column="1"/>
  </compounddef>
</doxygen>
