<?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__tfreeze_1_1calculate__tfreeze__linear" kind="interface" language="Fortran" prot="private">
    <compoundname>mom_tfreeze::calculate_tfreeze_linear</compoundname>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="interfacemom__tfreeze_1_1calculate__tfreeze__linear_1a18e78235e6105b57513ed941bf054273" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_tfreeze::calculate_tfreeze_linear::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="interfacemom__tfreeze_1_1calculate__tfreeze__linear_1a5dd726d92e2e168f8d9ede34f5898258" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_tfreeze::calculate_tfreeze_linear::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>
      </sectiondef>
    <briefdescription>
<para>Compute 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>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_TFreeze.F90" line="18" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_TFreeze.F90" bodystart="18" bodyend="19"/>
    <listofallmembers>
      <member refid="interfacemom__tfreeze_1_1calculate__tfreeze__linear_1a5dd726d92e2e168f8d9ede34f5898258" prot="private" virt="non-virtual"><scope>mom_tfreeze::calculate_tfreeze_linear</scope><name>calculate_tfreeze_linear_array</name></member>
      <member refid="interfacemom__tfreeze_1_1calculate__tfreeze__linear_1a18e78235e6105b57513ed941bf054273" prot="private" virt="non-virtual"><scope>mom_tfreeze::calculate_tfreeze_linear</scope><name>calculate_tfreeze_linear_scalar</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
