<?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.14">
  <compounddef id="namespaceidealized__hurricane" kind="namespace" language="Fortran">
    <compoundname>idealized_hurricane</compoundname>
    <innerclass refid="structidealized__hurricane_1_1idealized__hurricane__cs" prot="public">idealized_hurricane::idealized_hurricane_cs</innerclass>
      <sectiondef kind="var">
      <memberdef kind="variable" id="namespaceidealized__hurricane_1ab00b0e78aa89c5166eaddf09850bf04a" prot="public" static="no" mutable="no">
        <type><ref refid="version__variable_8h_1acda997fe1761de4c6bca0f27dc786964" kindref="member">character</ref>(len=40)</type>
        <definition>character(len=40) idealized_hurricane::mdl</definition>
        <argsstring></argsstring>
        <name>mdl</name>
        <initializer>= &quot;idealized_hurricane&quot;</initializer>
        <briefdescription>
<para>This module&apos;s name. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/Idealized_Hurricane.F90" line="90" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/Idealized_Hurricane.F90" bodystart="90" bodyend="90"/>
        <referencedby refid="namespaceidealized__hurricane_1ac4f888915491b3415da1fa457e5a2996" compoundref="Idealized__Hurricane_8F90" startline="96" endline="204">idealized_hurricane_wind_init</referencedby>
      </memberdef>
      </sectiondef>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespaceidealized__hurricane_1ac4f888915491b3415da1fa457e5a2996" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public idealized_hurricane::idealized_hurricane_wind_init</definition>
        <argsstring>(Time, G, US, param_file, CS)</argsstring>
        <name>idealized_hurricane_wind_init</name>
        <param>
          <type>Time</type>
          <defname>Time</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>Initializes wind profile for the SCM idealized hurricane example. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">time</parametername>
</parameternamelist>
<parameterdescription>
<para>Model time</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>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>Input parameter structure</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Parameter container for this module </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/Idealized_Hurricane.F90" line="95" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/Idealized_Hurricane.F90" bodystart="96" bodyend="204"/>
        <references refid="namespaceidealized__hurricane_1ab00b0e78aa89c5166eaddf09850bf04a" compoundref="Idealized__Hurricane_8F90" startline="90" endline="90">mdl</references>
        <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="namespaceidealized__hurricane_1a4474412268bd5b8b4d419d7f5d2ad621" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public idealized_hurricane::idealized_hurricane_wind_forcing</definition>
        <argsstring>(sfc_state, forces, day, G, US, CS)</argsstring>
        <name>idealized_hurricane_wind_forcing</name>
        <param>
          <type>sfc_state</type>
          <defname>sfc_state</defname>
        </param>
        <param>
          <type>forces</type>
          <defname>forces</defname>
        </param>
        <param>
          <type>day</type>
          <defname>day</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>Computes the surface wind for the idealized hurricane test cases. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">sfc_state</parametername>
</parameternamelist>
<parameterdescription>
<para>Surface state structure</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">forces</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure with the driving mechanical forces</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">day</parametername>
</parameternamelist>
<parameterdescription>
<para>Time in days</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">g</parametername>
</parameternamelist>
<parameterdescription>
<para>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>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Container for idealized hurricane parameters </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
<para>Compute storm center location</para><para>Computes taux</para><para>Computes tauy</para><para>Get Ustar </para>        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/Idealized_Hurricane.F90" line="208" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/Idealized_Hurricane.F90" bodystart="209" bodyend="321"/>
        <references refid="namespaceidealized__hurricane_1a9f7ebac8b7768ca2bd577179c596a93e" compoundref="Idealized__Hurricane_8F90" startline="326" endline="466">idealized_hurricane_wind_profile</references>
      </memberdef>
      <memberdef kind="function" id="namespaceidealized__hurricane_1a9f7ebac8b7768ca2bd577179c596a93e" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine idealized_hurricane::idealized_hurricane_wind_profile</definition>
        <argsstring>(CS, US, absf, YY, XX, UOCN, VOCN, Tx, Ty)</argsstring>
        <name>idealized_hurricane_wind_profile</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>absf</type>
          <defname>absf</defname>
        </param>
        <param>
          <type>YY</type>
          <defname>YY</defname>
        </param>
        <param>
          <type>XX</type>
          <defname>XX</defname>
        </param>
        <param>
          <type>UOCN</type>
          <defname>UOCN</defname>
        </param>
        <param>
          <type>VOCN</type>
          <defname>VOCN</defname>
        </param>
        <param>
          <type>Tx</type>
          <defname>Tx</defname>
        </param>
        <param>
          <type>Ty</type>
          <defname>Ty</defname>
        </param>
        <briefdescription>
<para>Calculate the wind speed at a location as a function of time. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Container for idealized hurricane parameters</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">absf</parametername>
</parameternamelist>
<parameterdescription>
<para>Input Coriolis magnitude [T-1 ~&gt; s-1]</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">yy</parametername>
</parameternamelist>
<parameterdescription>
<para>Location in m relative to center y [L ~&gt; m]</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">xx</parametername>
</parameternamelist>
<parameterdescription>
<para>Location in m relative to center x [L ~&gt; m]</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">uocn</parametername>
</parameternamelist>
<parameterdescription>
<para>X surface current [L T-1 ~&gt; m s-1]</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">vocn</parametername>
</parameternamelist>
<parameterdescription>
<para>Y surface current [L T-1 ~&gt; m s-1]</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">tx</parametername>
</parameternamelist>
<parameterdescription>
<para>X stress [R L Z T-2 ~&gt; Pa]</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">ty</parametername>
</parameternamelist>
<parameterdescription>
<para>Y stress [R L Z T-2 ~&gt; Pa] </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/Idealized_Hurricane.F90" line="325" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/Idealized_Hurricane.F90" bodystart="326" bodyend="466"/>
        <referencedby refid="namespaceidealized__hurricane_1a4474412268bd5b8b4d419d7f5d2ad621" compoundref="Idealized__Hurricane_8F90" startline="209" endline="321">idealized_hurricane_wind_forcing</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespaceidealized__hurricane_1ab2c6ed6b1c15a8c0c860157cb3de1efd" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public idealized_hurricane::scm_idealized_hurricane_wind_forcing</definition>
        <argsstring>(sfc_state, forces, day, G, US, CS)</argsstring>
        <name>scm_idealized_hurricane_wind_forcing</name>
        <param>
          <type>sfc_state</type>
          <defname>sfc_state</defname>
        </param>
        <param>
          <type>forces</type>
          <defname>forces</defname>
        </param>
        <param>
          <type>day</type>
          <defname>day</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>This subroutine is primarily needed as a legacy for reproducing answers. It is included as an additional subroutine rather than padded into the previous routine with flags to ease its eventual removal. Its functionality is replaced with the new routines and it can be deleted when answer changes are acceptable. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">sfc_state</parametername>
</parameternamelist>
<parameterdescription>
<para>Surface state structure</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">forces</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure with the driving mechanical forces</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">day</parametername>
</parameternamelist>
<parameterdescription>
<para>Time in days</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">g</parametername>
</parameternamelist>
<parameterdescription>
<para>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>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Container for SCM parameters </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/Idealized_Hurricane.F90" line="473" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/Idealized_Hurricane.F90" bodystart="474" bodyend="661"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Forcing for the idealized hurricane and SCM_idealized_hurricane examples. </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/user/Idealized_Hurricane.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
