<?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.18">
  <compounddef id="interfacemom__ale__sponge_1_1set__up__ale__sponge__field" kind="interface" language="Fortran" prot="private">
    <compoundname>mom_ale_sponge::set_up_ale_sponge_field</compoundname>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="interfacemom__ale__sponge_1_1set__up__ale__sponge__field_1ac13ca73c932cc3ea73a84ff6850f95c7" 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_field::set_up_ale_sponge_field_fixed</definition>
        <argsstring>(sp_val, G, f_ptr, CS)</argsstring>
        <name>set_up_ale_sponge_field_fixed</name>
        <param>
          <type>sp_val</type>
          <defname>sp_val</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>f_ptr</type>
          <defname>f_ptr</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>This subroutine stores the reference profile at h points for the variable whose address is given by f_ptr. </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>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>ALE sponge control structure (in/out). </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">sp_val</parametername>
</parameternamelist>
<parameterdescription>
<para>Field to be used in the sponge, it has arbitrary number of layers. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">f_ptr</parametername>
</parameternamelist>
<parameterdescription>
<para>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="563" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_ALE_sponge.F90" bodystart="564" bodyend="595"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__ale__sponge_1_1set__up__ale__sponge__field_1a81f7ebe56416697ed6015bb062e05dd6" 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_field::set_up_ale_sponge_field_varying</definition>
        <argsstring>(filename, fieldname, Time, G, GV, US, f_ptr, CS)</argsstring>
        <name>set_up_ale_sponge_field_varying</name>
        <param>
          <type>filename</type>
          <defname>filename</defname>
        </param>
        <param>
          <type>fieldname</type>
          <defname>fieldname</defname>
        </param>
        <param>
          <type>Time</type>
          <defname>Time</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>f_ptr</type>
          <defname>f_ptr</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>This subroutine stores the reference profile at h points for the variable whose address is given by filename and fieldname. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">filename</parametername>
</parameternamelist>
<parameterdescription>
<para>The name of the file with the time varying field data </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">fieldname</parametername>
</parameternamelist>
<parameterdescription>
<para>The name of the field in the file with the time varying field data </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">time</parametername>
</parameternamelist>
<parameterdescription>
<para>The current model time </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Grid structure (in). </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>ocean 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">f_ptr</parametername>
</parameternamelist>
<parameterdescription>
<para>Pointer to the field to be damped (in). </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Sponge control structure (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="600" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_ALE_sponge.F90" bodystart="601" bodyend="660"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Store the reference profile at h points for a variable. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_ALE_sponge.F90" line="34" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/parameterizations/vertical/MOM_ALE_sponge.F90" bodystart="34" bodyend="36"/>
    <listofallmembers>
      <member refid="interfacemom__ale__sponge_1_1set__up__ale__sponge__field_1ac13ca73c932cc3ea73a84ff6850f95c7" prot="private" virt="non-virtual"><scope>mom_ale_sponge::set_up_ale_sponge_field</scope><name>set_up_ale_sponge_field_fixed</name></member>
      <member refid="interfacemom__ale__sponge_1_1set__up__ale__sponge__field_1a81f7ebe56416697ed6015bb062e05dd6" prot="private" virt="non-virtual"><scope>mom_ale_sponge::set_up_ale_sponge_field</scope><name>set_up_ale_sponge_field_varying</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
