<?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="namespacecoord__slight" kind="namespace" language="Fortran">
    <compoundname>coord_slight</compoundname>
    <innerclass refid="structcoord__slight_1_1slight__cs" prot="public">coord_slight::slight_cs</innerclass>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacecoord__slight_1afe3fb682e16b96d441d380635a983040" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public coord_slight::init_coord_slight</definition>
        <argsstring>(CS, nk, ref_pressure, target_density, interp_CS, m_to_H)</argsstring>
        <name>init_coord_slight</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>nk</type>
          <defname>nk</defname>
        </param>
        <param>
          <type>ref_pressure</type>
          <defname>ref_pressure</defname>
        </param>
        <param>
          <type>target_density</type>
          <defname>target_density</defname>
        </param>
        <param>
          <type>interp_CS</type>
          <defname>interp_CS</defname>
        </param>
        <param>
          <type>m_to_H</type>
          <defname>m_to_H</defname>
        </param>
        <briefdescription>
<para>Initialise a slight_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 layers in the grid </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ref_pressure</parametername>
</parameternamelist>
<parameterdescription>
<para>Coordinate reference pressure [R L2 T-2 ~&gt; Pa] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">target_density</parametername>
</parameternamelist>
<parameterdescription>
<para>Nominal density of interfaces [R ~&gt; kg m-3] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">interp_cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Controls for interpolation </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>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/coord_slight.F90" line="72" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/coord_slight.F90" bodystart="73" bodyend="100"/>
        <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__slight_1af5e8c8c13ad380620be3d8907738ed38" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public coord_slight::end_coord_slight</definition>
        <argsstring>(CS)</argsstring>
        <name>end_coord_slight</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>This subroutine deallocates memory in the control structure for the <ref refid="namespacecoord__slight" kindref="compound">coord_slight</ref> module. </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_slight.F90" line="104" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/coord_slight.F90" bodystart="105" bodyend="110"/>
        <referencedby refid="namespacemom__regridding_1a9f55ab3a80ab1202b7664e9c65ebf08b" compoundref="MOM__regridding_8F90" startline="794" endline="807">mom_regridding::end_regridding</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacecoord__slight_1a5ffc8589603f020d1d5af03cfd308154" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public coord_slight::set_slight_params</definition>
        <argsstring>(CS, max_interface_depths, max_layer_thickness, min_thickness, compressibility_fraction, dz_ml_min, nz_fixed_surface, Rho_ML_avg_depth, nlay_ML_offset, fix_haloclines, halocline_filter_length, halocline_strat_tol, interp_CS)</argsstring>
        <name>set_slight_params</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>max_interface_depths</type>
          <defname>max_interface_depths</defname>
        </param>
        <param>
          <type>max_layer_thickness</type>
          <defname>max_layer_thickness</defname>
        </param>
        <param>
          <type>min_thickness</type>
          <defname>min_thickness</defname>
        </param>
        <param>
          <type>compressibility_fraction</type>
          <defname>compressibility_fraction</defname>
        </param>
        <param>
          <type>dz_ml_min</type>
          <defname>dz_ml_min</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_offset</type>
          <defname>nlay_ML_offset</defname>
        </param>
        <param>
          <type>fix_haloclines</type>
          <defname>fix_haloclines</defname>
        </param>
        <param>
          <type>halocline_filter_length</type>
          <defname>halocline_filter_length</defname>
        </param>
        <param>
          <type>halocline_strat_tol</type>
          <defname>halocline_strat_tol</defname>
        </param>
        <param>
          <type>interp_CS</type>
          <defname>interp_CS</defname>
        </param>
        <briefdescription>
<para>This subroutine can be used to set the parameters for the <ref refid="namespacecoord__slight" kindref="compound">coord_slight</ref> module. </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">max_interface_depths</parametername>
</parameternamelist>
<parameterdescription>
<para>Maximum depths of interfaces [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">max_layer_thickness</parametername>
</parameternamelist>
<parameterdescription>
<para>Maximum thicknesses of layers [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">min_thickness</parametername>
</parameternamelist>
<parameterdescription>
<para>Minimum thickness allowed when building the new grid through regridding [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">compressibility_fraction</parametername>
</parameternamelist>
<parameterdescription>
<para>Fraction (between 0 and 1) of compressibility to add to potential density profiles when interpolating for target grid positions. [nondim] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">dz_ml_min</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>Depth over which to average to determine the mixed layer potential density [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">nlay_ml_offset</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>If true, detect regions with much weaker than based on in-situ density, and use a stretched coordinate there. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">halocline_filter_length</parametername>
</parameternamelist>
<parameterdescription>
<para>A 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>A value of the stratification ratio that defines a problematic halocline region [nondim]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">interp_cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Controls for interpolation </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/coord_slight.F90" line="114" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/coord_slight.F90" bodystart="118" bodyend="176"/>
        <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_1aac547ec199090852d539c7aefc44dfa7" compoundref="MOM__regridding_8F90" startline="2057" endline="2090">mom_regridding::set_regrid_max_depths</referencedby>
        <referencedby refid="namespacemom__regridding_1ae91ca3f1376b3c72940268b5d9f87bb4" compoundref="MOM__regridding_8F90" startline="2095" endline="2116">mom_regridding::set_regrid_max_thickness</referencedby>
        <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__slight_1a5f58a9ec734faa72781a86ff57e482f9" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public coord_slight::build_slight_column</definition>
        <argsstring>(CS, eqn_of_state, H_to_pres, H_subroundoff, nz, depth, h_col, T_col, S_col, p_col, z_col, z_col_new, h_neglect, h_neglect_edge)</argsstring>
        <name>build_slight_column</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>eqn_of_state</type>
          <defname>eqn_of_state</defname>
        </param>
        <param>
          <type>H_to_pres</type>
          <defname>H_to_pres</defname>
        </param>
        <param>
          <type>H_subroundoff</type>
          <defname>H_subroundoff</defname>
        </param>
        <param>
          <type>nz</type>
          <defname>nz</defname>
        </param>
        <param>
          <type>depth</type>
          <defname>depth</defname>
        </param>
        <param>
          <type>h_col</type>
          <defname>h_col</defname>
        </param>
        <param>
          <type>T_col</type>
          <defname>T_col</defname>
        </param>
        <param>
          <type>S_col</type>
          <defname>S_col</defname>
        </param>
        <param>
          <type>p_col</type>
          <defname>p_col</defname>
        </param>
        <param>
          <type>z_col</type>
          <defname>z_col</defname>
        </param>
        <param>
          <type>z_col_new</type>
          <defname>z_col_new</defname>
        </param>
        <param>
          <type>h_neglect</type>
          <defname>h_neglect</defname>
        </param>
        <param>
          <type>h_neglect_edge</type>
          <defname>h_neglect_edge</defname>
        </param>
        <briefdescription>
<para>Build a SLight coordinate column. </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>eqn_of_state</parametername>
</parameternamelist>
<parameterdescription>
<para>Equation of state structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_to_pres</parametername>
</parameternamelist>
<parameterdescription>
<para>A conversion factor from thicknesses to scaled pressure [R L2 T-2 H-1 ~&gt; Pa m-1 or Pa m2 kg-1] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_subroundoff</parametername>
</parameternamelist>
<parameterdescription>
<para>GVH_subroundoff </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">nz</parametername>
</parameternamelist>
<parameterdescription>
<para>Number of levels </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">depth</parametername>
</parameternamelist>
<parameterdescription>
<para>Depth of ocean bottom (positive [H ~&gt; m or kg m-2]) </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">t_col</parametername>
</parameternamelist>
<parameterdescription>
<para>T for column </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">s_col</parametername>
</parameternamelist>
<parameterdescription>
<para>S for column </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_col</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thicknesses [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">p_col</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer center pressure [R L2 T-2 ~&gt; Pa] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">z_col</parametername>
</parameternamelist>
<parameterdescription>
<para>Interface positions relative to the surface [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">z_col_new</parametername>
</parameternamelist>
<parameterdescription>
<para>Absolute positions of interfaces [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_neglect</parametername>
</parameternamelist>
<parameterdescription>
<para>A negligibly small width for the purpose of cell reconstructions [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_neglect_edge</parametername>
</parameternamelist>
<parameterdescription>
<para>A negligibly small width for the purpose of edge value calculations [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_slight.F90" line="180" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/coord_slight.F90" bodystart="183" bodyend="482"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <references refid="namespacecoord__slight_1a20af96022abf0d0f4ecb17dde027b2d1" compoundref="coord__slight_8F90" startline="489" endline="732">rho_interfaces_col</references>
        <referencedby refid="namespacemom__regridding_1a63b857ebd60054fd49dca31d7f10d2d0" compoundref="MOM__regridding_8F90" startline="1600" endline="1661">mom_regridding::build_grid_slight</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacecoord__slight_1a20af96022abf0d0f4ecb17dde027b2d1" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine coord_slight::rho_interfaces_col</definition>
        <argsstring>(rho_col, h_col, z_col, rho_tgt, nz, z_col_new, CS, reliable, debug, h_neglect, h_neglect_edge)</argsstring>
        <name>rho_interfaces_col</name>
        <param>
          <type>rho_col</type>
          <defname>rho_col</defname>
        </param>
        <param>
          <type>h_col</type>
          <defname>h_col</defname>
        </param>
        <param>
          <type>z_col</type>
          <defname>z_col</defname>
        </param>
        <param>
          <type>rho_tgt</type>
          <defname>rho_tgt</defname>
        </param>
        <param>
          <type>nz</type>
          <defname>nz</defname>
        </param>
        <param>
          <type>z_col_new</type>
          <defname>z_col_new</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>reliable</type>
          <defname>reliable</defname>
        </param>
        <param>
          <type>debug</type>
          <defname>debug</defname>
        </param>
        <param>
          <type>h_neglect</type>
          <defname>h_neglect</defname>
        </param>
        <param>
          <type>h_neglect_edge</type>
          <defname>h_neglect_edge</defname>
        </param>
        <briefdescription>
<para>Finds the new interface locations in a column of water that match the prescribed target densities. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">nz</parametername>
</parameternamelist>
<parameterdescription>
<para>Number of layers </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">rho_col</parametername>
</parameternamelist>
<parameterdescription>
<para>Initial layer reference densities [R ~&gt; kg m-3]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_col</parametername>
</parameternamelist>
<parameterdescription>
<para>Initial layer thicknesses [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">z_col</parametername>
</parameternamelist>
<parameterdescription>
<para>Initial interface heights [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">rho_tgt</parametername>
</parameternamelist>
<parameterdescription>
<para>Interface target densities. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">z_col_new</parametername>
</parameternamelist>
<parameterdescription>
<para>New interface heights [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Coordinate control structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">reliable</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, the interface positions are well defined from a stable region. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">debug</parametername>
</parameternamelist>
<parameterdescription>
<para>If present and true, do debugging checks. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_neglect</parametername>
</parameternamelist>
<parameterdescription>
<para>A negligibly small width for the purpose of cell reconstructions [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h_neglect_edge</parametername>
</parameternamelist>
<parameterdescription>
<para>A negligibly small width for the purpose of edge value calculations [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_slight.F90" line="487" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/coord_slight.F90" bodystart="489" bodyend="732"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <references refid="namespaceregrid__interp_1a6543421d37edc724a8a7928ccf54a21c" compoundref="regrid__interp_8F90" startline="66" endline="66">regrid_interp::nr_iterations</references>
        <references refid="namespaceregrid__interp_1aa85701b7a23c13c6ac8b19916b13bb3e" compoundref="regrid__interp_8F90" startline="68" endline="68">regrid_interp::nr_tolerance</references>
        <referencedby refid="namespacecoord__slight_1a5f58a9ec734faa72781a86ff57e482f9" compoundref="coord__slight_8F90" startline="183" endline="482">build_slight_column</referencedby>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Regrid columns for the SLight coordinate. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/ALE/coord_slight.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
