<?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_1set__up__ale__sponge__vel__field" kind="interface" language="Fortran" prot="private">
    <compoundname>mom_ale_sponge::set_up_ale_sponge_vel_field</compoundname>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="interfacemom__ale__sponge_1_1set__up__ale__sponge__vel__field_1aa0daa07893ebcc910b5f5dcdae3eaf81" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_ale_sponge::set_up_ale_sponge_vel_field::set_up_ale_sponge_vel_field_fixed</definition>
        <argsstring>(u_val, v_val, G, u_ptr, v_ptr, CS)</argsstring>
        <name>set_up_ale_sponge_vel_field_fixed</name>
        <param>
          <type>u_val</type>
          <defname>u_val</defname>
        </param>
        <param>
          <type>v_val</type>
          <defname>v_val</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>u_ptr</type>
          <defname>u_ptr</defname>
        </param>
        <param>
          <type>v_ptr</type>
          <defname>v_ptr</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>This subroutine stores the reference profile at u and v points for the variable whose address is given by u_ptr and v_ptr. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Grid structure (in).</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Sponge structure (in/out).</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">u_val</parametername>
</parameternamelist>
<parameterdescription>
<para>u field to be used in the sponge, it has arbritary number of layers.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">v_val</parametername>
</parameternamelist>
<parameterdescription>
<para>v field to be used in the sponge, it has arbritary number of layers.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">u_ptr</parametername>
</parameternamelist>
<parameterdescription>
<para>u pointer to the field to be damped</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">v_ptr</parametername>
</parameternamelist>
<parameterdescription>
<para>v pointer to the field to be damped </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_ALE_sponge.F90" line="665" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_ALE_sponge.F90" bodystart="666" bodyend="697"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__ale__sponge_1_1set__up__ale__sponge__vel__field_1aae74143786257b294a22b4e450bb6a67" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_ale_sponge::set_up_ale_sponge_vel_field::set_up_ale_sponge_vel_field_varying</definition>
        <argsstring>(filename_u, fieldname_u, filename_v, fieldname_v, Time, G, US, CS, u_ptr, v_ptr)</argsstring>
        <name>set_up_ale_sponge_vel_field_varying</name>
        <param>
          <type>filename_u</type>
          <defname>filename_u</defname>
        </param>
        <param>
          <type>fieldname_u</type>
          <defname>fieldname_u</defname>
        </param>
        <param>
          <type>filename_v</type>
          <defname>filename_v</defname>
        </param>
        <param>
          <type>fieldname_v</type>
          <defname>fieldname_v</defname>
        </param>
        <param>
          <type>Time</type>
          <defname>Time</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>u_ptr</type>
          <defname>u_ptr</defname>
        </param>
        <param>
          <type>v_ptr</type>
          <defname>v_ptr</defname>
        </param>
        <briefdescription>
<para>This subroutine stores the reference profile at uand v points for the variable whose address is given by u_ptr and v_ptr. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">filename_u</parametername>
</parameternamelist>
<parameterdescription>
<para>File name for u field</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">fieldname_u</parametername>
</parameternamelist>
<parameterdescription>
<para>Name of u variable in file</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">filename_v</parametername>
</parameternamelist>
<parameterdescription>
<para>File name for v field</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">fieldname_v</parametername>
</parameternamelist>
<parameterdescription>
<para>Name of v variable in file</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">time</parametername>
</parameternamelist>
<parameterdescription>
<para>Model time</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean grid (in)</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">us</parametername>
</parameternamelist>
<parameterdescription>
<para>A dimensional unit scaling type</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Sponge structure (in/out).</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">u_ptr</parametername>
</parameternamelist>
<parameterdescription>
<para>u pointer to the field to be damped (in).</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">v_ptr</parametername>
</parameternamelist>
<parameterdescription>
<para>v pointer to the field to be damped (in). </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_ALE_sponge.F90" line="702" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_ALE_sponge.F90" bodystart="704" bodyend="782"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>This subroutine stores the reference profile at u and v points for a vector. </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_ALE_sponge.F90" line="40" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_ALE_sponge.F90" bodystart="40" bodyend="42"/>
    <listofallmembers>
      <member refid="interfacemom__ale__sponge_1_1set__up__ale__sponge__vel__field_1aa0daa07893ebcc910b5f5dcdae3eaf81" prot="private" virt="non-virtual"><scope>mom_ale_sponge::set_up_ale_sponge_vel_field</scope><name>set_up_ale_sponge_vel_field_fixed</name></member>
      <member refid="interfacemom__ale__sponge_1_1set__up__ale__sponge__vel__field_1aae74143786257b294a22b4e450bb6a67" prot="private" virt="non-virtual"><scope>mom_ale_sponge::set_up_ale_sponge_vel_field</scope><name>set_up_ale_sponge_vel_field_varying</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
