<?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.16">
  <compounddef id="interfacemom__eos_1_1calculate__spec__vol" kind="interface" language="Fortran" prot="private">
    <compoundname>mom_eos::calculate_spec_vol</compoundname>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="interfacemom__eos_1_1calculate__spec__vol_1a738945d7ca218ddbf43bb32ead72be9a" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_eos::calculate_spec_vol::calc_spec_vol_scalar</definition>
        <argsstring>(T, S, pressure, specvol, EOS, spv_ref, scale)</argsstring>
        <name>calc_spec_vol_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>specvol</type>
          <defname>specvol</defname>
        </param>
        <param>
          <type>EOS</type>
          <defname>EOS</defname>
        </param>
        <param>
          <type>spv_ref</type>
          <defname>spv_ref</defname>
        </param>
        <param>
          <type>scale</type>
          <defname>scale</defname>
        </param>
        <briefdescription>
<para>Calls the appropriate subroutine to calculate specific volume of sea water for scalar inputs. </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">specvol</parametername>
</parameternamelist>
<parameterdescription>
<para>In situ? specific volume [m3 kg-1] or [R-1 ~&gt; m3 kg-1] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>eos</parametername>
</parameternamelist>
<parameterdescription>
<para>Equation of state structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">spv_ref</parametername>
</parameternamelist>
<parameterdescription>
<para>A reference specific volume [m3 kg-1] or [R-1 m3 kg-1] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">scale</parametername>
</parameternamelist>
<parameterdescription>
<para>A multiplicative factor by which to scale specific volume in combination with scaling given by US [various] </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_EOS.F90" line="532" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_EOS.F90" bodystart="533" bodyend="565"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__eos_1_1calculate__spec__vol_1a6a894de8c565f003dac2624118844c3c" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_eos::calculate_spec_vol::calculate_spec_vol_array</definition>
        <argsstring>(T, S, pressure, specvol, start, npts, EOS, spv_ref, scale)</argsstring>
        <name>calculate_spec_vol_array</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>specvol</type>
          <defname>specvol</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>
        <param>
          <type>spv_ref</type>
          <defname>spv_ref</defname>
        </param>
        <param>
          <type>scale</type>
          <defname>scale</defname>
        </param>
        <briefdescription>
<para>Calls the appropriate subroutine to calculate the specific volume of sea water for 1-D array inputs. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">t</parametername>
</parameternamelist>
<parameterdescription>
<para>potential temperature relative 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] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">specvol</parametername>
</parameternamelist>
<parameterdescription>
<para>in situ specific volume [kg m-3] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">start</parametername>
</parameternamelist>
<parameterdescription>
<para>the starting point in the arrays. </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>
<parameteritem>
<parameternamelist>
<parametername direction="in">spv_ref</parametername>
</parameternamelist>
<parameterdescription>
<para>A reference specific volume [m3 kg-1] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">scale</parametername>
</parameternamelist>
<parameterdescription>
<para>A multiplicative factor by which to scale specific volume in combination with scaling given by US [various] </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_EOS.F90" line="485" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_EOS.F90" bodystart="486" bodyend="527"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__eos_1_1calculate__spec__vol_1a09bc44c37a1d952f42d9b01db8bc5267" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_eos::calculate_spec_vol::calc_spec_vol_1d</definition>
        <argsstring>(T, S, pressure, specvol, EOS, dom, spv_ref, scale)</argsstring>
        <name>calc_spec_vol_1d</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>specvol</type>
          <defname>specvol</defname>
        </param>
        <param>
          <type>EOS</type>
          <defname>EOS</defname>
        </param>
        <param>
          <type>dom</type>
          <defname>dom</defname>
        </param>
        <param>
          <type>spv_ref</type>
          <defname>spv_ref</defname>
        </param>
        <param>
          <type>scale</type>
          <defname>scale</defname>
        </param>
        <briefdescription>
<para>Calls the appropriate subroutine to calculate the specific volume of sea water for 1-D array inputs, potentially limiting the domain of indices that are worked on. </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 [R L2 T-2 ~&gt; Pa] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">specvol</parametername>
</parameternamelist>
<parameterdescription>
<para>In situ specific volume [R-1 ~&gt; m3 kg-1] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>eos</parametername>
</parameternamelist>
<parameterdescription>
<para>Equation of state structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dom</parametername>
</parameternamelist>
<parameterdescription>
<para>The domain of indices to work on, taking into account that arrays start at 1. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">spv_ref</parametername>
</parameternamelist>
<parameterdescription>
<para>A reference specific volume [R-1 ~&gt; m3 kg-1] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">scale</parametername>
</parameternamelist>
<parameterdescription>
<para>A multiplicative factor by which to scale output specific volume in combination with scaling given by US [various] </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_EOS.F90" line="570" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_EOS.F90" bodystart="571" bodyend="619"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Calculates specific volume of sea 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="75" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_EOS.F90" bodystart="75" bodyend="77"/>
    <listofallmembers>
      <member refid="interfacemom__eos_1_1calculate__spec__vol_1a09bc44c37a1d952f42d9b01db8bc5267" prot="private" virt="non-virtual"><scope>mom_eos::calculate_spec_vol</scope><name>calc_spec_vol_1d</name></member>
      <member refid="interfacemom__eos_1_1calculate__spec__vol_1a738945d7ca218ddbf43bb32ead72be9a" prot="private" virt="non-virtual"><scope>mom_eos::calculate_spec_vol</scope><name>calc_spec_vol_scalar</name></member>
      <member refid="interfacemom__eos_1_1calculate__spec__vol_1a6a894de8c565f003dac2624118844c3c" prot="private" virt="non-virtual"><scope>mom_eos::calculate_spec_vol</scope><name>calculate_spec_vol_array</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
