<?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.19" xml:lang="en-US">
  <compounddef id="namespacemom__interface__heights" kind="namespace" language="Fortran">
    <compoundname>mom_interface_heights</compoundname>
    <innerclass refid="interfacemom__interface__heights_1_1find__eta" prot="private">mom_interface_heights::find_eta</innerclass>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacemom__interface__heights_1a534ce6d17993d55a7e2b108198bfcfd4" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_interface_heights::find_eta_3d</definition>
        <argsstring>(h, tv, G, GV, US, eta, eta_bt, halo_size, eta_to_m)</argsstring>
        <name>find_eta_3d</name>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>tv</type>
          <defname>tv</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>eta</type>
          <defname>eta</defname>
        </param>
        <param>
          <type>eta_bt</type>
          <defname>eta_bt</defname>
        </param>
        <param>
          <type>halo_size</type>
          <defname>halo_size</defname>
        </param>
        <param>
          <type>eta_to_m</type>
          <defname>eta_to_m</defname>
        </param>
        <briefdescription>
<para>Calculates the heights of all interfaces between layers, using the appropriate form for consistency with the calculation of the pressure gradient forces. Additionally, these height may be dilated for consistency with the corresponding time-average quantity from the barotropic calculation. </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">h</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thicknesses [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">tv</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure pointing to various thermodynamic variables. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">eta</parametername>
</parameternamelist>
<parameterdescription>
<para>layer interface heights [Z ~&gt; m] or 1/eta_to_m m). </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">eta_bt</parametername>
</parameternamelist>
<parameterdescription>
<para>optional barotropic variable that gives the &quot;correct&quot; free surface height (Boussinesq) or total water column mass per unit area (non-Boussinesq). This is used to dilate the layer. thicknesses when calculating interfaceheights [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">halo_size</parametername>
</parameternamelist>
<parameterdescription>
<para>width of halo points on which to calculate eta. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">eta_to_m</parametername>
</parameternamelist>
<parameterdescription>
<para>The conversion factor from the units of eta to m; by default this is USZ_to_m. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_interface_heights.F90" line="31" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_interface_heights.F90" bodystart="32" bodyend="141"/>
        <references refid="namespacemom__density__integrals_1a759c2ae7aec17c59d532050f68a1e518" compoundref="MOM__density__integrals_8F90" startline="1007" endline="1054">mom_density_integrals::int_specific_vol_dp</references>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
      </memberdef>
      <memberdef kind="function" id="namespacemom__interface__heights_1a0262e4e5e2d7bd849a2117f91b644ea1" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_interface_heights::find_eta_2d</definition>
        <argsstring>(h, tv, G, GV, US, eta, eta_bt, halo_size, eta_to_m)</argsstring>
        <name>find_eta_2d</name>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>tv</type>
          <defname>tv</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>eta</type>
          <defname>eta</defname>
        </param>
        <param>
          <type>eta_bt</type>
          <defname>eta_bt</defname>
        </param>
        <param>
          <type>halo_size</type>
          <defname>halo_size</defname>
        </param>
        <param>
          <type>eta_to_m</type>
          <defname>eta_to_m</defname>
        </param>
        <briefdescription>
<para>Calculates the free surface height, using the appropriate form for consistency with the calculation of the pressure gradient forces. Additionally, the sea surface height may be adjusted for consistency with the corresponding time-average quantity from the barotropic calculation. </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">h</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thicknesses [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">tv</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure pointing to various thermodynamic variables. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">eta</parametername>
</parameternamelist>
<parameterdescription>
<para>free surface height relative to mean sea level (z=0) often [Z ~&gt; m]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">eta_bt</parametername>
</parameternamelist>
<parameterdescription>
<para>optional barotropic variable that gives the &quot;correct&quot; free surface height (Boussinesq) or total water column mass per unit area (non-Boussinesq) [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">halo_size</parametername>
</parameternamelist>
<parameterdescription>
<para>width of halo points on which to calculate eta. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">eta_to_m</parametername>
</parameternamelist>
<parameterdescription>
<para>The conversion factor from the units of eta to m; by default this is USZ_to_m. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_interface_heights.F90" line="148" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_interface_heights.F90" bodystart="149" bodyend="244"/>
        <references refid="namespacemom__density__integrals_1a759c2ae7aec17c59d532050f68a1e518" compoundref="MOM__density__integrals_8F90" startline="1007" endline="1054">mom_density_integrals::int_specific_vol_dp</references>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Functions for calculating interface heights, including free surface height. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_interface_heights.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
