<?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.18">
  <compounddef id="namespacemom__pointaccel" kind="namespace" language="Fortran">
    <compoundname>mom_pointaccel</compoundname>
    <innerclass refid="structmom__pointaccel_1_1pointaccel__cs" prot="public">mom_pointaccel::pointaccel_cs</innerclass>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacemom__pointaccel_1ad0c48b7ad457f12ff654c58118f3e7a9" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_pointaccel::write_u_accel</definition>
        <argsstring>(I, j, um, hin, ADp, CDp, dt_in_T, G, GV, US, CS, vel_rpt, str, a, hv)</argsstring>
        <name>write_u_accel</name>
        <param>
          <type>I</type>
          <defname>I</defname>
        </param>
        <param>
          <type>j</type>
          <defname>j</defname>
        </param>
        <param>
          <type>um</type>
          <defname>um</defname>
        </param>
        <param>
          <type>hin</type>
          <defname>hin</defname>
        </param>
        <param>
          <type>ADp</type>
          <defname>ADp</defname>
        </param>
        <param>
          <type>CDp</type>
          <defname>CDp</defname>
        </param>
        <param>
          <type>dt_in_T</type>
          <defname>dt_in_T</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>vel_rpt</type>
          <defname>vel_rpt</defname>
        </param>
        <param>
          <type>str</type>
          <defname>str</defname>
        </param>
        <param>
          <type>a</type>
          <defname>a</defname>
        </param>
        <param>
          <type>hv</type>
          <defname>hv</defname>
        </param>
        <briefdescription>
<para>This subroutine writes to an output file all of the accelerations that have been applied to a column of zonal velocities over the previous timestep. This subroutine is called from vertvisc. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">i</parametername>
</parameternamelist>
<parameterdescription>
<para>The zonal index of the column to be documented. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">j</parametername>
</parameternamelist>
<parameterdescription>
<para>The meridional index of the column to be documented. </para>
</parameterdescription>
</parameteritem>
<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">um</parametername>
</parameternamelist>
<parameterdescription>
<para>The new zonal velocity [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">hin</parametername>
</parameternamelist>
<parameterdescription>
<para>The layer thickness [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">adp</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure pointing to the various accelerations in the momentum equations. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">cdp</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure with pointers to various terms in the continuity equations. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dt_in_t</parametername>
</parameternamelist>
<parameterdescription>
<para>The ocean dynamics time step [T ~&gt; s]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>The control structure returned by a previous call to PointAccel_init. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">vel_rpt</parametername>
</parameternamelist>
<parameterdescription>
<para>The velocity magnitude that triggers a report [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">str</parametername>
</parameternamelist>
<parameterdescription>
<para>The surface wind stress integrated over a time step divided by the Boussinesq density [m2 s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">a</parametername>
</parameternamelist>
<parameterdescription>
<para>The layer coupling coefficients from vertvisc [Z s-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">hv</parametername>
</parameternamelist>
<parameterdescription>
<para>The layer thicknesses at velocity grid points, </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_PointAccel.F90" line="68" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_PointAccel.F90" bodystart="69" bodyend="395"/>
        <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__pointaccel_1a5dcb6d93272fda6e551bb5275b6b1e3d" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_pointaccel::write_v_accel</definition>
        <argsstring>(i, J, vm, hin, ADp, CDp, dt_in_T, G, GV, US, CS, vel_rpt, str, a, hv)</argsstring>
        <name>write_v_accel</name>
        <param>
          <type>i</type>
          <defname>i</defname>
        </param>
        <param>
          <type>J</type>
          <defname>J</defname>
        </param>
        <param>
          <type>vm</type>
          <defname>vm</defname>
        </param>
        <param>
          <type>hin</type>
          <defname>hin</defname>
        </param>
        <param>
          <type>ADp</type>
          <defname>ADp</defname>
        </param>
        <param>
          <type>CDp</type>
          <defname>CDp</defname>
        </param>
        <param>
          <type>dt_in_T</type>
          <defname>dt_in_T</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>vel_rpt</type>
          <defname>vel_rpt</defname>
        </param>
        <param>
          <type>str</type>
          <defname>str</defname>
        </param>
        <param>
          <type>a</type>
          <defname>a</defname>
        </param>
        <param>
          <type>hv</type>
          <defname>hv</defname>
        </param>
        <briefdescription>
<para>This subroutine writes to an output file all of the accelerations that have been applied to a column of meridional velocities over the previous timestep. This subroutine is called from vertvisc. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">i</parametername>
</parameternamelist>
<parameterdescription>
<para>The zonal index of the column to be documented. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">j</parametername>
</parameternamelist>
<parameterdescription>
<para>The meridional index of the column to be documented. </para>
</parameterdescription>
</parameteritem>
<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">vm</parametername>
</parameternamelist>
<parameterdescription>
<para>The new meridional velocity [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">hin</parametername>
</parameternamelist>
<parameterdescription>
<para>The layer thickness [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">adp</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure pointing to the various accelerations in the momentum equations. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">cdp</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure with pointers to various terms in the continuity equations. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dt_in_t</parametername>
</parameternamelist>
<parameterdescription>
<para>The ocean dynamics time step [T ~&gt; s]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>The control structure returned by a previous call to PointAccel_init. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">vel_rpt</parametername>
</parameternamelist>
<parameterdescription>
<para>The velocity magnitude that triggers a report [L T-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">str</parametername>
</parameternamelist>
<parameterdescription>
<para>The surface wind stress integrated over a time step divided by the Boussinesq density [m2 s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">a</parametername>
</parameternamelist>
<parameterdescription>
<para>The layer coupling coefficients from vertvisc [Z s-1 ~&gt; m s-1]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">hv</parametername>
</parameternamelist>
<parameterdescription>
<para>The layer thicknesses at velocity grid points, </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_PointAccel.F90" line="401" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_PointAccel.F90" bodystart="402" bodyend="727"/>
        <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__pointaccel_1a87921a442c770b070110314588ec654a" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_pointaccel::pointaccel_init</definition>
        <argsstring>(MIS, Time, G, param_file, diag, dirs, CS)</argsstring>
        <name>pointaccel_init</name>
        <param>
          <type>MIS</type>
          <defname>MIS</defname>
        </param>
        <param>
          <type>Time</type>
          <defname>Time</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>diag</type>
          <defname>diag</defname>
        </param>
        <param>
          <type>dirs</type>
          <defname>dirs</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>This subroutine initializes the parameters regulating how truncations are logged. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">mis</parametername>
</parameternamelist>
<parameterdescription>
<para>For &quot;MOM Internal State&quot; a set of pointers </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">time</parametername>
</parameternamelist>
<parameterdescription>
<para>The current model time. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>The ocean&apos;s grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure to parse for run-time parameters. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">diag</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure that is used to regulate diagnostic output. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dirs</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure containing several relevant directory paths. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer that is set to point to the control structure for this module. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_PointAccel.F90" line="731" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_PointAccel.F90" bodystart="732" bodyend="786"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Debug accelerations at a given point. </para>
    </briefdescription>
    <detaileddescription>
<para>The two subroutines in this file write out all of the terms in the u- or v-momentum balance at a given point. Usually these subroutines are called after the velocities exceed some threshold, in order to determine which term is culpable. often this is done for debugging purposes. </para>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_PointAccel.F90" line="8" column="1"/>
  </compounddef>
</doxygen>
