<?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="interfacemom__ale__sponge_1_1initialize__ale__sponge" kind="interface" language="Fortran" prot="private">
    <compoundname>mom_ale_sponge::initialize_ale_sponge</compoundname>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="interfacemom__ale__sponge_1_1initialize__ale__sponge_1a463cd22c6fdd61d2e0918bb6c830c570" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_ale_sponge::initialize_ale_sponge::initialize_ale_sponge_fixed</definition>
        <argsstring>(Iresttime, G, param_file, CS, data_h, nz_data)</argsstring>
        <name>initialize_ale_sponge_fixed</name>
        <param>
          <type>Iresttime</type>
          <defname>Iresttime</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>data_h</type>
          <defname>data_h</defname>
        </param>
        <param>
          <type>nz_data</type>
          <defname>nz_data</defname>
        </param>
        <briefdescription>
<para>This subroutine determines the number of points which are within sponges in this computational domain. Only points that have positive values of Iresttime and which mask2dT indicates are ocean points are included in the sponges. It also stores the target interface heights. </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">nz_data</parametername>
</parameternamelist>
<parameterdescription>
<para>The total number of sponge input layers.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">iresttime</parametername>
</parameternamelist>
<parameterdescription>
<para>The inverse of the restoring time [T-1 ~&gt; s-1].</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>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer that is set to point to the control structure for this module (in/out).</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">data_h</parametername>
</parameternamelist>
<parameterdescription>
<para>The thicknesses of the sponge input layers [H ~&gt; m or kg m-2]. </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_ALE_sponge.F90" line="148" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_ALE_sponge.F90" bodystart="149" bodyend="341"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__ale__sponge_1_1initialize__ale__sponge_1a11a5638d0ed823f984ff4dbdfdc8f354" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_ale_sponge::initialize_ale_sponge::initialize_ale_sponge_varying</definition>
        <argsstring>(Iresttime, G, param_file, CS)</argsstring>
        <name>initialize_ale_sponge_varying</name>
        <param>
          <type>Iresttime</type>
          <defname>Iresttime</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>This subroutine determines the number of points which are to be restoref in the computational domain. Only points that have positive values of Iresttime and which mask2dT indicates are ocean points are included in the sponges. </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">iresttime</parametername>
</parameternamelist>
<parameterdescription>
<para>The inverse of the restoring time [T-1 ~&gt; s-1].</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>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer that is set to point to the control structure for this module (in/out). </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_ALE_sponge.F90" line="396" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_ALE_sponge.F90" bodystart="397" bodyend="543"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Ddetermine the number of points which are within sponges in this computational domain. </para>    </briefdescription>
    <detaileddescription>
<para>Only points that have positive values of Iresttime and which mask2dT indicates are ocean points are included in the sponges. It also stores the target interface heights. </para>    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_ALE_sponge.F90" line="49" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_ALE_sponge.F90" bodystart="49" bodyend="51"/>
    <listofallmembers>
      <member refid="interfacemom__ale__sponge_1_1initialize__ale__sponge_1a463cd22c6fdd61d2e0918bb6c830c570" prot="private" virt="non-virtual"><scope>mom_ale_sponge::initialize_ale_sponge</scope><name>initialize_ale_sponge_fixed</name></member>
      <member refid="interfacemom__ale__sponge_1_1initialize__ale__sponge_1a11a5638d0ed823f984ff4dbdfdc8f354" prot="private" virt="non-virtual"><scope>mom_ale_sponge::initialize_ale_sponge</scope><name>initialize_ale_sponge_varying</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
