<?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.15">
  <compounddef id="namespacecoord__adapt" kind="namespace" language="Fortran">
    <compoundname>coord_adapt</compoundname>
    <innerclass refid="structcoord__adapt_1_1adapt__cs" prot="public">coord_adapt::adapt_cs</innerclass>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacecoord__adapt_1a53eb167f67898f13a7f2258365f1b968" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public coord_adapt::init_coord_adapt</definition>
        <argsstring>(CS, nk, coordinateResolution, m_to_H, kg_m3_to_R)</argsstring>
        <name>init_coord_adapt</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>nk</type>
          <defname>nk</defname>
        </param>
        <param>
          <type>coordinateResolution</type>
          <defname>coordinateResolution</defname>
        </param>
        <param>
          <type>m_to_H</type>
          <defname>m_to_H</defname>
        </param>
        <param>
          <type>kg_m3_to_R</type>
          <defname>kg_m3_to_R</defname>
        </param>
        <briefdescription>
<para>Initialise an adapt_CS with parameters. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Unassociated pointer to hold the control structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">nk</parametername>
</parameternamelist>
<parameterdescription>
<para>Number of layers in the grid </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">coordinateresolution</parametername>
</parameternamelist>
<parameterdescription>
<para>Nominal near-surface resolution [m] or other units specified with m_to_H </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">m_to_h</parametername>
</parameternamelist>
<parameterdescription>
<para>A conversion factor from m to the units of thicknesses </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">kg_m3_to_r</parametername>
</parameternamelist>
<parameterdescription>
<para>A conversion factor from kg m-3 to the units of density </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/coord_adapt.F90" line="53" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/coord_adapt.F90" bodystart="54" bodyend="75"/>
        <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_1ad9614000d524a78e043d52f9734314e0" compoundref="MOM__regridding_8F90" startline="1973" endline="1997">mom_regridding::initcoord</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacecoord__adapt_1a92e88dea18cc4b3adef844f58a8fc0ff" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public coord_adapt::end_coord_adapt</definition>
        <argsstring>(CS)</argsstring>
        <name>end_coord_adapt</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>Clean up the coordinate control structure. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>The control structure for this module </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/coord_adapt.F90" line="79" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/coord_adapt.F90" bodystart="80" bodyend="85"/>
        <referencedby refid="namespacemom__regridding_1a9f55ab3a80ab1202b7664e9c65ebf08b" compoundref="MOM__regridding_8F90" startline="794" endline="807">mom_regridding::end_regridding</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacecoord__adapt_1a35706e0359c3953aac56b160e48b0ef8" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public coord_adapt::set_adapt_params</definition>
        <argsstring>(CS, adaptTimeRatio, adaptAlpha, adaptZoom, adaptZoomCoeff, adaptBuoyCoeff, adaptDrho0, adaptDoMin)</argsstring>
        <name>set_adapt_params</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>adaptTimeRatio</type>
          <defname>adaptTimeRatio</defname>
        </param>
        <param>
          <type>adaptAlpha</type>
          <defname>adaptAlpha</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>adaptDrho0</type>
          <defname>adaptDrho0</defname>
        </param>
        <param>
          <type>adaptDoMin</type>
          <defname>adaptDoMin</defname>
        </param>
        <briefdescription>
<para>This subtroutine can be used to set the parameters for <ref refid="namespacecoord__adapt" kindref="compound">coord_adapt</ref> module. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>The control structure for this module </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">adapttimeratio</parametername>
</parameternamelist>
<parameterdescription>
<para>Ratio of optimisation and diffusion timescales </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">adaptalpha</parametername>
</parameternamelist>
<parameterdescription>
<para>Nondimensional coefficient determining how much optimisation to apply </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">adaptzoom</parametername>
</parameternamelist>
<parameterdescription>
<para>Near-surface zooming depth [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">adaptzoomcoeff</parametername>
</parameternamelist>
<parameterdescription>
<para>Near-surface zooming coefficient </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">adaptbuoycoeff</parametername>
</parameternamelist>
<parameterdescription>
<para>Stratification-dependent diffusion coefficient </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>
<parameteritem>
<parameternamelist>
<parametername direction="in">adaptdomin</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, form a HYCOM1-like mixed layer by preventing interfaces from becoming shallower than the depths set by coordinateResolution </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/coord_adapt.F90" line="89" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/coord_adapt.F90" bodystart="91" bodyend="112"/>
        <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_1a88398318fb996137b3f0d79b7fc8c4e9" compoundref="MOM__regridding_8F90" startline="2246" endline="2343">mom_regridding::set_regrid_params</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacecoord__adapt_1a7c351df31210e9ecef21fcddb0683003" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public coord_adapt::build_adapt_column</definition>
        <argsstring>(CS, G, GV, US, tv, i, j, zInt, tInt, sInt, h, zNext)</argsstring>
        <name>build_adapt_column</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>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>tv</type>
          <defname>tv</defname>
        </param>
        <param>
          <type>i</type>
          <defname>i</defname>
        </param>
        <param>
          <type>j</type>
          <defname>j</defname>
        </param>
        <param>
          <type>zInt</type>
          <defname>zInt</defname>
        </param>
        <param>
          <type>tInt</type>
          <defname>tInt</defname>
        </param>
        <param>
          <type>sInt</type>
          <defname>sInt</defname>
        </param>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>zNext</type>
          <defname>zNext</defname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>The control structure for this module</para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>The ocean&apos;s grid structure</para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>The ocean&apos;s vertical grid structure</para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">us</parametername>
</parameternamelist>
<parameterdescription>
<para>A dimensional unit scaling type</para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">tv</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure pointing to various thermodynamic variables</para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">i</parametername>
</parameternamelist>
<parameterdescription>
<para>The i-index of the column to work on</para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">j</parametername>
</parameternamelist>
<parameterdescription>
<para>The j-index of the column to work on</para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">zint</parametername>
</parameternamelist>
<parameterdescription>
<para>Interface heights [H ~&gt; m or kg m-2].</para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">tint</parametername>
</parameternamelist>
<parameterdescription>
<para>Interface temperatures [degC]</para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">sint</parametername>
</parameternamelist>
<parameterdescription>
<para>Interface salinities [ppt]</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">znext</parametername>
</parameternamelist>
<parameterdescription>
<para>updated interface positions </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/coord_adapt.F90" line="115" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/coord_adapt.F90" bodystart="116" bodyend="287"/>
        <referencedby refid="namespacemom__regridding_1aa57d2b70fe2247b5fd8283d7e3fb2cfd" compoundref="MOM__regridding_8F90" startline="1533" endline="1587">mom_regridding::build_grid_adaptive</referencedby>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Regrid columns for the adaptive coordinate. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/ALE/coord_adapt.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
