<?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.19" xml:lang="en-US">
  <compounddef id="namespacemom__verticalgrid" kind="namespace" language="Fortran">
    <compoundname>mom_verticalgrid</compoundname>
    <innerclass refid="structmom__verticalgrid_1_1verticalgrid__type" prot="public">mom_verticalgrid::verticalgrid_type</innerclass>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacemom__verticalgrid_1a2fbde8b173a9ce56fbd41e5b96d4b2f8" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_verticalgrid::verticalgridinit</definition>
        <argsstring>(param_file, GV, US)</argsstring>
        <name>verticalgridinit</name>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <briefdescription>
<para>Allocates and initializes the ocean model vertical grid structure. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>Parameter file handle/type </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>gv</parametername>
</parameternamelist>
<parameterdescription>
<para>The container for vertical grid data </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">us</parametername>
</parameternamelist>
<parameterdescription>
<para>A dimensional unit scaling type </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_verticalGrid.F90" line="75" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_verticalGrid.F90" bodystart="76" bodyend="178"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <referencedby refid="namespacemom__oda__driver__mod_1aaaf67b8d0e0db3ba3dfe09e24d2b8b24" compoundref="MOM__oda__driver_8F90" startline="115" endline="303">mom_oda_driver_mod::init_oda</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__verticalgrid_1af1789a763ad75b54bbbf61daf1153f06" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_verticalgrid::fix_restart_scaling</definition>
        <argsstring>(GV)</argsstring>
        <name>fix_restart_scaling</name>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <briefdescription>
<para>Set the scaling factors for restart files to the scaling factors for this run. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>The ocean&apos;s vertical grid structure </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_verticalGrid.F90" line="182" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_verticalGrid.F90" bodystart="183" bodyend="185"/>
      </memberdef>
      <memberdef kind="function" id="namespacemom__verticalgrid_1a1eea13d63bdc910462ffba406d32fe04" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="version__variable_8h_1acda997fe1761de4c6bca0f27dc786964" kindref="member">character</ref>(len=48) function, public</type>
        <definition>character(len=48) function, public mom_verticalgrid::get_thickness_units</definition>
        <argsstring>(GV)</argsstring>
        <name>get_thickness_units</name>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <briefdescription>
<para>Returns the model&apos;s thickness units, usually m or kg/m^2. </para>
        </briefdescription>
        <detaileddescription>
<para><simplesect kind="return"><para>The vertical thickness units </para>
</simplesect>
<parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>The ocean&apos;s vertical grid structure </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_verticalGrid.F90" line="189" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_verticalGrid.F90" bodystart="190" bodyend="200"/>
        <referencedby refid="namespacemom__ale_1ac9b603b29f630dc8498e35a0e5c16a53" compoundref="MOM__ALE_8F90" startline="250" endline="284">mom_ale::ale_register_diags</referencedby>
        <referencedby refid="namespacemom__diabatic__driver_1a51d273bae7e5d2217fa5498620532888" compoundref="MOM__diabatic__driver_8F90" startline="3147" endline="3727">mom_diabatic_driver::diabatic_driver_init</referencedby>
        <referencedby refid="namespacemom__geothermal_1a1b764e98a70404c9a13909f01068389c" compoundref="MOM__geothermal_8F90" startline="503" endline="606">mom_geothermal::geothermal_init</referencedby>
        <referencedby refid="namespacemom_1af0f791729b0ccb6cb8ae2f4d28edee21" compoundref="MOM_8F90" startline="2824" endline="2850">mom::register_diags</referencedby>
        <referencedby refid="namespacemom__diagnostics_1ac16b7c49e4a4b5ea2beb426bc5270ee9" compoundref="MOM__diagnostics_8F90" startline="1953" endline="1999">mom_diagnostics::register_transport_diags</referencedby>
        <referencedby refid="namespacemom_1a76cb0af280a5c9e877dc206a6849b46b" compoundref="MOM_8F90" startline="2896" endline="2958">mom::set_restart_fields</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__verticalgrid_1af027c312e660a932b3f430f4c7a9675d" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="version__variable_8h_1acda997fe1761de4c6bca0f27dc786964" kindref="member">character</ref>(len=48) function, public</type>
        <definition>character(len=48) function, public mom_verticalgrid::get_flux_units</definition>
        <argsstring>(GV)</argsstring>
        <name>get_flux_units</name>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <briefdescription>
<para>Returns the model&apos;s thickness flux units, usually m^3/s or kg/s. </para>
        </briefdescription>
        <detaileddescription>
<para><simplesect kind="return"><para>The thickness flux units </para>
</simplesect>
<parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>The ocean&apos;s vertical grid structure </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_verticalGrid.F90" line="204" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_verticalGrid.F90" bodystart="205" bodyend="215"/>
        <referencedby refid="namespacemom__dynamics__split__rk2_1a3995d7e0c8fb36abdc7166ea4fe586d1" compoundref="MOM__dynamics__split__RK2_8F90" startline="1077" endline="1438">mom_dynamics_split_rk2::initialize_dyn_split_rk2</referencedby>
        <referencedby refid="namespacemom__dynamics__unsplit_1aa428b0ad5ed3e6cbbb1fd83484eba2f8" compoundref="MOM__dynamics__unsplit_8F90" startline="560" endline="704">mom_dynamics_unsplit::initialize_dyn_unsplit</referencedby>
        <referencedby refid="namespacemom__dynamics__unsplit__rk2_1a900ac5cb7e63b6b9872123de94f147d7" compoundref="MOM__dynamics__unsplit__RK2_8F90" startline="508" endline="661">mom_dynamics_unsplit_rk2::initialize_dyn_unsplit_rk2</referencedby>
        <referencedby refid="namespacemom__dynamics__split__rk2_1a9f889b82fd5ed29a854da99d3c929366" compoundref="MOM__dynamics__split__RK2_8F90" startline="1001" endline="1067">mom_dynamics_split_rk2::register_restarts_dyn_split_rk2</referencedby>
        <referencedby refid="namespacemom__dynamics__unsplit_1a5a650785f745fd9cf42e1e014dd2d89a" compoundref="MOM__dynamics__unsplit_8F90" startline="518" endline="552">mom_dynamics_unsplit::register_restarts_dyn_unsplit</referencedby>
        <referencedby refid="namespacemom__dynamics__unsplit__rk2_1a6e670b5eaefad5b2f16b3e00c2788dfb" compoundref="MOM__dynamics__unsplit__RK2_8F90" startline="463" endline="500">mom_dynamics_unsplit_rk2::register_restarts_dyn_unsplit_rk2</referencedby>
        <referencedby refid="namespacemom_1a76cb0af280a5c9e877dc206a6849b46b" compoundref="MOM_8F90" startline="2896" endline="2958">mom::set_restart_fields</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__verticalgrid_1a908fc7025e6cf5d60885dbb7565093cd" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="version__variable_8h_1acda997fe1761de4c6bca0f27dc786964" kindref="member">character</ref>(len=48) function, public</type>
        <definition>character(len=48) function, public mom_verticalgrid::get_tr_flux_units</definition>
        <argsstring>(GV, tr_units, tr_vol_conc_units, tr_mass_conc_units)</argsstring>
        <name>get_tr_flux_units</name>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>tr_units</type>
          <defname>tr_units</defname>
        </param>
        <param>
          <type>tr_vol_conc_units</type>
          <defname>tr_vol_conc_units</defname>
        </param>
        <param>
          <type>tr_mass_conc_units</type>
          <defname>tr_mass_conc_units</defname>
        </param>
        <briefdescription>
<para>Returns the model&apos;s tracer flux units. </para>
        </briefdescription>
        <detaileddescription>
<para><simplesect kind="return"><para>The model&apos;s flux units for a tracer. </para>
</simplesect>
<parameterlist kind="param"><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">tr_units</parametername>
</parameternamelist>
<parameterdescription>
<para>Units for a tracer, for example Celsius or PSU. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">tr_vol_conc_units</parametername>
</parameternamelist>
<parameterdescription>
<para>The concentration units per unit volume, for example if the units are umol m-3, tr_vol_conc_units would be umol. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">tr_mass_conc_units</parametername>
</parameternamelist>
<parameterdescription>
<para>The concentration units per unit mass of sea water, for example if the units are mol kg-1, tr_vol_conc_units would be mol. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_verticalGrid.F90" line="219" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_verticalGrid.F90" bodystart="220" bodyend="271"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <referencedby refid="namespacemom_1a96708b16215666edbfa5b46228f3a200" compoundref="MOM_8F90" startline="1604" endline="2769">mom::initialize_mom</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__verticalgrid_1a0de628611339a946b2b4a1daa7efd181" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_verticalgrid::setverticalgridaxes</definition>
        <argsstring>(Rlay, GV, scale)</argsstring>
        <name>setverticalgridaxes</name>
        <param>
          <type>Rlay</type>
          <defname>Rlay</defname>
        </param>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>scale</type>
          <defname>scale</defname>
        </param>
        <briefdescription>
<para>This sets the coordinate data for the &quot;layer mode&quot; of the isopycnal model. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>The container for vertical grid data </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">rlay</parametername>
</parameternamelist>
<parameterdescription>
<para>The layer target density [R ~&gt; kg m-3] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">scale</parametername>
</parameternamelist>
<parameterdescription>
<para>A unit scaling factor for Rlay </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_verticalGrid.F90" line="275" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_verticalGrid.F90" bodystart="276" bodyend="294"/>
        <referencedby refid="namespacemom__coord__initialization_1a08150041e51696069c49248793248c77" compoundref="MOM__coord__initialization_8F90" startline="40" endline="123">mom_coord_initialization::mom_initialize_coord</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__verticalgrid_1a64fe319acba142cde9c35f21257ff64f" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_verticalgrid::verticalgridend</definition>
        <argsstring>(GV)</argsstring>
        <name>verticalgridend</name>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <briefdescription>
<para>Deallocates the model&apos;s vertical grid structure. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>gv</parametername>
</parameternamelist>
<parameterdescription>
<para>The ocean&apos;s vertical grid structure </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_verticalGrid.F90" line="298" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/core/MOM_verticalGrid.F90" bodystart="299" bodyend="304"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Provides a transparent vertical ocean grid type and supporting routines. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/core/MOM_verticalGrid.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
