<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.19" xml:lang="en-US">
  <compounddef id="namespacecoord__zlike" kind="namespace" language="Fortran">
    <compoundname>coord_zlike</compoundname>
    <innerclass refid="structcoord__zlike_1_1zlike__cs" prot="public">coord_zlike::zlike_cs</innerclass>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacecoord__zlike_1a873f4fca87825e9bb2e216348634f0a7" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public coord_zlike::init_coord_zlike</definition>
        <argsstring>(CS, nk, coordinateResolution)</argsstring>
        <name>init_coord_zlike</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>
        <briefdescription>
<para>Initialise a zlike_CS with pointers to 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 levels in the grid </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">coordinateresolution</parametername>
</parameternamelist>
<parameterdescription>
<para>Target coordinate resolution [Z ~&gt; m] </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/coord_zlike.F90" line="29" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/coord_zlike.F90" bodystart="30" bodyend="39"/>
        <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__zlike_1ad51a91fb635a0a5c29fa40bc2534f7b4" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public coord_zlike::end_coord_zlike</definition>
        <argsstring>(CS)</argsstring>
        <name>end_coord_zlike</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>Deallocates the zlike control structure. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Coordinate control structure </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/coord_zlike.F90" line="43" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/coord_zlike.F90" bodystart="44" bodyend="49"/>
        <referencedby refid="namespacemom__regridding_1a9f55ab3a80ab1202b7664e9c65ebf08b" compoundref="MOM__regridding_8F90" startline="794" endline="807">mom_regridding::end_regridding</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacecoord__zlike_1acb2336ed52c2c3ed2509450c61790753" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public coord_zlike::set_zlike_params</definition>
        <argsstring>(CS, min_thickness)</argsstring>
        <name>set_zlike_params</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>min_thickness</type>
          <defname>min_thickness</defname>
        </param>
        <briefdescription>
<para>Set parameters in the zlike structure. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Coordinate control structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">min_thickness</parametername>
</parameternamelist>
<parameterdescription>
<para>Minimum allowed thickness [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/coord_zlike.F90" line="53" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/coord_zlike.F90" bodystart="54" bodyend="59"/>
        <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__zlike_1af2bdac8481050f2b0ff7c5fc01f26e1c" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public coord_zlike::build_zstar_column</definition>
        <argsstring>(CS, depth, total_thickness, zInterface, z_rigid_top, eta_orig, zScale)</argsstring>
        <name>build_zstar_column</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>depth</type>
          <defname>depth</defname>
        </param>
        <param>
          <type>total_thickness</type>
          <defname>total_thickness</defname>
        </param>
        <param>
          <type>zInterface</type>
          <defname>zInterface</defname>
        </param>
        <param>
          <type>z_rigid_top</type>
          <defname>z_rigid_top</defname>
        </param>
        <param>
          <type>eta_orig</type>
          <defname>eta_orig</defname>
        </param>
        <param>
          <type>zScale</type>
          <defname>zScale</defname>
        </param>
        <briefdescription>
<para>Builds a z* coordinate with a minimum thickness. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Coordinate control structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">depth</parametername>
</parameternamelist>
<parameterdescription>
<para>Depth of ocean bottom (positive downward in the output units), units may be [Z ~&gt; m] or [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">total_thickness</parametername>
</parameternamelist>
<parameterdescription>
<para>Column thickness (positive definite in the same units as depth) [Z ~&gt; m] or [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">zinterface</parametername>
</parameternamelist>
<parameterdescription>
<para>Absolute positions of interfaces </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">z_rigid_top</parametername>
</parameternamelist>
<parameterdescription>
<para>The height of a rigid top (positive upward in the same units as depth) [Z ~&gt; m] or [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">eta_orig</parametername>
</parameternamelist>
<parameterdescription>
<para>The actual original height of the top in the same units as depth) [Z ~&gt; m] or [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">zscale</parametername>
</parameternamelist>
<parameterdescription>
<para>Scaling factor from the target coordinate resolution in Z to desired units for zInterface, perhaps Z_to_H </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/coord_zlike.F90" line="63" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/coord_zlike.F90" bodystart="65" bodyend="141"/>
        <referencedby refid="namespacemom__regridding_1a55e6873a74355daea004d39c452e0069" compoundref="MOM__regridding_8F90" startline="1159" endline="1242">mom_regridding::build_zstar_grid</referencedby>
        <referencedby refid="namespacemom__diag__remap_1aaa0a887dc724438845e88598d439b20a" compoundref="MOM__diag__remap_8F90" startline="276" endline="346">mom_diag_remap::diag_remap_update</referencedby>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Regrid columns for a z-like coordinate (z-star, z-level) </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/ALE/coord_zlike.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
