<?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.13">
  <compounddef id="namespacemom__pressureforce" kind="namespace" language="Fortran">
    <compoundname>mom_pressureforce</compoundname>
    <innerclass refid="structmom__pressureforce_1_1pressureforce__cs" prot="public">mom_pressureforce::pressureforce_cs</innerclass>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacemom__pressureforce_1ab8f34ea530e5a436a4d1967a562394bd" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_pressureforce::pressureforce</definition>
        <argsstring>(h, tv, PFu, PFv, G, GV, US, CS, ALE_CSp, p_atm, pbce, eta)</argsstring>
        <name>pressureforce</name>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>tv</type>
          <defname>tv</defname>
        </param>
        <param>
          <type>PFu</type>
          <defname>PFu</defname>
        </param>
        <param>
          <type>PFv</type>
          <defname>PFv</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>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>ALE_CSp</type>
          <defname>ALE_CSp</defname>
        </param>
        <param>
          <type>p_atm</type>
          <defname>p_atm</defname>
        </param>
        <param>
          <type>pbce</type>
          <defname>pbce</defname>
        </param>
        <param>
          <type>eta</type>
          <defname>eta</defname>
        </param>
        <briefdescription>
<para>A thin layer between the model and the Boussinesq and non-Boussinesq pressure force routines. </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">pfu</parametername>
</parameternamelist>
<parameterdescription>
<para>Zonal pressure force acceleration [L T-2 ~&gt; m s-2]</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">pfv</parametername>
</parameternamelist>
<parameterdescription>
<para>Meridional pressure force acceleration [L T-2 ~&gt; m s-2]</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Pressure force control structure</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>ale_csp</parametername>
</parameternamelist>
<parameterdescription>
<para>ALE control structure</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>p_atm</parametername>
</parameternamelist>
<parameterdescription>
<para>The pressure at the ice-ocean or</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">pbce</parametername>
</parameternamelist>
<parameterdescription>
<para>The baroclinic pressure anomaly in each layer</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">eta</parametername>
</parameternamelist>
<parameterdescription>
<para>The bottom mass used to calculate PFu and PFv, </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_PressureForce.F90" line="40" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_PressureForce.F90" bodystart="41" bodyend="80"/>
        <referencedby refid="namespacemom__dynamics__split__rk2_1a976e700971f232fc11bc69b31d611c32" compoundref="MOM__dynamics__split__RK2_8F90" startline="245" endline="994">mom_dynamics_split_rk2::step_mom_dyn_split_rk2</referencedby>
        <referencedby refid="namespacemom__dynamics__unsplit_1ab72d911d187f9247b6cc72d87e815370" compoundref="MOM__dynamics__unsplit_8F90" startline="192" endline="507">mom_dynamics_unsplit::step_mom_dyn_unsplit</referencedby>
        <referencedby refid="namespacemom__dynamics__unsplit__rk2_1a25424d65cc3339442e528c0a92b173a3" compoundref="MOM__dynamics__unsplit__RK2_8F90" startline="194" endline="452">mom_dynamics_unsplit_rk2::step_mom_dyn_unsplit_rk2</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__pressureforce_1a9d4e96b8dd697eb597a7e8376803d1f8" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_pressureforce::pressureforce_init</definition>
        <argsstring>(Time, G, GV, US, param_file, diag, CS, tides_CSp)</argsstring>
        <name>pressureforce_init</name>
        <param>
          <type>Time</type>
          <defname>Time</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>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>diag</type>
          <defname>diag</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>tides_CSp</type>
          <defname>tides_CSp</defname>
        </param>
        <briefdescription>
<para>Initialize the pressure force control structure. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">time</parametername>
</parameternamelist>
<parameterdescription>
<para>Current model time</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean grid structure</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>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">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>Parameter file handles</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">diag</parametername>
</parameternamelist>
<parameterdescription>
<para>Diagnostics control structure</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Pressure force control structure</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>tides_csp</parametername>
</parameternamelist>
<parameterdescription>
<para>Tide control structure </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_PressureForce.F90" line="84" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_PressureForce.F90" bodystart="85" bodyend="118"/>
        <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__pressureforce_1ac5b8f9f89a3a985b7aecf84e3c6ff3d6" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_pressureforce::pressureforce_end</definition>
        <argsstring>(CS)</argsstring>
        <name>pressureforce_end</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>Deallocate the pressure force control structure. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Pressure force control structure </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_PressureForce.F90" line="122" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_PressureForce.F90" bodystart="123" bodyend="131"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>A thin wrapper for Boussinesq/non-Boussinesq forms of the pressure force calculation. </para>    </briefdescription>
    <detaileddescription>
<para>This thin module provides a branch to two forms of the horizontal accelerations due to pressure gradients. The two options currently available are a Montgomery potential form (used in traditional isopycnal layer models), and the analytic finite volume form. </para>    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_PressureForce.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
