<?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="namespacemom__tfreeze" kind="namespace" language="Fortran">
    <compoundname>mom_tfreeze</compoundname>
    <innerclass refid="interfacemom__tfreeze_1_1calculate__tfreeze__linear" prot="private">mom_tfreeze::calculate_tfreeze_linear</innerclass>
    <innerclass refid="interfacemom__tfreeze_1_1calculate__tfreeze__millero" prot="private">mom_tfreeze::calculate_tfreeze_millero</innerclass>
    <innerclass refid="interfacemom__tfreeze_1_1calculate__tfreeze__teos10" prot="private">mom_tfreeze::calculate_tfreeze_teos10</innerclass>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacemom__tfreeze_1a2ddd15b4504c24cf5b260d47c8c494f4" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_tfreeze::calculate_tfreeze_linear_scalar</definition>
        <argsstring>(S, pres, T_Fr, TFr_S0_P0, dTFr_dS, dTFr_dp)</argsstring>
        <name>calculate_tfreeze_linear_scalar</name>
        <param>
          <type>S</type>
          <defname>S</defname>
        </param>
        <param>
          <type>pres</type>
          <defname>pres</defname>
        </param>
        <param>
          <type>T_Fr</type>
          <defname>T_Fr</defname>
        </param>
        <param>
          <type>TFr_S0_P0</type>
          <defname>TFr_S0_P0</defname>
        </param>
        <param>
          <type>dTFr_dS</type>
          <defname>dTFr_dS</defname>
        </param>
        <param>
          <type>dTFr_dp</type>
          <defname>dTFr_dp</defname>
        </param>
        <briefdescription>
<para>This subroutine computes the freezing point potential temperature [degC] from salinity [ppt], and pressure [Pa] using a simple linear expression, with coefficients passed in as arguments. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">s</parametername>
</parameternamelist>
<parameterdescription>
<para>salinity [ppt]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">pres</parametername>
</parameternamelist>
<parameterdescription>
<para>pressure [Pa]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">t_fr</parametername>
</parameternamelist>
<parameterdescription>
<para>Freezing point potential temperature [degC]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">tfr_s0_p0</parametername>
</parameternamelist>
<parameterdescription>
<para>The freezing point at S=0, p=0 [degC]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dtfr_ds</parametername>
</parameternamelist>
<parameterdescription>
<para>The derivative of freezing point with salinity, [degC ppt-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dtfr_dp</parametername>
</parameternamelist>
<parameterdescription>
<para>The derivative of freezing point with pressure, [degC Pa-1]. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_TFreeze.F90" line="42" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_TFreeze.F90" bodystart="44" bodyend="54"/>
      </memberdef>
      <memberdef kind="function" id="namespacemom__tfreeze_1af12519254654bedd8fd95bb1464895e2" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_tfreeze::calculate_tfreeze_linear_array</definition>
        <argsstring>(S, pres, T_Fr, start, npts, TFr_S0_P0, dTFr_dS, dTFr_dp)</argsstring>
        <name>calculate_tfreeze_linear_array</name>
        <param>
          <type>S</type>
          <defname>S</defname>
        </param>
        <param>
          <type>pres</type>
          <defname>pres</defname>
        </param>
        <param>
          <type>T_Fr</type>
          <defname>T_Fr</defname>
        </param>
        <param>
          <type>start</type>
          <defname>start</defname>
        </param>
        <param>
          <type>npts</type>
          <defname>npts</defname>
        </param>
        <param>
          <type>TFr_S0_P0</type>
          <defname>TFr_S0_P0</defname>
        </param>
        <param>
          <type>dTFr_dS</type>
          <defname>dTFr_dS</defname>
        </param>
        <param>
          <type>dTFr_dp</type>
          <defname>dTFr_dp</defname>
        </param>
        <briefdescription>
<para>This subroutine computes an array of freezing point potential temperatures [degC] from salinity [ppt], and pressure [Pa] using a simple linear expression, with coefficients passed in as arguments. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">s</parametername>
</parameternamelist>
<parameterdescription>
<para>salinity [ppt]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">pres</parametername>
</parameternamelist>
<parameterdescription>
<para>pressure [Pa]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">t_fr</parametername>
</parameternamelist>
<parameterdescription>
<para>Freezing point potential temperature [degC]. </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 direction="in">tfr_s0_p0</parametername>
</parameternamelist>
<parameterdescription>
<para>The freezing point at S=0, p=0, [degC]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dtfr_ds</parametername>
</parameternamelist>
<parameterdescription>
<para>The derivative of freezing point with salinity, [degC PSU-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dtfr_dp</parametername>
</parameternamelist>
<parameterdescription>
<para>The derivative of freezing point with pressure, [degC Pa-1]. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_TFreeze.F90" line="60" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_TFreeze.F90" bodystart="62" bodyend="77"/>
      </memberdef>
      <memberdef kind="function" id="namespacemom__tfreeze_1a4fcadee3bbc5298ec6d41772d6936f36" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_tfreeze::calculate_tfreeze_millero_scalar</definition>
        <argsstring>(S, pres, T_Fr)</argsstring>
        <name>calculate_tfreeze_millero_scalar</name>
        <param>
          <type>S</type>
          <defname>S</defname>
        </param>
        <param>
          <type>pres</type>
          <defname>pres</defname>
        </param>
        <param>
          <type>T_Fr</type>
          <defname>T_Fr</defname>
        </param>
        <briefdescription>
<para>This subroutine computes the freezing point potential temperature [degC] from salinity [ppt], and pressure [Pa] using the expression from Millero (1978) (and in appendix A of Gill 1982), but with the of the pressure dependence changed from 7.53e-8 to 7.75e-8 to make this an expression for potential temperature (not in situ temperature), using a value that is correct at the freezing point at 35 PSU and 5e6 Pa (500 dbar). </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">s</parametername>
</parameternamelist>
<parameterdescription>
<para>Salinity in PSU. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">pres</parametername>
</parameternamelist>
<parameterdescription>
<para>Pressure [Pa]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">t_fr</parametername>
</parameternamelist>
<parameterdescription>
<para>Freezing point potential temperature [degC]. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_TFreeze.F90" line="86" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_TFreeze.F90" bodystart="87" bodyend="96"/>
      </memberdef>
      <memberdef kind="function" id="namespacemom__tfreeze_1a61e16a96b67dcb325cd779b838f87208" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_tfreeze::calculate_tfreeze_millero_array</definition>
        <argsstring>(S, pres, T_Fr, start, npts)</argsstring>
        <name>calculate_tfreeze_millero_array</name>
        <param>
          <type>S</type>
          <defname>S</defname>
        </param>
        <param>
          <type>pres</type>
          <defname>pres</defname>
        </param>
        <param>
          <type>T_Fr</type>
          <defname>T_Fr</defname>
        </param>
        <param>
          <type>start</type>
          <defname>start</defname>
        </param>
        <param>
          <type>npts</type>
          <defname>npts</defname>
        </param>
        <briefdescription>
<para>This subroutine computes the freezing point potential temperature [degC] from salinity [ppt], and pressure [Pa] using the expression from Millero (1978) (and in appendix A of Gill 1982), but with the of the pressure dependence changed from 7.53e-8 to 7.75e-8 to make this an expression for potential temperature (not in situ temperature), using a value that is correct at the freezing point at 35 PSU and 5e6 Pa (500 dbar). </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">s</parametername>
</parameternamelist>
<parameterdescription>
<para>Salinity [PSU]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">pres</parametername>
</parameternamelist>
<parameterdescription>
<para>Pressure [Pa]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">t_fr</parametername>
</parameternamelist>
<parameterdescription>
<para>Freezing point potential temperature [degC]. </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>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_TFreeze.F90" line="105" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_TFreeze.F90" bodystart="106" bodyend="121"/>
      </memberdef>
      <memberdef kind="function" id="namespacemom__tfreeze_1a9664517581c88633f8f7f7202d9f6cb1" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_tfreeze::calculate_tfreeze_teos10_scalar</definition>
        <argsstring>(S, pres, T_Fr)</argsstring>
        <name>calculate_tfreeze_teos10_scalar</name>
        <param>
          <type>S</type>
          <defname>S</defname>
        </param>
        <param>
          <type>pres</type>
          <defname>pres</defname>
        </param>
        <param>
          <type>T_Fr</type>
          <defname>T_Fr</defname>
        </param>
        <briefdescription>
<para>This subroutine computes the freezing point conservative temperature [degC] from absolute salinity [g/kg], and pressure [Pa] using the TEOS10 package. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">s</parametername>
</parameternamelist>
<parameterdescription>
<para>Absolute salinity [g/kg]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">pres</parametername>
</parameternamelist>
<parameterdescription>
<para>Pressure [Pa]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">t_fr</parametername>
</parameternamelist>
<parameterdescription>
<para>Freezing point conservative temperature [degC]. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_TFreeze.F90" line="127" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_TFreeze.F90" bodystart="128" bodyend="141"/>
        <references refid="namespacemom__tfreeze_1ad5c8c3d7fb0b9459a38099be1f13a20e" compoundref="MOM__TFreeze_8F90" startline="148" endline="169">calculate_tfreeze_teos10_array</references>
      </memberdef>
      <memberdef kind="function" id="namespacemom__tfreeze_1ad5c8c3d7fb0b9459a38099be1f13a20e" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_tfreeze::calculate_tfreeze_teos10_array</definition>
        <argsstring>(S, pres, T_Fr, start, npts)</argsstring>
        <name>calculate_tfreeze_teos10_array</name>
        <param>
          <type>S</type>
          <defname>S</defname>
        </param>
        <param>
          <type>pres</type>
          <defname>pres</defname>
        </param>
        <param>
          <type>T_Fr</type>
          <defname>T_Fr</defname>
        </param>
        <param>
          <type>start</type>
          <defname>start</defname>
        </param>
        <param>
          <type>npts</type>
          <defname>npts</defname>
        </param>
        <briefdescription>
<para>This subroutine computes the freezing point conservative temperature [degC] from absolute salinity [g/kg], and pressure [Pa] using the TEOS10 package. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">s</parametername>
</parameternamelist>
<parameterdescription>
<para>absolute salinity [g/kg]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">pres</parametername>
</parameternamelist>
<parameterdescription>
<para>pressure [Pa]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">t_fr</parametername>
</parameternamelist>
<parameterdescription>
<para>Freezing point conservative temperature [degC]. </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>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_TFreeze.F90" line="147" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_TFreeze.F90" bodystart="148" bodyend="169"/>
        <referencedby refid="namespacemom__tfreeze_1a9664517581c88633f8f7f7202d9f6cb1" compoundref="MOM__TFreeze_8F90" startline="128" endline="141">calculate_tfreeze_teos10_scalar</referencedby>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Freezing point expressions. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_TFreeze.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
