<?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="structmom__wave__speed_1_1wave__speed__cs" kind="type" language="Fortran" prot="public">
    <compoundname>mom_wave_speed::wave_speed_cs</compoundname>
      <sectiondef kind="public-attrib">
      <memberdef kind="variable" id="structmom__wave__speed_1_1wave__speed__cs_1a21e9abf2840922f805d71c8d85df92d9" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical mom_wave_speed::wave_speed_cs::use_ebt_mode</definition>
        <argsstring></argsstring>
        <name>use_ebt_mode</name>
        <initializer>= .false.</initializer>
        <briefdescription>
<para>If true, calculate the equivalent barotropic wave speed instead of the first baroclinic wave speed. This parameter controls the default behavior of <ref refid="namespacemom__wave__speed_1a936732268d9f4097149adb82b393cf39" kindref="member">wave_speed()</ref> which can be overridden by optional arguments. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_wave_speed.F90" line="29" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_wave_speed.F90" bodystart="29" bodyend="29"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__wave__speed_1_1wave__speed__cs_1a7fc5dfd1e7941bf61fbc075e3284c8ee" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical mom_wave_speed::wave_speed_cs::better_cg1_est</definition>
        <argsstring></argsstring>
        <name>better_cg1_est</name>
        <initializer>= .false.</initializer>
        <briefdescription>
<para>If true, use an improved estimate of the first mode internal wave speed. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_wave_speed.F90" line="33" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_wave_speed.F90" bodystart="33" bodyend="33"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__wave__speed_1_1wave__speed__cs_1a68bc3cf5460e439bc3a69e244af86952" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real mom_wave_speed::wave_speed_cs::mono_n2_column_fraction</definition>
        <argsstring></argsstring>
        <name>mono_n2_column_fraction</name>
        <initializer>= 0.</initializer>
        <briefdescription>
<para>The lower fraction of water column over which N2 is limited as monotonic for the purposes of calculating the equivalent barotropic wave speed. This parameter controls the default behavior of <ref refid="namespacemom__wave__speed_1a936732268d9f4097149adb82b393cf39" kindref="member">wave_speed()</ref> which can be overridden by optional arguments. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_wave_speed.F90" line="35" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_wave_speed.F90" bodystart="35" bodyend="35"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__wave__speed_1_1wave__speed__cs_1a94a7b23d5ba481a4355a49456bbdf739" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real mom_wave_speed::wave_speed_cs::mono_n2_depth</definition>
        <argsstring></argsstring>
        <name>mono_n2_depth</name>
        <initializer>= -1.</initializer>
        <briefdescription>
<para>The depth below which N2 is limited as monotonic for the purposes of calculating the equivalent barotropic wave speed [Z ~&gt; m]. This parameter controls the default behavior of <ref refid="namespacemom__wave__speed_1a936732268d9f4097149adb82b393cf39" kindref="member">wave_speed()</ref> which can be overridden by optional arguments. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_wave_speed.F90" line="39" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_wave_speed.F90" bodystart="39" bodyend="39"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__wave__speed_1_1wave__speed__cs_1a7458be9c8500bcf48a5cc45431cc0bdd" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real mom_wave_speed::wave_speed_cs::min_speed2</definition>
        <argsstring></argsstring>
        <name>min_speed2</name>
        <initializer>= 0.</initializer>
        <briefdescription>
<para>The minimum mode 1 internal wave speed squared [L2 T-2 ~&gt; m2 s-2]. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_wave_speed.F90" line="43" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_wave_speed.F90" bodystart="43" bodyend="43"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__wave__speed_1_1wave__speed__cs_1a97461b0bbaea00678dbecc63f370ea5e" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real mom_wave_speed::wave_speed_cs::wave_speed_tol</definition>
        <argsstring></argsstring>
        <name>wave_speed_tol</name>
        <initializer>= 0.001</initializer>
        <briefdescription>
<para>The fractional tolerance with which to solve for the wave speeds [nondim]. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_wave_speed.F90" line="44" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_wave_speed.F90" bodystart="44" bodyend="44"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__wave__speed_1_1wave__speed__cs_1ac386de2353df58fdf5f2a12c9ea9229f" prot="public" static="no" mutable="no">
        <type>type(remapping_cs)</type>
        <definition>type(remapping_cs) mom_wave_speed::wave_speed_cs::remapping_cs</definition>
        <argsstring></argsstring>
        <name>remapping_cs</name>
        <briefdescription>
<para>Used for vertical remapping when calculating equivalent barotropic mode structure. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_wave_speed.F90" line="46" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_wave_speed.F90" bodystart="46" bodyend="46"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__wave__speed_1_1wave__speed__cs_1adf6dcd54c4103b2a79b7118241fee8c5" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical mom_wave_speed::wave_speed_cs::remap_answers_2018</definition>
        <argsstring></argsstring>
        <name>remap_answers_2018</name>
        <initializer>= .true.</initializer>
        <briefdescription>
<para>If true, use the order of arithmetic and expressions that recover the remapping answers from 2018. If false, use more robust forms of the same remapping expressions. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_wave_speed.F90" line="48" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_wave_speed.F90" bodystart="48" bodyend="48"/>
      </memberdef>
      <memberdef kind="variable" id="structmom__wave__speed_1_1wave__speed__cs_1a2c93a316aed8fe0dc700e109ac974a8d" prot="public" static="no" mutable="no">
        <type>type(diag_ctrl), pointer</type>
        <definition>type(diag_ctrl), pointer mom_wave_speed::wave_speed_cs::diag</definition>
        <argsstring></argsstring>
        <name>diag</name>
        <briefdescription>
<para>Diagnostics control structure. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_wave_speed.F90" line="51" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_wave_speed.F90" bodystart="51" bodyend="51"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Control structure for MOM_wave_speed. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <collaborationgraph>
      <node id="5">
        <label>real</label>
      </node>
      <node id="2">
        <label>logical</label>
      </node>
      <node id="3">
        <label>remapping_cs</label>
      </node>
      <node id="1">
        <label>mom_wave_speed::wave_speed_cs</label>
        <link refid="structmom__wave__speed_1_1wave__speed__cs"/>
        <childnode refid="2" relation="usage">
          <edgelabel>remap_answers_2018</edgelabel>
          <edgelabel>better_cg1_est</edgelabel>
          <edgelabel>use_ebt_mode</edgelabel>
        </childnode>
        <childnode refid="3" relation="usage">
          <edgelabel>remapping_cs</edgelabel>
        </childnode>
        <childnode refid="4" relation="usage">
          <edgelabel>diag</edgelabel>
        </childnode>
        <childnode refid="5" relation="usage">
          <edgelabel>mono_n2_depth</edgelabel>
          <edgelabel>wave_speed_tol</edgelabel>
          <edgelabel>mono_n2_column_fraction</edgelabel>
          <edgelabel>min_speed2</edgelabel>
        </childnode>
      </node>
      <node id="4">
        <label>diag_ctrl</label>
      </node>
    </collaborationgraph>
    <location file="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_wave_speed.F90" line="28" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_wave_speed.F90" bodystart="28" bodyend="52"/>
    <listofallmembers>
      <member refid="structmom__wave__speed_1_1wave__speed__cs_1a7fc5dfd1e7941bf61fbc075e3284c8ee" prot="public" virt="non-virtual"><scope>mom_wave_speed::wave_speed_cs</scope><name>better_cg1_est</name></member>
      <member refid="structmom__wave__speed_1_1wave__speed__cs_1a2c93a316aed8fe0dc700e109ac974a8d" prot="public" virt="non-virtual"><scope>mom_wave_speed::wave_speed_cs</scope><name>diag</name></member>
      <member refid="structmom__wave__speed_1_1wave__speed__cs_1a7458be9c8500bcf48a5cc45431cc0bdd" prot="public" virt="non-virtual"><scope>mom_wave_speed::wave_speed_cs</scope><name>min_speed2</name></member>
      <member refid="structmom__wave__speed_1_1wave__speed__cs_1a68bc3cf5460e439bc3a69e244af86952" prot="public" virt="non-virtual"><scope>mom_wave_speed::wave_speed_cs</scope><name>mono_n2_column_fraction</name></member>
      <member refid="structmom__wave__speed_1_1wave__speed__cs_1a94a7b23d5ba481a4355a49456bbdf739" prot="public" virt="non-virtual"><scope>mom_wave_speed::wave_speed_cs</scope><name>mono_n2_depth</name></member>
      <member refid="structmom__wave__speed_1_1wave__speed__cs_1adf6dcd54c4103b2a79b7118241fee8c5" prot="public" virt="non-virtual"><scope>mom_wave_speed::wave_speed_cs</scope><name>remap_answers_2018</name></member>
      <member refid="structmom__wave__speed_1_1wave__speed__cs_1ac386de2353df58fdf5f2a12c9ea9229f" prot="public" virt="non-virtual"><scope>mom_wave_speed::wave_speed_cs</scope><name>remapping_cs</name></member>
      <member refid="structmom__wave__speed_1_1wave__speed__cs_1a21e9abf2840922f805d71c8d85df92d9" prot="public" virt="non-virtual"><scope>mom_wave_speed::wave_speed_cs</scope><name>use_ebt_mode</name></member>
      <member refid="structmom__wave__speed_1_1wave__speed__cs_1a97461b0bbaea00678dbecc63f370ea5e" prot="public" virt="non-virtual"><scope>mom_wave_speed::wave_speed_cs</scope><name>wave_speed_tol</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
