<?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.17">
  <compounddef id="namespacemom__regridding" kind="namespace" language="Fortran">
    <compoundname>mom_regridding</compoundname>
    <innerclass refid="structmom__regridding_1_1regridding__cs" prot="public">mom_regridding::regridding_cs</innerclass>
      <sectiondef kind="var">
      <memberdef kind="variable" id="namespacemom__regridding_1a0b3b3b00c51baa3b8652ee98884252e5" prot="public" static="no" mutable="no">
        <type><ref refid="version__variable_8h_1acda997fe1761de4c6bca0f27dc786964" kindref="member">character</ref>(len= *), parameter, public</type>
        <definition>character(len=*), parameter, public mom_regridding::regriddingcoordinatemodedoc</definition>
        <argsstring></argsstring>
        <name>regriddingcoordinatemodedoc</name>
        <initializer>=                  &quot; LAYER - Isopycnal or stacked shallow water layers\n&quot;//                 &quot; ZSTAR, Z* - stretched geopotential z*\n&quot;//                 &quot; SIGMA_SHELF_ZSTAR - stretched geopotential z* ignoring shelf\n&quot;//                 &quot; SIGMA - terrain following coordinates\n&quot;//                 &quot; RHO   - continuous isopycnal\n&quot;//                 &quot; HYCOM1 - HyCOM-like hybrid coordinate\n&quot;//                 &quot; SLIGHT - stretched coordinates above continuous isopycnal\n&quot;//                 &quot; ADAPTIVE - optimize for smooth neutral density surfaces&quot;</initializer>
        <briefdescription>
<para>Documentation for coordinate options. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="145" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="145" bodyend="153"/>
      </memberdef>
      <memberdef kind="variable" id="namespacemom__regridding_1a78401834f39a900c91dca44c7b6e2509" prot="public" static="no" mutable="no">
        <type><ref refid="version__variable_8h_1acda997fe1761de4c6bca0f27dc786964" kindref="member">character</ref>(len= *), parameter, public</type>
        <definition>character(len=*), parameter, public mom_regridding::regriddinginterpschemedoc</definition>
        <argsstring></argsstring>
        <name>regriddinginterpschemedoc</name>
        <initializer>=                  &quot; P1M_H2     (2nd-order accurate)\n&quot;//                 &quot; P1M_H4     (2nd-order accurate)\n&quot;//                 &quot; P1M_IH4    (2nd-order accurate)\n&quot;//                 &quot; PLM        (2nd-order accurate)\n&quot;//                 &quot; PPM_H4     (3rd-order accurate)\n&quot;//                 &quot; PPM_IH4    (3rd-order accurate)\n&quot;//                 &quot; P3M_IH4IH3 (4th-order accurate)\n&quot;//                 &quot; P3M_IH6IH5 (4th-order accurate)\n&quot;//                 &quot; PQM_IH4IH3 (4th-order accurate)\n&quot;//                 &quot; PQM_IH6IH5 (5th-order accurate)&quot;</initializer>
        <briefdescription>
<para>Documentation for regridding interpolation schemes. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="156" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="156" bodyend="166"/>
        <referencedby refid="namespacemom__regridding_1a8c91ba68f0906e1fc76b7008caf6288e" compoundref="MOM__regridding_8F90" startline="181" endline="733">initialize_regridding</referencedby>
      </memberdef>
      <memberdef kind="variable" id="namespacemom__regridding_1ab4f3052ef1f1b1ed4395678d6cbdf7ff" prot="public" static="no" mutable="no">
        <type><ref refid="version__variable_8h_1acda997fe1761de4c6bca0f27dc786964" kindref="member">character</ref>(len= *), parameter, public</type>
        <definition>character(len=*), parameter, public mom_regridding::regriddingdefaultinterpscheme</definition>
        <argsstring></argsstring>
        <name>regriddingdefaultinterpscheme</name>
        <initializer>= &quot;P1M_H2&quot;</initializer>
        <briefdescription>
<para>Default interpolation scheme. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="169" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="169" bodyend="169"/>
        <referencedby refid="namespacemom__regridding_1a8c91ba68f0906e1fc76b7008caf6288e" compoundref="MOM__regridding_8F90" startline="181" endline="733">initialize_regridding</referencedby>
      </memberdef>
      <memberdef kind="variable" id="namespacemom__regridding_1ace083ec9749efc2bcb7d3a33b97c0678" prot="public" static="no" mutable="no">
        <type>logical, parameter, public</type>
        <definition>logical, parameter, public mom_regridding::regriddingdefaultboundaryextrapolation</definition>
        <argsstring></argsstring>
        <name>regriddingdefaultboundaryextrapolation</name>
        <initializer>= .false.</initializer>
        <briefdescription>
<para>Default mode for boundary extrapolation. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="171" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="171" bodyend="171"/>
        <referencedby refid="namespacemom__regridding_1a8c91ba68f0906e1fc76b7008caf6288e" compoundref="MOM__regridding_8F90" startline="181" endline="733">initialize_regridding</referencedby>
      </memberdef>
      <memberdef kind="variable" id="namespacemom__regridding_1a219230a6fd36ab9b6ec19109f60fdcee" prot="public" static="no" mutable="no">
        <type>real, parameter, public</type>
        <definition>real, parameter, public mom_regridding::regriddingdefaultminthickness</definition>
        <argsstring></argsstring>
        <name>regriddingdefaultminthickness</name>
        <initializer>= 1.e-3</initializer>
        <briefdescription>
<para>Default minimum thickness for some coordinate generation modes. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="173" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="173" bodyend="173"/>
        <referencedby refid="namespacemom__regridding_1a8c91ba68f0906e1fc76b7008caf6288e" compoundref="MOM__regridding_8F90" startline="181" endline="733">initialize_regridding</referencedby>
      </memberdef>
      </sectiondef>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacemom__regridding_1a8c91ba68f0906e1fc76b7008caf6288e" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_regridding::initialize_regridding</definition>
        <argsstring>(CS, GV, US, max_depth, param_file, mdl, coord_mode, param_prefix, param_suffix)</argsstring>
        <name>initialize_regridding</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>max_depth</type>
          <defname>max_depth</defname>
        </param>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>mdl</type>
          <defname>mdl</defname>
        </param>
        <param>
          <type>coord_mode</type>
          <defname>coord_mode</defname>
        </param>
        <param>
          <type>param_prefix</type>
          <defname>param_prefix</defname>
        </param>
        <param>
          <type>param_suffix</type>
          <defname>param_suffix</defname>
        </param>
        <briefdescription>
<para>Initialization and configures a regridding control structure based on customizable run-time parameters. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean 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">max_depth</parametername>
</parameternamelist>
<parameterdescription>
<para>The maximum depth of the ocean [Z ~&gt; m]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>Parameter file </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">mdl</parametername>
</parameternamelist>
<parameterdescription>
<para>Name of calling module. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">coord_mode</parametername>
</parameternamelist>
<parameterdescription>
<para>Coordinate mode </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">param_prefix</parametername>
</parameternamelist>
<parameterdescription>
<para>String to prefix to parameter names. If empty, causes main model parameters to be used. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">param_suffix</parametername>
</parameternamelist>
<parameterdescription>
<para>String to append to parameter names. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="180" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="181" bodyend="733"/>
        <references refid="namespacemom__regridding_1ad4abdb8447ed3f4f769b822a468728b1" compoundref="MOM__regridding_8F90" startline="738" endline="789">check_grid_def</references>
        <references refid="namespacemom__regridding_1a2becd8126867cdce125b31e07d13065e" compoundref="MOM__regridding_8F90" startline="2418" endline="2441">dz_function1</references>
        <references refid="namespacemom__string__functions_1aae12046c1401f23bd7e038655e30654e" compoundref="MOM__string__functions_8F90" startline="246" endline="265">mom_string_functions::extract_integer</references>
        <references refid="namespacemom__string__functions_1a2f700337c5cf4e70a48bd0663570484e" compoundref="MOM__string__functions_8F90" startline="270" endline="289">mom_string_functions::extract_real</references>
        <references refid="namespacemom__string__functions_1a7bfdab6bba33230cc94ed625e95022c9" compoundref="MOM__string__functions_8F90" startline="198" endline="202">mom_string_functions::extractword</references>
        <references refid="namespacemom__regridding_1ad9614000d524a78e043d52f9734314e0" compoundref="MOM__regridding_8F90" startline="1973" endline="1997">initcoord</references>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <references refid="namespaceregrid__consts_1a227622bf8cf9a62a3dbe5ed6643baaf1" compoundref="regrid__consts_8F90" startline="23" endline="23">regrid_consts::regridding_adaptive</references>
        <references refid="namespaceregrid__consts_1a303726845f77761e06fa320a43848af7" compoundref="regrid__consts_8F90" startline="18" endline="18">regrid_consts::regridding_hycom1</references>
        <references refid="namespaceregrid__consts_1ab0d778e07655fc8187df01b4864d662a" compoundref="regrid__consts_8F90" startline="19" endline="19">regrid_consts::regridding_slight</references>
        <references refid="namespacemom__regridding_1ace083ec9749efc2bcb7d3a33b97c0678" compoundref="MOM__regridding_8F90" startline="171" endline="171">regriddingdefaultboundaryextrapolation</references>
        <references refid="namespacemom__regridding_1ab4f3052ef1f1b1ed4395678d6cbdf7ff" compoundref="MOM__regridding_8F90" startline="169" endline="169">regriddingdefaultinterpscheme</references>
        <references refid="namespacemom__regridding_1a219230a6fd36ab9b6ec19109f60fdcee" compoundref="MOM__regridding_8F90" startline="173" endline="173">regriddingdefaultminthickness</references>
        <references refid="namespacemom__regridding_1a78401834f39a900c91dca44c7b6e2509" compoundref="MOM__regridding_8F90" startline="156" endline="166">regriddinginterpschemedoc</references>
        <references refid="namespacemom__regridding_1a64758b08fbd1d2a98d4d7de593fb49be" compoundref="MOM__regridding_8F90" startline="2447" endline="2468">rho_function1</references>
        <references refid="namespacemom__regridding_1aac547ec199090852d539c7aefc44dfa7" compoundref="MOM__regridding_8F90" startline="2057" endline="2090">set_regrid_max_depths</references>
        <references refid="namespacemom__regridding_1ae91ca3f1376b3c72940268b5d9f87bb4" compoundref="MOM__regridding_8F90" startline="2095" endline="2116">set_regrid_max_thickness</references>
        <references refid="namespacemom__regridding_1a88398318fb996137b3f0d79b7fc8c4e9" compoundref="MOM__regridding_8F90" startline="2246" endline="2343">set_regrid_params</references>
        <references refid="namespacemom__regridding_1ae7eade38ab8e2adb0797a7191ddebb18" compoundref="MOM__regridding_8F90" startline="2043" endline="2052">set_target_densities</references>
        <references refid="namespacemom__regridding_1ab6ada39c6f95e652907bab93f9c5a3f1" compoundref="MOM__regridding_8F90" startline="2020" endline="2038">set_target_densities_from_gv</references>
        <references refid="namespacemom__regridding_1a162e9f816bc892550624d781fdddd6ca" compoundref="MOM__regridding_8F90" startline="2003" endline="2015">setcoordinateresolution</references>
        <references refid="namespacemom__regridding_1a8b3b0c1555006f196d9bb1baededd9e6" compoundref="MOM__regridding_8F90" startline="1932" endline="1967">uniformresolution</references>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1ad4abdb8447ed3f4f769b822a468728b1" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_regridding::check_grid_def</definition>
        <argsstring>(filename, varname, expected_units, msg, ierr)</argsstring>
        <name>check_grid_def</name>
        <param>
          <type>filename</type>
          <defname>filename</defname>
        </param>
        <param>
          <type>varname</type>
          <defname>varname</defname>
        </param>
        <param>
          <type>expected_units</type>
          <defname>expected_units</defname>
        </param>
        <param>
          <type>msg</type>
          <defname>msg</defname>
        </param>
        <param>
          <type>ierr</type>
          <defname>ierr</defname>
        </param>
        <briefdescription>
<para>Do some basic checks on the vertical grid definition file, variable. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">filename</parametername>
</parameternamelist>
<parameterdescription>
<para>File name </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">varname</parametername>
</parameternamelist>
<parameterdescription>
<para>Variable name </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">expected_units</parametername>
</parameternamelist>
<parameterdescription>
<para>Expected units of variable </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">msg</parametername>
</parameternamelist>
<parameterdescription>
<para>Message to use for errors </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">ierr</parametername>
</parameternamelist>
<parameterdescription>
<para>True if an error occurs </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="737" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="738" bodyend="789"/>
        <referencedby refid="namespacemom__regridding_1a8c91ba68f0906e1fc76b7008caf6288e" compoundref="MOM__regridding_8F90" startline="181" endline="733">initialize_regridding</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1a9f55ab3a80ab1202b7664e9c65ebf08b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_regridding::end_regridding</definition>
        <argsstring>(CS)</argsstring>
        <name>end_regridding</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>Deallocation of regridding memory. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="793" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="794" bodyend="807"/>
        <references refid="namespacecoord__adapt_1a92e88dea18cc4b3adef844f58a8fc0ff" compoundref="coord__adapt_8F90" startline="80" endline="85">coord_adapt::end_coord_adapt</references>
        <references refid="namespacecoord__hycom_1a30900d0417dacf88c60419208a8818e4" compoundref="coord__hycom_8F90" startline="60" endline="68">coord_hycom::end_coord_hycom</references>
        <references refid="namespacecoord__sigma_1ac2489166e8a1e3e891b2e05df3b8d422" compoundref="coord__sigma_8F90" startline="43" endline="48">coord_sigma::end_coord_sigma</references>
        <references refid="namespacecoord__slight_1af5e8c8c13ad380620be3d8907738ed38" compoundref="coord__slight_8F90" startline="105" endline="110">coord_slight::end_coord_slight</references>
        <references refid="namespacecoord__zlike_1ad51a91fb635a0a5c29fa40bc2534f7b4" compoundref="coord__zlike_8F90" startline="44" endline="49">coord_zlike::end_coord_zlike</references>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1ab354fe3423a39fef6f2b66f409b1682c" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_regridding::regridding_main</definition>
        <argsstring>(remapCS, CS, G, GV, h, tv, h_new, dzInterface, frac_shelf_h, conv_adjust)</argsstring>
        <name>regridding_main</name>
        <param>
          <type>remapCS</type>
          <defname>remapCS</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>tv</type>
          <defname>tv</defname>
        </param>
        <param>
          <type>h_new</type>
          <defname>h_new</defname>
        </param>
        <param>
          <type>dzInterface</type>
          <defname>dzInterface</defname>
        </param>
        <param>
          <type>frac_shelf_h</type>
          <defname>frac_shelf_h</defname>
        </param>
        <param>
          <type>conv_adjust</type>
          <defname>conv_adjust</defname>
        </param>
        <briefdescription>
<para>Dispatching regridding routine for orchestrating regridding &amp; remapping. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">remapcs</parametername>
</parameternamelist>
<parameterdescription>
<para>Remapping parameters and options </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </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>Ocean vertical grid structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">h</parametername>
</parameternamelist>
<parameterdescription>
<para>Current 3D grid obtained after the last time step </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">tv</parametername>
</parameternamelist>
<parameterdescription>
<para>Thermodynamical variables (T, S, ...) </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">h_new</parametername>
</parameternamelist>
<parameterdescription>
<para>New 3D grid consistent with target coordinate </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">dzinterface</parametername>
</parameternamelist>
<parameterdescription>
<para>The change in position of each interface </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>frac_shelf_h</parametername>
</parameternamelist>
<parameterdescription>
<para>Fractional ice shelf coverage </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">conv_adjust</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, do convective adjustment </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="812" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="813" bodyend="902"/>
        <references refid="namespacemom__regridding_1aa57d2b70fe2247b5fd8283d7e3fb2cfd" compoundref="MOM__regridding_8F90" startline="1533" endline="1587">build_grid_adaptive</references>
        <references refid="namespacemom__regridding_1a53fe5957610e488f1fb9052ff69007ec" compoundref="MOM__regridding_8F90" startline="1727" endline="1820">build_grid_arbitrary</references>
        <references refid="namespacemom__regridding_1a74433d7b55b2ba3a333553563d55089f" compoundref="MOM__regridding_8F90" startline="1461" endline="1527">build_grid_hycom1</references>
        <references refid="namespacemom__regridding_1a63b857ebd60054fd49dca31d7f10d2d0" compoundref="MOM__regridding_8F90" startline="1600" endline="1661">build_grid_slight</references>
        <references refid="namespacemom__regridding_1aa3db078bb52a4993c82d35c1b250a898" compoundref="MOM__regridding_8F90" startline="1328" endline="1450">build_rho_grid</references>
        <references refid="namespacemom__regridding_1a455d807ccfbbfd109be231321bec1038" compoundref="MOM__regridding_8F90" startline="1249" endline="1320">build_sigma_grid</references>
        <references refid="namespacemom__regridding_1a55e6873a74355daea004d39c452e0069" compoundref="MOM__regridding_8F90" startline="1159" endline="1242">build_zstar_grid</references>
        <references refid="namespacemom__regridding_1a8dd75489564f85609033f53c0cb16cbb" compoundref="MOM__regridding_8F90" startline="907" endline="937">calc_h_new_by_dz</references>
        <references refid="namespacemom__regridding_1a810d6a0658d645ac7a9e2b6680ce819c" compoundref="MOM__regridding_8F90" startline="942" endline="955">check_remapping_grid</references>
        <references refid="namespacemom__regridding_1aac58190f39678cb94e0f918455804f43" compoundref="MOM__regridding_8F90" startline="1870" endline="1925">convective_adjustment</references>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <references refid="namespaceregrid__consts_1a227622bf8cf9a62a3dbe5ed6643baaf1" compoundref="regrid__consts_8F90" startline="23" endline="23">regrid_consts::regridding_adaptive</references>
        <references refid="namespaceregrid__consts_1a303726845f77761e06fa320a43848af7" compoundref="regrid__consts_8F90" startline="18" endline="18">regrid_consts::regridding_hycom1</references>
        <references refid="namespaceregrid__consts_1ab0d778e07655fc8187df01b4864d662a" compoundref="regrid__consts_8F90" startline="19" endline="19">regrid_consts::regridding_slight</references>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1a8dd75489564f85609033f53c0cb16cbb" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_regridding::calc_h_new_by_dz</definition>
        <argsstring>(CS, G, GV, h, dzInterface, h_new)</argsstring>
        <name>calc_h_new_by_dz</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>dzInterface</type>
          <defname>dzInterface</defname>
        </param>
        <param>
          <type>h_new</type>
          <defname>h_new</defname>
        </param>
        <briefdescription>
<para>Calculates h_new from h + delta_k dzInterface. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Grid structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean vertical grid structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h</parametername>
</parameternamelist>
<parameterdescription>
<para>Old layer thicknesses (arbitrary units) </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dzinterface</parametername>
</parameternamelist>
<parameterdescription>
<para>Change in interface positions (same as h) </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">h_new</parametername>
</parameternamelist>
<parameterdescription>
<para>New layer thicknesses (same as h) </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="906" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="907" bodyend="937"/>
        <referencedby refid="namespacemom__regridding_1a74433d7b55b2ba3a333553563d55089f" compoundref="MOM__regridding_8F90" startline="1461" endline="1527">build_grid_hycom1</referencedby>
        <referencedby refid="namespacemom__regridding_1ab354fe3423a39fef6f2b66f409b1682c" compoundref="MOM__regridding_8F90" startline="813" endline="902">regridding_main</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1a810d6a0658d645ac7a9e2b6680ce819c" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_regridding::check_remapping_grid</definition>
        <argsstring>(G, GV, h, dzInterface, msg)</argsstring>
        <name>check_remapping_grid</name>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>dzInterface</type>
          <defname>dzInterface</defname>
        </param>
        <param>
          <type>msg</type>
          <defname>msg</defname>
        </param>
        <briefdescription>
<para>Check that the total thickness of two grids match. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Grid structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean vertical grid structure </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">dzinterface</parametername>
</parameternamelist>
<parameterdescription>
<para>Change in interface positions [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">msg</parametername>
</parameternamelist>
<parameterdescription>
<para>Message to append to errors </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="941" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="942" bodyend="955"/>
        <references refid="namespacemom__regridding_1ab2a6be87039f49176d91a494126d8430" compoundref="MOM__regridding_8F90" startline="960" endline="1012">check_grid_column</references>
        <referencedby refid="namespacemom__regridding_1ab354fe3423a39fef6f2b66f409b1682c" compoundref="MOM__regridding_8F90" startline="813" endline="902">regridding_main</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1ab2a6be87039f49176d91a494126d8430" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_regridding::check_grid_column</definition>
        <argsstring>(nk, depth, h, dzInterface, msg)</argsstring>
        <name>check_grid_column</name>
        <param>
          <type>nk</type>
          <defname>nk</defname>
        </param>
        <param>
          <type>depth</type>
          <defname>depth</defname>
        </param>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>dzInterface</type>
          <defname>dzInterface</defname>
        </param>
        <param>
          <type>msg</type>
          <defname>msg</defname>
        </param>
        <briefdescription>
<para>Check that the total thickness of new and old grids are consistent. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">nk</parametername>
</parameternamelist>
<parameterdescription>
<para>Number of cells </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">depth</parametername>
</parameternamelist>
<parameterdescription>
<para>Depth of bottom [Z ~&gt; m] or arbitrary units </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h</parametername>
</parameternamelist>
<parameterdescription>
<para>Cell thicknesses [Z ~&gt; m] or arbitrary units </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dzinterface</parametername>
</parameternamelist>
<parameterdescription>
<para>Change in interface positions (same units as h) </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">msg</parametername>
</parameternamelist>
<parameterdescription>
<para>Message to append to errors </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="959" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="960" bodyend="1012"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <referencedby refid="namespacemom__regridding_1a810d6a0658d645ac7a9e2b6680ce819c" compoundref="MOM__regridding_8F90" startline="942" endline="955">check_remapping_grid</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1a9dddf53999f90d1a4edc79179c5b5da4" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_regridding::filtered_grid_motion</definition>
        <argsstring>(CS, nk, z_old, z_new, dz_g)</argsstring>
        <name>filtered_grid_motion</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>nk</type>
          <defname>nk</defname>
        </param>
        <param>
          <type>z_old</type>
          <defname>z_old</defname>
        </param>
        <param>
          <type>z_new</type>
          <defname>z_new</defname>
        </param>
        <param>
          <type>dz_g</type>
          <defname>dz_g</defname>
        </param>
        <briefdescription>
<para>Returns the change in interface position motion after filtering and assuming the top and bottom interfaces do not move. The filtering is a function of depth, and is applied as the integrated average filtering over the trajectory of the interface. By design, this code can not give tangled interfaces provided that z_old and z_new are not already tangled. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">nk</parametername>
</parameternamelist>
<parameterdescription>
<para>Number of cells in source grid </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">z_old</parametername>
</parameternamelist>
<parameterdescription>
<para>Old grid position [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">z_new</parametername>
</parameternamelist>
<parameterdescription>
<para>New grid position [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">dz_g</parametername>
</parameternamelist>
<parameterdescription>
<para>Change in interface positions [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="1020" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="1021" bodyend="1152"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <referencedby refid="namespacemom__regridding_1aa57d2b70fe2247b5fd8283d7e3fb2cfd" compoundref="MOM__regridding_8F90" startline="1533" endline="1587">build_grid_adaptive</referencedby>
        <referencedby refid="namespacemom__regridding_1a74433d7b55b2ba3a333553563d55089f" compoundref="MOM__regridding_8F90" startline="1461" endline="1527">build_grid_hycom1</referencedby>
        <referencedby refid="namespacemom__regridding_1a63b857ebd60054fd49dca31d7f10d2d0" compoundref="MOM__regridding_8F90" startline="1600" endline="1661">build_grid_slight</referencedby>
        <referencedby refid="namespacemom__regridding_1aa3db078bb52a4993c82d35c1b250a898" compoundref="MOM__regridding_8F90" startline="1328" endline="1450">build_rho_grid</referencedby>
        <referencedby refid="namespacemom__regridding_1a455d807ccfbbfd109be231321bec1038" compoundref="MOM__regridding_8F90" startline="1249" endline="1320">build_sigma_grid</referencedby>
        <referencedby refid="namespacemom__regridding_1a55e6873a74355daea004d39c452e0069" compoundref="MOM__regridding_8F90" startline="1159" endline="1242">build_zstar_grid</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1a55e6873a74355daea004d39c452e0069" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_regridding::build_zstar_grid</definition>
        <argsstring>(CS, G, GV, h, dzInterface, frac_shelf_h)</argsstring>
        <name>build_zstar_grid</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>dzInterface</type>
          <defname>dzInterface</defname>
        </param>
        <param>
          <type>frac_shelf_h</type>
          <defname>frac_shelf_h</defname>
        </param>
        <briefdescription>
<para>Builds a z*-ccordinate grid with partial steps (Adcroft and Campin, 2004). z* is defined as z* = (z-eta)/(H+eta)*H s.t. z*=0 when z=eta and z*=-H when z=-H . </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </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>ocean vertical grid structure </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="inout">dzinterface</parametername>
</parameternamelist>
<parameterdescription>
<para>The change in interface depth [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>frac_shelf_h</parametername>
</parameternamelist>
<parameterdescription>
<para>Fractional ice shelf coverage [nondim]. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="1158" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="1159" bodyend="1242"/>
        <references refid="namespacemom__regridding_1a7752ab22440e0d5f9a0b11d583acb812" compoundref="MOM__regridding_8F90" startline="1666" endline="1720">adjust_interface_motion</references>
        <references refid="namespacecoord__zlike_1af2bdac8481050f2b0ff7c5fc01f26e1c" compoundref="coord__zlike_8F90" startline="65" endline="141">coord_zlike::build_zstar_column</references>
        <references refid="namespacemom__regridding_1a9dddf53999f90d1a4edc79179c5b5da4" compoundref="MOM__regridding_8F90" startline="1021" endline="1152">filtered_grid_motion</references>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <referencedby refid="namespacemom__regridding_1ab354fe3423a39fef6f2b66f409b1682c" compoundref="MOM__regridding_8F90" startline="813" endline="902">regridding_main</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1a455d807ccfbbfd109be231321bec1038" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_regridding::build_sigma_grid</definition>
        <argsstring>(CS, G, GV, h, dzInterface)</argsstring>
        <name>build_sigma_grid</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>dzInterface</type>
          <defname>dzInterface</defname>
        </param>
        <briefdescription>
<para>This routine builds a grid based on terrain-following coordinates. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </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>ocean vertical grid structure </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="inout">dzinterface</parametername>
</parameternamelist>
<parameterdescription>
<para>The change in interface depth [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="1248" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="1249" bodyend="1320"/>
        <references refid="namespacecoord__sigma_1af3954fd955a967aa2ff11c2fc115dc19" compoundref="coord__sigma_8F90" startline="64" endline="80">coord_sigma::build_sigma_column</references>
        <references refid="namespacemom__regridding_1a9dddf53999f90d1a4edc79179c5b5da4" compoundref="MOM__regridding_8F90" startline="1021" endline="1152">filtered_grid_motion</references>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <referencedby refid="namespacemom__regridding_1ab354fe3423a39fef6f2b66f409b1682c" compoundref="MOM__regridding_8F90" startline="813" endline="902">regridding_main</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1aa3db078bb52a4993c82d35c1b250a898" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_regridding::build_rho_grid</definition>
        <argsstring>(G, GV, US, h, tv, dzInterface, remapCS, CS)</argsstring>
        <name>build_rho_grid</name>
        <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>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>tv</type>
          <defname>tv</defname>
        </param>
        <param>
          <type>dzInterface</type>
          <defname>dzInterface</defname>
        </param>
        <param>
          <type>remapCS</type>
          <defname>remapCS</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>This routine builds a new grid based on a given set of target interface densities. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><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>Ocean 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>Thermodynamics structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">dzinterface</parametername>
</parameternamelist>
<parameterdescription>
<para>The change in interface depth [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">remapcs</parametername>
</parameternamelist>
<parameterdescription>
<para>The remapping control structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="1327" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="1328" bodyend="1450"/>
        <references refid="namespacemom__regridding_1a9dddf53999f90d1a4edc79179c5b5da4" compoundref="MOM__regridding_8F90" startline="1021" endline="1152">filtered_grid_motion</references>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <referencedby refid="namespacemom__regridding_1ab354fe3423a39fef6f2b66f409b1682c" compoundref="MOM__regridding_8F90" startline="813" endline="902">regridding_main</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1a74433d7b55b2ba3a333553563d55089f" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_regridding::build_grid_hycom1</definition>
        <argsstring>(G, GV, US, h, tv, h_new, dzInterface, CS)</argsstring>
        <name>build_grid_hycom1</name>
        <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>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>tv</type>
          <defname>tv</defname>
        </param>
        <param>
          <type>h_new</type>
          <defname>h_new</defname>
        </param>
        <param>
          <type>dzInterface</type>
          <defname>dzInterface</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>Builds a simple HyCOM-like grid with the deepest location of potential density interpolated from the column profile and a clipping of depth for each interface to a fixed z* or p* grid. This should probably be (optionally?) changed to find the nearest location of the target density. </para>
        </briefdescription>
        <detaileddescription>
<para><simplesect kind="remark"><para>{ Based on Bleck, 2002: An oceanice general circulation model framed in hybrid isopycnic-Cartesian coordinates, Ocean Modelling 37, 55-88. <ulink url="http://dx.doi.org/10.1016/S1463-5003(01)00012-9">http://dx.doi.org/10.1016/S1463-5003(01)00012-9</ulink> } </para>
</simplesect>
<parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Grid structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean 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>Existing model thickness [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">tv</parametername>
</parameternamelist>
<parameterdescription>
<para>Thermodynamics structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">h_new</parametername>
</parameternamelist>
<parameterdescription>
<para>New layer thicknesses [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">dzinterface</parametername>
</parameternamelist>
<parameterdescription>
<para>Changes in interface position </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="1460" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="1461" bodyend="1527"/>
        <references refid="namespacemom__regridding_1a7752ab22440e0d5f9a0b11d583acb812" compoundref="MOM__regridding_8F90" startline="1666" endline="1720">adjust_interface_motion</references>
        <references refid="namespacecoord__hycom_1aec801ef9df8a887e77b7c1ecf459bd5a" compoundref="coord__hycom_8F90" startline="100" endline="165">coord_hycom::build_hycom1_column</references>
        <references refid="namespacemom__regridding_1a8dd75489564f85609033f53c0cb16cbb" compoundref="MOM__regridding_8F90" startline="907" endline="937">calc_h_new_by_dz</references>
        <references refid="namespacemom__regridding_1a9dddf53999f90d1a4edc79179c5b5da4" compoundref="MOM__regridding_8F90" startline="1021" endline="1152">filtered_grid_motion</references>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <referencedby refid="namespacemom__regridding_1ab354fe3423a39fef6f2b66f409b1682c" compoundref="MOM__regridding_8F90" startline="813" endline="902">regridding_main</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1aa57d2b70fe2247b5fd8283d7e3fb2cfd" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_regridding::build_grid_adaptive</definition>
        <argsstring>(G, GV, US, h, tv, dzInterface, remapCS, CS)</argsstring>
        <name>build_grid_adaptive</name>
        <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>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>tv</type>
          <defname>tv</defname>
        </param>
        <param>
          <type>dzInterface</type>
          <defname>dzInterface</defname>
        </param>
        <param>
          <type>remapCS</type>
          <defname>remapCS</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>This subroutine builds an adaptive grid that follows density surfaces where possible, subject to constraints on the smoothness of interface heights. </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="inout">dzinterface</parametername>
</parameternamelist>
<parameterdescription>
<para>The change in interface depth [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">remapcs</parametername>
</parameternamelist>
<parameterdescription>
<para>The remapping control structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="1532" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="1533" bodyend="1587"/>
        <references refid="namespacemom__regridding_1a7752ab22440e0d5f9a0b11d583acb812" compoundref="MOM__regridding_8F90" startline="1666" endline="1720">adjust_interface_motion</references>
        <references refid="namespacecoord__adapt_1a7c351df31210e9ecef21fcddb0683003" compoundref="coord__adapt_8F90" startline="116" endline="287">coord_adapt::build_adapt_column</references>
        <references refid="namespacemom__regridding_1a9dddf53999f90d1a4edc79179c5b5da4" compoundref="MOM__regridding_8F90" startline="1021" endline="1152">filtered_grid_motion</references>
        <referencedby refid="namespacemom__regridding_1ab354fe3423a39fef6f2b66f409b1682c" compoundref="MOM__regridding_8F90" startline="813" endline="902">regridding_main</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1a63b857ebd60054fd49dca31d7f10d2d0" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_regridding::build_grid_slight</definition>
        <argsstring>(G, GV, US, h, tv, dzInterface, CS)</argsstring>
        <name>build_grid_slight</name>
        <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>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>tv</type>
          <defname>tv</defname>
        </param>
        <param>
          <type>dzInterface</type>
          <defname>dzInterface</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>Builds a grid that tracks density interfaces for water that is denser than the surface density plus an increment of some number of layers, and uses all lighter layers uniformly above this location. Note that this amounts to interpolating to find the depth of an arbitrary (non-integer) interface index which should make the results vary smoothly in space to the extent that the surface density and interior stratification vary smoothly in space. Over shallow topography, this will tend to give a uniform sigma-like coordinate. For sufficiently shallow water, a minimum grid spacing is used to avoid certain instabilities. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Grid structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean 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>Existing model thickness [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">tv</parametername>
</parameternamelist>
<parameterdescription>
<para>Thermodynamics structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">dzinterface</parametername>
</parameternamelist>
<parameterdescription>
<para>Changes in interface position </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="1599" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="1600" bodyend="1661"/>
        <references refid="namespacemom__regridding_1a7752ab22440e0d5f9a0b11d583acb812" compoundref="MOM__regridding_8F90" startline="1666" endline="1720">adjust_interface_motion</references>
        <references refid="namespacecoord__slight_1a5f58a9ec734faa72781a86ff57e482f9" compoundref="coord__slight_8F90" startline="183" endline="482">coord_slight::build_slight_column</references>
        <references refid="namespacemom__regridding_1a9dddf53999f90d1a4edc79179c5b5da4" compoundref="MOM__regridding_8F90" startline="1021" endline="1152">filtered_grid_motion</references>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <referencedby refid="namespacemom__regridding_1ab354fe3423a39fef6f2b66f409b1682c" compoundref="MOM__regridding_8F90" startline="813" endline="902">regridding_main</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1a7752ab22440e0d5f9a0b11d583acb812" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_regridding::adjust_interface_motion</definition>
        <argsstring>(CS, nk, h_old, dz_int)</argsstring>
        <name>adjust_interface_motion</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>nk</type>
          <defname>nk</defname>
        </param>
        <param>
          <type>h_old</type>
          <defname>h_old</defname>
        </param>
        <param>
          <type>dz_int</type>
          <defname>dz_int</defname>
        </param>
        <briefdescription>
<para>Adjust dz_Interface to ensure non-negative future thicknesses. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">nk</parametername>
</parameternamelist>
<parameterdescription>
<para>Number of layers in h_old </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_old</parametername>
</parameternamelist>
<parameterdescription>
<para>Minium allowed thickness of h [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">dz_int</parametername>
</parameternamelist>
<parameterdescription>
<para>Minium allowed thickness of h [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="1665" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="1666" bodyend="1720"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <referencedby refid="namespacemom__regridding_1aa57d2b70fe2247b5fd8283d7e3fb2cfd" compoundref="MOM__regridding_8F90" startline="1533" endline="1587">build_grid_adaptive</referencedby>
        <referencedby refid="namespacemom__regridding_1a74433d7b55b2ba3a333553563d55089f" compoundref="MOM__regridding_8F90" startline="1461" endline="1527">build_grid_hycom1</referencedby>
        <referencedby refid="namespacemom__regridding_1a63b857ebd60054fd49dca31d7f10d2d0" compoundref="MOM__regridding_8F90" startline="1600" endline="1661">build_grid_slight</referencedby>
        <referencedby refid="namespacemom__regridding_1a55e6873a74355daea004d39c452e0069" compoundref="MOM__regridding_8F90" startline="1159" endline="1242">build_zstar_grid</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1a53fe5957610e488f1fb9052ff69007ec" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_regridding::build_grid_arbitrary</definition>
        <argsstring>(G, GV, h, dzInterface, h_new, CS)</argsstring>
        <name>build_grid_arbitrary</name>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>dzInterface</type>
          <defname>dzInterface</defname>
        </param>
        <param>
          <type>h_new</type>
          <defname>h_new</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><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>Ocean vertical grid structure</para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h</parametername>
</parameternamelist>
<parameterdescription>
<para>Original layer thicknesses [H ~&gt; m or kg m-2]</para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">dzinterface</parametername>
</parameternamelist>
<parameterdescription>
<para>The change in interface depth [H ~&gt; m or kg m-2]</para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">h_new</parametername>
</parameternamelist>
<parameterdescription>
<para>New layer thicknesses [H ~&gt; m or kg m-2]</para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="1726" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="1727" bodyend="1820"/>
        <referencedby refid="namespacemom__regridding_1ab354fe3423a39fef6f2b66f409b1682c" compoundref="MOM__regridding_8F90" startline="813" endline="902">regridding_main</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1aeb36a31003c4887ea1af82c11c627f2f" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_regridding::inflate_vanished_layers_old</definition>
        <argsstring>(CS, G, GV, h)</argsstring>
        <name>inflate_vanished_layers_old</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure</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="inout">h</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thicknesses [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="1828" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="1829" bodyend="1864"/>
        <references refid="namespacecoord__rho_1afbc86f29df8e39eb793d12075d018518" compoundref="coord__rho_8F90" startline="359" endline="413">coord_rho::old_inflate_layers_1d</references>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1aac58190f39678cb94e0f918455804f43" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_regridding::convective_adjustment</definition>
        <argsstring>(G, GV, h, tv)</argsstring>
        <name>convective_adjustment</name>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>tv</type>
          <defname>tv</defname>
        </param>
        <briefdescription>
<para>Achieve convective adjustment by swapping layers. </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="inout">h</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thicknesses [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">tv</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure pointing to various thermodynamic variables </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="1869" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="1870" bodyend="1925"/>
        <referencedby refid="namespacemom__regridding_1ab354fe3423a39fef6f2b66f409b1682c" compoundref="MOM__regridding_8F90" startline="813" endline="902">regridding_main</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1a8b3b0c1555006f196d9bb1baededd9e6" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>real function, dimension(nk), public</type>
        <definition>real function, dimension(nk), public mom_regridding::uniformresolution</definition>
        <argsstring>(nk, coordMode, maxDepth, rhoLight, rhoHeavy)</argsstring>
        <name>uniformresolution</name>
        <param>
          <type>nk</type>
          <defname>nk</defname>
        </param>
        <param>
          <type>coordMode</type>
          <defname>coordMode</defname>
        </param>
        <param>
          <type>maxDepth</type>
          <defname>maxDepth</defname>
        </param>
        <param>
          <type>rhoLight</type>
          <defname>rhoLight</defname>
        </param>
        <param>
          <type>rhoHeavy</type>
          <defname>rhoHeavy</defname>
        </param>
        <briefdescription>
<para>Return a uniform resolution vector in the units of the coordinate. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">nk</parametername>
</parameternamelist>
<parameterdescription>
<para>Number of cells in source grid </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">coordmode</parametername>
</parameternamelist>
<parameterdescription>
<para>A string indicating the coordinate mode. See the documenttion for <ref refid="namespaceregrid__consts" kindref="compound">regrid_consts</ref> for the recognized values. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">maxdepth</parametername>
</parameternamelist>
<parameterdescription>
<para>The range of the grid values in some modes </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">rholight</parametername>
</parameternamelist>
<parameterdescription>
<para>The minimum value of the grid in RHO mode </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">rhoheavy</parametername>
</parameternamelist>
<parameterdescription>
<para>The maximum value of the grid in RHO mode </para>
</parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>The returned uniform resolution grid. </para>
</simplesect>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="1931" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="1932" bodyend="1967"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <references refid="namespaceregrid__consts_1a227622bf8cf9a62a3dbe5ed6643baaf1" compoundref="regrid__consts_8F90" startline="23" endline="23">regrid_consts::regridding_adaptive</references>
        <references refid="namespaceregrid__consts_1a303726845f77761e06fa320a43848af7" compoundref="regrid__consts_8F90" startline="18" endline="18">regrid_consts::regridding_hycom1</references>
        <references refid="namespaceregrid__consts_1ab0d778e07655fc8187df01b4864d662a" compoundref="regrid__consts_8F90" startline="19" endline="19">regrid_consts::regridding_slight</references>
        <referencedby refid="namespacemom__regridding_1a8c91ba68f0906e1fc76b7008caf6288e" compoundref="MOM__regridding_8F90" startline="181" endline="733">initialize_regridding</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1ad9614000d524a78e043d52f9734314e0" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_regridding::initcoord</definition>
        <argsstring>(CS, GV, US, coord_mode)</argsstring>
        <name>initcoord</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>coord_mode</type>
          <defname>coord_mode</defname>
        </param>
        <briefdescription>
<para>Initialize the coordinate resolutions by calling the appropriate initialization routine for the specified coordinate mode. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">coord_mode</parametername>
</parameternamelist>
<parameterdescription>
<para>A string indicating the coordinate mode. See the documentation for <ref refid="namespaceregrid__consts" kindref="compound">regrid_consts</ref> for the recognized values. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean vertical grid structure </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/ALE/MOM_regridding.F90" line="1972" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="1973" bodyend="1997"/>
        <references refid="namespacecoord__adapt_1a53eb167f67898f13a7f2258365f1b968" compoundref="coord__adapt_8F90" startline="54" endline="75">coord_adapt::init_coord_adapt</references>
        <references refid="namespacecoord__hycom_1a061ad214832c7f084fffafbc711c2cc4" compoundref="coord__hycom_8F90" startline="40" endline="55">coord_hycom::init_coord_hycom</references>
        <references refid="namespacecoord__sigma_1adce9c462a3b61ba3791035534e1d8b2a" compoundref="coord__sigma_8F90" startline="29" endline="38">coord_sigma::init_coord_sigma</references>
        <references refid="namespacecoord__slight_1afe3fb682e16b96d441d380635a983040" compoundref="coord__slight_8F90" startline="73" endline="100">coord_slight::init_coord_slight</references>
        <references refid="namespacecoord__zlike_1a873f4fca87825e9bb2e216348634f0a7" compoundref="coord__zlike_8F90" startline="30" endline="39">coord_zlike::init_coord_zlike</references>
        <references refid="namespaceregrid__consts_1a227622bf8cf9a62a3dbe5ed6643baaf1" compoundref="regrid__consts_8F90" startline="23" endline="23">regrid_consts::regridding_adaptive</references>
        <references refid="namespaceregrid__consts_1a303726845f77761e06fa320a43848af7" compoundref="regrid__consts_8F90" startline="18" endline="18">regrid_consts::regridding_hycom1</references>
        <references refid="namespaceregrid__consts_1ab0d778e07655fc8187df01b4864d662a" compoundref="regrid__consts_8F90" startline="19" endline="19">regrid_consts::regridding_slight</references>
        <referencedby refid="namespacemom__regridding_1a8c91ba68f0906e1fc76b7008caf6288e" compoundref="MOM__regridding_8F90" startline="181" endline="733">initialize_regridding</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1a162e9f816bc892550624d781fdddd6ca" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_regridding::setcoordinateresolution</definition>
        <argsstring>(dz, CS, scale)</argsstring>
        <name>setcoordinateresolution</name>
        <param>
          <type>dz</type>
          <defname>dz</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>scale</type>
          <defname>scale</defname>
        </param>
        <briefdescription>
<para>Set the fixed resolution data. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">dz</parametername>
</parameternamelist>
<parameterdescription>
<para>A vector of vertical grid spacings </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">scale</parametername>
</parameternamelist>
<parameterdescription>
<para>A scaling factor converting dz to coordRes </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="2002" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="2003" bodyend="2015"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <referencedby refid="namespacemom__regridding_1a8c91ba68f0906e1fc76b7008caf6288e" compoundref="MOM__regridding_8F90" startline="181" endline="733">initialize_regridding</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1ab6ada39c6f95e652907bab93f9c5a3f1" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_regridding::set_target_densities_from_gv</definition>
        <argsstring>(GV, US, CS)</argsstring>
        <name>set_target_densities_from_gv</name>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>Set target densities based on the old Rlay variable. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean 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="inout">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="2019" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="2020" bodyend="2038"/>
        <referencedby refid="namespacemom__regridding_1a8c91ba68f0906e1fc76b7008caf6288e" compoundref="MOM__regridding_8F90" startline="181" endline="733">initialize_regridding</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1ae7eade38ab8e2adb0797a7191ddebb18" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_regridding::set_target_densities</definition>
        <argsstring>(CS, rho_int)</argsstring>
        <name>set_target_densities</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>rho_int</type>
          <defname>rho_int</defname>
        </param>
        <briefdescription>
<para>Set target densities based on vector of interface values. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">rho_int</parametername>
</parameternamelist>
<parameterdescription>
<para>Interface densities [R ~&gt; kg m-3] </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="2042" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="2043" bodyend="2052"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <referencedby refid="namespacemom__regridding_1a8c91ba68f0906e1fc76b7008caf6288e" compoundref="MOM__regridding_8F90" startline="181" endline="733">initialize_regridding</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1aac547ec199090852d539c7aefc44dfa7" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_regridding::set_regrid_max_depths</definition>
        <argsstring>(CS, max_depths, units_to_H)</argsstring>
        <name>set_regrid_max_depths</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>max_depths</type>
          <defname>max_depths</defname>
        </param>
        <param>
          <type>units_to_H</type>
          <defname>units_to_H</defname>
        </param>
        <briefdescription>
<para>Set maximum interface depths based on a vector of input values. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">max_depths</parametername>
</parameternamelist>
<parameterdescription>
<para>Maximum interface depths, in arbitrary units </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">units_to_h</parametername>
</parameternamelist>
<parameterdescription>
<para>A conversion factor for max_depths into H units </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="2056" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="2057" bodyend="2090"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <references refid="namespaceregrid__consts_1a303726845f77761e06fa320a43848af7" compoundref="regrid__consts_8F90" startline="18" endline="18">regrid_consts::regridding_hycom1</references>
        <references refid="namespaceregrid__consts_1ab0d778e07655fc8187df01b4864d662a" compoundref="regrid__consts_8F90" startline="19" endline="19">regrid_consts::regridding_slight</references>
        <references refid="namespacecoord__hycom_1af1b6262578c0ae1b48d576c9e43712f4" compoundref="coord__hycom_8F90" startline="73" endline="94">coord_hycom::set_hycom_params</references>
        <references refid="namespacecoord__slight_1a5ffc8589603f020d1d5af03cfd308154" compoundref="coord__slight_8F90" startline="118" endline="176">coord_slight::set_slight_params</references>
        <referencedby refid="namespacemom__regridding_1a8c91ba68f0906e1fc76b7008caf6288e" compoundref="MOM__regridding_8F90" startline="181" endline="733">initialize_regridding</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1ae91ca3f1376b3c72940268b5d9f87bb4" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_regridding::set_regrid_max_thickness</definition>
        <argsstring>(CS, max_h, units_to_H)</argsstring>
        <name>set_regrid_max_thickness</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>max_h</type>
          <defname>max_h</defname>
        </param>
        <param>
          <type>units_to_H</type>
          <defname>units_to_H</defname>
        </param>
        <briefdescription>
<para>Set maximum layer thicknesses based on a vector of input values. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">max_h</parametername>
</parameternamelist>
<parameterdescription>
<para>Maximum interface depths, in arbitrary units </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">units_to_h</parametername>
</parameternamelist>
<parameterdescription>
<para>A conversion factor for max_h into H units </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="2094" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="2095" bodyend="2116"/>
        <references refid="namespaceregrid__consts_1a303726845f77761e06fa320a43848af7" compoundref="regrid__consts_8F90" startline="18" endline="18">regrid_consts::regridding_hycom1</references>
        <references refid="namespaceregrid__consts_1ab0d778e07655fc8187df01b4864d662a" compoundref="regrid__consts_8F90" startline="19" endline="19">regrid_consts::regridding_slight</references>
        <references refid="namespacecoord__hycom_1af1b6262578c0ae1b48d576c9e43712f4" compoundref="coord__hycom_8F90" startline="73" endline="94">coord_hycom::set_hycom_params</references>
        <references refid="namespacecoord__slight_1a5ffc8589603f020d1d5af03cfd308154" compoundref="coord__slight_8F90" startline="118" endline="176">coord_slight::set_slight_params</references>
        <referencedby refid="namespacemom__regridding_1a8c91ba68f0906e1fc76b7008caf6288e" compoundref="MOM__regridding_8F90" startline="181" endline="733">initialize_regridding</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1af36c8643e6b6b97e6ab94f9a0d00ca32" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>real function, dimension(cs%nk), public</type>
        <definition>real function, dimension(cs%nk), public mom_regridding::getcoordinateresolution</definition>
        <argsstring>(CS, undo_scaling)</argsstring>
        <name>getcoordinateresolution</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>undo_scaling</type>
          <defname>undo_scaling</defname>
        </param>
        <briefdescription>
<para>Query the fixed resolution data. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">undo_scaling</parametername>
</parameternamelist>
<parameterdescription>
<para>If present and true, undo any internal rescaling of the resolution data. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="2122" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="2123" bodyend="2136"/>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1af20d0def7ceffa33a6595c6c9e8613fd" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>real function, dimension(cs%nk+1), public</type>
        <definition>real function, dimension(cs%nk+1), public mom_regridding::getcoordinateinterfaces</definition>
        <argsstring>(CS, undo_scaling)</argsstring>
        <name>getcoordinateinterfaces</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>undo_scaling</type>
          <defname>undo_scaling</defname>
        </param>
        <briefdescription>
<para>Query the target coordinate interface positions. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">undo_scaling</parametername>
</parameternamelist>
<parameterdescription>
<para>If present and true, undo any internal rescaling of the resolution data. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>Interface positions in target coordinate </para>
</simplesect>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="2140" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="2141" bodyend="2180"/>
        <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__regridding_1ad693fbb3424bb0ba9d0ad8878828e604" 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=20) function, public</type>
        <definition>character(len=20) function, public mom_regridding::getcoordinateunits</definition>
        <argsstring>(CS)</argsstring>
        <name>getcoordinateunits</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>Query the target coordinate units. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="2185" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="2186" bodyend="2204"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <references refid="namespaceregrid__consts_1a227622bf8cf9a62a3dbe5ed6643baaf1" compoundref="regrid__consts_8F90" startline="23" endline="23">regrid_consts::regridding_adaptive</references>
        <references refid="namespaceregrid__consts_1a303726845f77761e06fa320a43848af7" compoundref="regrid__consts_8F90" startline="18" endline="18">regrid_consts::regridding_hycom1</references>
        <references refid="namespaceregrid__consts_1ab0d778e07655fc8187df01b4864d662a" compoundref="regrid__consts_8F90" startline="19" endline="19">regrid_consts::regridding_slight</references>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1ac1e1f08a6d33ab71e6a3c5008c519ee6" 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=20) function, public</type>
        <definition>character(len=20) function, public mom_regridding::getcoordinateshortname</definition>
        <argsstring>(CS)</argsstring>
        <name>getcoordinateshortname</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>Query the short name of the coordinate. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="2209" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="2210" bodyend="2236"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <references refid="namespaceregrid__consts_1a227622bf8cf9a62a3dbe5ed6643baaf1" compoundref="regrid__consts_8F90" startline="23" endline="23">regrid_consts::regridding_adaptive</references>
        <references refid="namespaceregrid__consts_1a303726845f77761e06fa320a43848af7" compoundref="regrid__consts_8F90" startline="18" endline="18">regrid_consts::regridding_hycom1</references>
        <references refid="namespaceregrid__consts_1ab0d778e07655fc8187df01b4864d662a" compoundref="regrid__consts_8F90" startline="19" endline="19">regrid_consts::regridding_slight</references>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1a88398318fb996137b3f0d79b7fc8c4e9" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_regridding::set_regrid_params</definition>
        <argsstring>(CS, boundary_extrapolation, min_thickness, old_grid_weight, interp_scheme, depth_of_time_filter_shallow, depth_of_time_filter_deep, compress_fraction, ref_pressure, dz_min_surface, nz_fixed_surface, Rho_ML_avg_depth, nlay_ML_to_interior, fix_haloclines, halocline_filt_len, halocline_strat_tol, integrate_downward_for_e, remap_answers_2018, adaptTimeRatio, adaptZoom, adaptZoomCoeff, adaptBuoyCoeff, adaptAlpha, adaptDoMin, adaptDrho0)</argsstring>
        <name>set_regrid_params</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>boundary_extrapolation</type>
          <defname>boundary_extrapolation</defname>
        </param>
        <param>
          <type>min_thickness</type>
          <defname>min_thickness</defname>
        </param>
        <param>
          <type>old_grid_weight</type>
          <defname>old_grid_weight</defname>
        </param>
        <param>
          <type>interp_scheme</type>
          <defname>interp_scheme</defname>
        </param>
        <param>
          <type>depth_of_time_filter_shallow</type>
          <defname>depth_of_time_filter_shallow</defname>
        </param>
        <param>
          <type>depth_of_time_filter_deep</type>
          <defname>depth_of_time_filter_deep</defname>
        </param>
        <param>
          <type>compress_fraction</type>
          <defname>compress_fraction</defname>
        </param>
        <param>
          <type>ref_pressure</type>
          <defname>ref_pressure</defname>
        </param>
        <param>
          <type>dz_min_surface</type>
          <defname>dz_min_surface</defname>
        </param>
        <param>
          <type>nz_fixed_surface</type>
          <defname>nz_fixed_surface</defname>
        </param>
        <param>
          <type>Rho_ML_avg_depth</type>
          <defname>Rho_ML_avg_depth</defname>
        </param>
        <param>
          <type>nlay_ML_to_interior</type>
          <defname>nlay_ML_to_interior</defname>
        </param>
        <param>
          <type>fix_haloclines</type>
          <defname>fix_haloclines</defname>
        </param>
        <param>
          <type>halocline_filt_len</type>
          <defname>halocline_filt_len</defname>
        </param>
        <param>
          <type>halocline_strat_tol</type>
          <defname>halocline_strat_tol</defname>
        </param>
        <param>
          <type>integrate_downward_for_e</type>
          <defname>integrate_downward_for_e</defname>
        </param>
        <param>
          <type>remap_answers_2018</type>
          <defname>remap_answers_2018</defname>
        </param>
        <param>
          <type>adaptTimeRatio</type>
          <defname>adaptTimeRatio</defname>
        </param>
        <param>
          <type>adaptZoom</type>
          <defname>adaptZoom</defname>
        </param>
        <param>
          <type>adaptZoomCoeff</type>
          <defname>adaptZoomCoeff</defname>
        </param>
        <param>
          <type>adaptBuoyCoeff</type>
          <defname>adaptBuoyCoeff</defname>
        </param>
        <param>
          <type>adaptAlpha</type>
          <defname>adaptAlpha</defname>
        </param>
        <param>
          <type>adaptDoMin</type>
          <defname>adaptDoMin</defname>
        </param>
        <param>
          <type>adaptDrho0</type>
          <defname>adaptDrho0</defname>
        </param>
        <briefdescription>
<para>Can be used to set any of the parameters for MOM_regridding. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">boundary_extrapolation</parametername>
</parameternamelist>
<parameterdescription>
<para>Extrapolate in boundary cells </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">min_thickness</parametername>
</parameternamelist>
<parameterdescription>
<para>Minimum thickness allowed when building the new grid [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">old_grid_weight</parametername>
</parameternamelist>
<parameterdescription>
<para>Weight given to old coordinate when time-filtering grid </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">interp_scheme</parametername>
</parameternamelist>
<parameterdescription>
<para>Interpolation method for state-dependent coordinates </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">depth_of_time_filter_shallow</parametername>
</parameternamelist>
<parameterdescription>
<para>Depth to start cubic [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">depth_of_time_filter_deep</parametername>
</parameternamelist>
<parameterdescription>
<para>Depth to end cubic [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">compress_fraction</parametername>
</parameternamelist>
<parameterdescription>
<para>Fraction of compressibility to add to potential density [nondim] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ref_pressure</parametername>
</parameternamelist>
<parameterdescription>
<para>The reference pressure for density-dependent coordinates [R L2 T-2 ~&gt; Pa] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dz_min_surface</parametername>
</parameternamelist>
<parameterdescription>
<para>The fixed resolution in the topmost SLight_nkml_min layers [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">nz_fixed_surface</parametername>
</parameternamelist>
<parameterdescription>
<para>The number of fixed-thickness layers at the top of the model </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">rho_ml_avg_depth</parametername>
</parameternamelist>
<parameterdescription>
<para>Averaging depth over which to determine mixed layer potential density [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">nlay_ml_to_interior</parametername>
</parameternamelist>
<parameterdescription>
<para>Number of layers to offset the mixed layer density to find resolved stratification [nondim] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">fix_haloclines</parametername>
</parameternamelist>
<parameterdescription>
<para>Detect regions with much weaker stratification in the coordinate </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">halocline_filt_len</parametername>
</parameternamelist>
<parameterdescription>
<para>Length scale over which to filter T &amp; S when looking for spuriously unstable water mass profiles [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">halocline_strat_tol</parametername>
</parameternamelist>
<parameterdescription>
<para>Value of the stratification ratio that defines a problematic halocline region. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">integrate_downward_for_e</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, integrate for interface positions downward from the top. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">remap_answers_2018</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, use the order of arithmetic and expressions that recover the remapping answers from 2018. Otherwise use more robust but mathematically equivalent expressions. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">adapttimeratio</parametername>
</parameternamelist>
<parameterdescription>
<para>Ratio of the ALE timestep to the grid timescale [nondim]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">adaptzoom</parametername>
</parameternamelist>
<parameterdescription>
<para>Depth of near-surface zooming region [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">adaptzoomcoeff</parametername>
</parameternamelist>
<parameterdescription>
<para>Coefficient of near-surface zooming diffusivity [nondim]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">adaptbuoycoeff</parametername>
</parameternamelist>
<parameterdescription>
<para>Coefficient of buoyancy diffusivity [nondim]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">adaptalpha</parametername>
</parameternamelist>
<parameterdescription>
<para>Scaling factor on optimization tendency [nondim]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">adaptdomin</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, make a HyCOM-like mixed layer by preventing interfaces from being shallower than the depths specified by the regridding coordinate. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">adaptdrho0</parametername>
</parameternamelist>
<parameterdescription>
<para>Reference density difference for stratification-dependent diffusion. [R ~&gt; kg m-3] </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="2240" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="2246" bodyend="2343"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <references refid="namespaceregrid__consts_1a227622bf8cf9a62a3dbe5ed6643baaf1" compoundref="regrid__consts_8F90" startline="23" endline="23">regrid_consts::regridding_adaptive</references>
        <references refid="namespaceregrid__consts_1a303726845f77761e06fa320a43848af7" compoundref="regrid__consts_8F90" startline="18" endline="18">regrid_consts::regridding_hycom1</references>
        <references refid="namespaceregrid__consts_1ab0d778e07655fc8187df01b4864d662a" compoundref="regrid__consts_8F90" startline="19" endline="19">regrid_consts::regridding_slight</references>
        <references refid="namespacecoord__adapt_1a35706e0359c3953aac56b160e48b0ef8" compoundref="coord__adapt_8F90" startline="91" endline="112">coord_adapt::set_adapt_params</references>
        <references refid="namespacecoord__hycom_1af1b6262578c0ae1b48d576c9e43712f4" compoundref="coord__hycom_8F90" startline="73" endline="94">coord_hycom::set_hycom_params</references>
        <references refid="namespaceregrid__interp_1a9ed8b5720d74090e95ca0074240a0d8a" compoundref="regrid__interp_8F90" startline="520" endline="524">regrid_interp::set_interp_extrap</references>
        <references refid="namespaceregrid__interp_1ae77f3027ed51829db5d4ed6dbc744550" compoundref="regrid__interp_8F90" startline="510" endline="515">regrid_interp::set_interp_scheme</references>
        <references refid="namespacecoord__sigma_1aceccbaf232379cea8182c04130c03f5a" compoundref="coord__sigma_8F90" startline="53" endline="58">coord_sigma::set_sigma_params</references>
        <references refid="namespacecoord__slight_1a5ffc8589603f020d1d5af03cfd308154" compoundref="coord__slight_8F90" startline="118" endline="176">coord_slight::set_slight_params</references>
        <references refid="namespacecoord__zlike_1acb2336ed52c2c3ed2509450c61790753" compoundref="coord__zlike_8F90" startline="54" endline="59">coord_zlike::set_zlike_params</references>
        <referencedby refid="namespacemom__oda__driver__mod_1aaaf67b8d0e0db3ba3dfe09e24d2b8b24" compoundref="MOM__oda__driver_8F90" startline="115" endline="303">mom_oda_driver_mod::init_oda</referencedby>
        <referencedby refid="namespacemom__regridding_1a8c91ba68f0906e1fc76b7008caf6288e" compoundref="MOM__regridding_8F90" startline="181" endline="733">initialize_regridding</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1ab4d037c069414d7a709219350e7b71ed" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>integer function, public</type>
        <definition>integer function, public mom_regridding::get_regrid_size</definition>
        <argsstring>(CS)</argsstring>
        <name>get_regrid_size</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>Returns the number of levels/layers in the regridding control structure. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="2347" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="2348" bodyend="2351"/>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1a8ff04f8857825fcc814cdad9684717e7" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>type(zlike_cs) function, public</type>
        <definition>type(zlike_cs) function, public mom_regridding::get_zlike_cs</definition>
        <argsstring>(CS)</argsstring>
        <name>get_zlike_cs</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>This returns a copy of the zlike_CS stored in the regridding control structure. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="2355" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="2356" bodyend="2359"/>
        <referencedby refid="namespacemom__diag__remap_1aaa0a887dc724438845e88598d439b20a" compoundref="MOM__diag__remap_8F90" startline="276" endline="346">mom_diag_remap::diag_remap_update</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1aef5b07937353a9fe2ce51dd6c2beed54" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>type(sigma_cs) function, public</type>
        <definition>type(sigma_cs) function, public mom_regridding::get_sigma_cs</definition>
        <argsstring>(CS)</argsstring>
        <name>get_sigma_cs</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>This returns a copy of the sigma_CS stored in the regridding control structure. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="2363" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="2364" bodyend="2367"/>
        <referencedby refid="namespacemom__diag__remap_1aaa0a887dc724438845e88598d439b20a" compoundref="MOM__diag__remap_8F90" startline="276" endline="346">mom_diag_remap::diag_remap_update</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1a358f07a447816230753c8d3d5a0fb8af" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>type(rho_cs) function, public</type>
        <definition>type(rho_cs) function, public mom_regridding::get_rho_cs</definition>
        <argsstring>(CS)</argsstring>
        <name>get_rho_cs</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>This returns a copy of the rho_CS stored in the regridding control structure. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="2371" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="2372" bodyend="2375"/>
        <referencedby refid="namespacemom__diag__remap_1aaa0a887dc724438845e88598d439b20a" compoundref="MOM__diag__remap_8F90" startline="276" endline="346">mom_diag_remap::diag_remap_update</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1a1587a58d8fe87432c3f7817952014584" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>real function, dimension(cs%nk), public</type>
        <definition>real function, dimension(cs%nk), public mom_regridding::getstaticthickness</definition>
        <argsstring>(CS, SSH, depth)</argsstring>
        <name>getstaticthickness</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>SSH</type>
          <defname>SSH</defname>
        </param>
        <param>
          <type>depth</type>
          <defname>depth</defname>
        </param>
        <briefdescription>
<para>Return coordinate-derived thicknesses for fixed coordinate systems. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Regridding control structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ssh</parametername>
</parameternamelist>
<parameterdescription>
<para>The sea surface height, in the same units as depth </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">depth</parametername>
</parameternamelist>
<parameterdescription>
<para>The maximum depth of the grid, often [Z ~&gt; m] </para>
</parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>The returned thicknesses in the units of depth </para>
</simplesect>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="2380" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="2381" bodyend="2413"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <references refid="namespaceregrid__consts_1a227622bf8cf9a62a3dbe5ed6643baaf1" compoundref="regrid__consts_8F90" startline="23" endline="23">regrid_consts::regridding_adaptive</references>
        <references refid="namespaceregrid__consts_1a303726845f77761e06fa320a43848af7" compoundref="regrid__consts_8F90" startline="18" endline="18">regrid_consts::regridding_hycom1</references>
        <references refid="namespaceregrid__consts_1ab0d778e07655fc8187df01b4864d662a" compoundref="regrid__consts_8F90" startline="19" endline="19">regrid_consts::regridding_slight</references>
        <referencedby refid="namespacemom__ale_1a9fa1d63aa2994e74da912ae87e015c3e" compoundref="MOM__ALE_8F90" startline="1306" endline="1317">mom_ale::ale_initthicknesstocoord</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1a2becd8126867cdce125b31e07d13065e" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_regridding::dz_function1</definition>
        <argsstring>(string, dz)</argsstring>
        <name>dz_function1</name>
        <param>
          <type>string</type>
          <defname>string</defname>
        </param>
        <param>
          <type>dz</type>
          <defname>dz</defname>
        </param>
        <briefdescription>
<para>Parses a string and generates a dz(:) profile that goes like k**power. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">string</parametername>
</parameternamelist>
<parameterdescription>
<para>String with list of parameters in form dz_min, H_total, power, precision </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">dz</parametername>
</parameternamelist>
<parameterdescription>
<para>Profile of nominal thicknesses </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="2417" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="2418" bodyend="2441"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <referencedby refid="namespacemom__regridding_1a8c91ba68f0906e1fc76b7008caf6288e" compoundref="MOM__regridding_8F90" startline="181" endline="733">initialize_regridding</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__regridding_1a64758b08fbd1d2a98d4d7de593fb49be" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>integer function</type>
        <definition>integer function mom_regridding::rho_function1</definition>
        <argsstring>(string, rho_target)</argsstring>
        <name>rho_function1</name>
        <param>
          <type>string</type>
          <defname>string</defname>
        </param>
        <param>
          <type>rho_target</type>
          <defname>rho_target</defname>
        </param>
        <briefdescription>
<para>Parses a string and generates a rho_target(:) profile with refined resolution downward and returns the number of levels. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">string</parametername>
</parameternamelist>
<parameterdescription>
<para>String with list of parameters in form dz_min, H_total, power, precision </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">rho_target</parametername>
</parameternamelist>
<parameterdescription>
<para>Profile of interface densities [kg m-3] </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="2446" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" bodystart="2447" bodyend="2468"/>
        <referencedby refid="namespacemom__regridding_1a8c91ba68f0906e1fc76b7008caf6288e" compoundref="MOM__regridding_8F90" startline="181" endline="733">initialize_regridding</referencedby>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Generates vertical grids as part of the ALE algorithm. </para>
    </briefdescription>
    <detaileddescription>
<para>A vertical grid is defined solely by the cell thicknesses, <formula id="17">$h$</formula>. Most calculations in this module start with the coordinate at the bottom of the column set to -depth, and use a increasing value of coordinate with decreasing k. This is consistent with the rest of MOM6 that uses position, <formula id="11">$z$</formula> which is a negative quantity for most of the ocean.</para>
<para>A change in grid is define through a change in position of the interfaces: <formula id="18">\[ z^n_{k+1/2} = z^{n-1}_{k+1/2} + \Delta z_{k+1/2} \]</formula> with the positive upward coordinate convention <formula id="19">\[ z_{k-1/2} = z_{k+1/2} + h_k \]</formula> so that <formula id="20">\[ h^n_k = h^{n-1}_k + ( \Delta z_{k-1/2} - \Delta z_{k+1/2} ) \]</formula></para>
<para>Original date of creation: 2008.06.09 by L. White </para>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/ALE/MOM_regridding.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
