<?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.15">
  <compounddef id="interfacemom__eos_1_1calculate__compress" kind="interface" language="Fortran" prot="private">
    <compoundname>mom_eos::calculate_compress</compoundname>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="interfacemom__eos_1_1calculate__compress_1aeea5c8180415d4755c99ebde065a8531" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_eos::calculate_compress::calculate_compress_scalar</definition>
        <argsstring>(T, S, pressure, rho, drho_dp, EOS)</argsstring>
        <name>calculate_compress_scalar</name>
        <param>
          <type>T</type>
          <defname>T</defname>
        </param>
        <param>
          <type>S</type>
          <defname>S</defname>
        </param>
        <param>
          <type>pressure</type>
          <defname>pressure</defname>
        </param>
        <param>
          <type>rho</type>
          <defname>rho</defname>
        </param>
        <param>
          <type>drho_dp</type>
          <defname>drho_dp</defname>
        </param>
        <param>
          <type>EOS</type>
          <defname>EOS</defname>
        </param>
        <briefdescription>
<para>Calculate density and compressibility for a scalar. This just promotes the scalar to an array with a singleton dimension and calls calculate_compress_array. If US is present, the units of the inputs and outputs are rescaled. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">t</parametername>
</parameternamelist>
<parameterdescription>
<para>Potential temperature referenced to the surface [degC] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">s</parametername>
</parameternamelist>
<parameterdescription>
<para>Salinity [ppt] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">pressure</parametername>
</parameternamelist>
<parameterdescription>
<para>Pressure [Pa] or [R L2 T-2 ~&gt; Pa] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">rho</parametername>
</parameternamelist>
<parameterdescription>
<para>In situ density [kg m-3] or [R ~&gt; kg m-3] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">drho_dp</parametername>
</parameternamelist>
<parameterdescription>
<para>The partial derivative of density with pressure (also the inverse of the square of sound speed) [s2 m-2] or [T2 L-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>eos</parametername>
</parameternamelist>
<parameterdescription>
<para>Equation of state structure </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_EOS.F90" line="1138" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_EOS.F90" bodystart="1139" bodyend="1156"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__eos_1_1calculate__compress_1a9f741b490451d2a461f290e2294af55d" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_eos::calculate_compress::calculate_compress_array</definition>
        <argsstring>(T, S, press, rho, drho_dp, start, npts, EOS)</argsstring>
        <name>calculate_compress_array</name>
        <param>
          <type>T</type>
          <defname>T</defname>
        </param>
        <param>
          <type>S</type>
          <defname>S</defname>
        </param>
        <param>
          <type>press</type>
          <defname>press</defname>
        </param>
        <param>
          <type>rho</type>
          <defname>rho</defname>
        </param>
        <param>
          <type>drho_dp</type>
          <defname>drho_dp</defname>
        </param>
        <param>
          <type>start</type>
          <defname>start</defname>
        </param>
        <param>
          <type>npts</type>
          <defname>npts</defname>
        </param>
        <param>
          <type>EOS</type>
          <defname>EOS</defname>
        </param>
        <briefdescription>
<para>Calls the appropriate subroutine to calculate the density and compressibility for 1-D array inputs. If US is present, the units of the inputs and outputs are rescaled. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">t</parametername>
</parameternamelist>
<parameterdescription>
<para>Potential temperature referenced to the surface [degC] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">s</parametername>
</parameternamelist>
<parameterdescription>
<para>Salinity [PSU] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">press</parametername>
</parameternamelist>
<parameterdescription>
<para>Pressure [Pa] or [R L2 T-2 ~&gt; Pa] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">rho</parametername>
</parameternamelist>
<parameterdescription>
<para>In situ density [kg m-3] or [R ~&gt; kg m-3] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">drho_dp</parametername>
</parameternamelist>
<parameterdescription>
<para>The partial derivative of density with pressure (also the inverse of the square of sound speed) [s2 m-2] or [T2 L-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">start</parametername>
</parameternamelist>
<parameterdescription>
<para>Starting index within the array </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">npts</parametername>
</parameternamelist>
<parameterdescription>
<para>The number of values to calculate </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>eos</parametername>
</parameternamelist>
<parameterdescription>
<para>Equation of state structure </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_EOS.F90" line="1088" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_EOS.F90" bodystart="1089" bodyend="1132"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Calculates the compressibility of water from T, S, and P. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_EOS.F90" line="103" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_EOS.F90" bodystart="103" bodyend="104"/>
    <listofallmembers>
      <member refid="interfacemom__eos_1_1calculate__compress_1a9f741b490451d2a461f290e2294af55d" prot="private" virt="non-virtual"><scope>mom_eos::calculate_compress</scope><name>calculate_compress_array</name></member>
      <member refid="interfacemom__eos_1_1calculate__compress_1aeea5c8180415d4755c99ebde065a8531" prot="private" virt="non-virtual"><scope>mom_eos::calculate_compress</scope><name>calculate_compress_scalar</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
