<?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.18">
  <compounddef id="namespacecoord__sigma" kind="namespace" language="Fortran">
    <compoundname>coord_sigma</compoundname>
    <innerclass refid="structcoord__sigma_1_1sigma__cs" prot="public">coord_sigma::sigma_cs</innerclass>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacecoord__sigma_1adce9c462a3b61ba3791035534e1d8b2a" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public coord_sigma::init_coord_sigma</definition>
        <argsstring>(CS, nk, coordinateResolution)</argsstring>
        <name>init_coord_sigma</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 sigma_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">coordinateresolution</parametername>
</parameternamelist>
<parameterdescription>
<para>Nominal coordinate resolution [nondim] </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ALE/coord_sigma.F90" line="28" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/coord_sigma.F90" bodystart="29" bodyend="38"/>
        <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__sigma_1ac2489166e8a1e3e891b2e05df3b8d422" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public coord_sigma::end_coord_sigma</definition>
        <argsstring>(CS)</argsstring>
        <name>end_coord_sigma</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>This subroutine deallocates memory in the control structure for the <ref refid="namespacecoord__sigma" kindref="compound">coord_sigma</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_sigma.F90" line="42" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/coord_sigma.F90" bodystart="43" bodyend="48"/>
        <referencedby refid="namespacemom__regridding_1a9f55ab3a80ab1202b7664e9c65ebf08b" compoundref="MOM__regridding_8F90" startline="794" endline="807">mom_regridding::end_regridding</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacecoord__sigma_1aceccbaf232379cea8182c04130c03f5a" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public coord_sigma::set_sigma_params</definition>
        <argsstring>(CS, min_thickness)</argsstring>
        <name>set_sigma_params</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>min_thickness</type>
          <defname>min_thickness</defname>
        </param>
        <briefdescription>
<para>This subroutine can be used to set the parameters for the <ref refid="namespacecoord__sigma" kindref="compound">coord_sigma</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">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_sigma.F90" line="52" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/coord_sigma.F90" bodystart="53" bodyend="58"/>
        <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__sigma_1af3954fd955a967aa2ff11c2fc115dc19" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public coord_sigma::build_sigma_column</definition>
        <argsstring>(CS, depth, totalThickness, zInterface)</argsstring>
        <name>build_sigma_column</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>depth</type>
          <defname>depth</defname>
        </param>
        <param>
          <type>totalThickness</type>
          <defname>totalThickness</defname>
        </param>
        <param>
          <type>zInterface</type>
          <defname>zInterface</defname>
        </param>
        <briefdescription>
<para>Build a sigma 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 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">totalthickness</parametername>
</parameternamelist>
<parameterdescription>
<para>Column thickness (positive [H ~&gt; m or kg m-2]) </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">zinterface</parametername>
</parameternamelist>
<parameterdescription>
<para>Absolute positions of interfaces [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_sigma.F90" line="63" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ALE/coord_sigma.F90" bodystart="64" bodyend="80"/>
        <referencedby refid="namespacemom__regridding_1a455d807ccfbbfd109be231321bec1038" compoundref="MOM__regridding_8F90" startline="1249" endline="1320">mom_regridding::build_sigma_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 the sigma coordinate. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/ALE/coord_sigma.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
