<?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="namespaceuser__shelf__init" kind="namespace" language="Fortran">
    <compoundname>user_shelf_init</compoundname>
    <innerclass refid="structuser__shelf__init_1_1user__ice__shelf__cs" prot="public">user_shelf_init::user_ice_shelf_cs</innerclass>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespaceuser__shelf__init_1abfa7467860df5279c0c9f95d79cb51cf" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public user_shelf_init::user_initialize_shelf_mass</definition>
        <argsstring>(mass_shelf, area_shelf_h, h_shelf, hmask, G, US, CS, param_file, new_sim)</argsstring>
        <name>user_initialize_shelf_mass</name>
        <param>
          <type>mass_shelf</type>
          <defname>mass_shelf</defname>
        </param>
        <param>
          <type>area_shelf_h</type>
          <defname>area_shelf_h</defname>
        </param>
        <param>
          <type>h_shelf</type>
          <defname>h_shelf</defname>
        </param>
        <param>
          <type>hmask</type>
          <defname>hmask</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>new_sim</type>
          <defname>new_sim</defname>
        </param>
        <briefdescription>
<para>This subroutine sets up the initial mass and area covered by the ice shelf, based on user-provided code. </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="out">mass_shelf</parametername>
</parameternamelist>
<parameterdescription>
<para>The ice shelf mass per unit area averaged </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">h_shelf</parametername>
</parameternamelist>
<parameterdescription>
<para>The ice shelf thickness [Z ~&gt; m]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">area_shelf_h</parametername>
</parameternamelist>
<parameterdescription>
<para>The area per cell covered by the ice shelf [L2 ~&gt; m2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">hmask</parametername>
</parameternamelist>
<parameterdescription>
<para>A mask indicating which tracer points are </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">us</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure containing unit conversion factors </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to the user ice shelf control structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure to parse for run-time parameters </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">new_sim</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, this is a new run; otherwise it is being started from a restart file. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ice_shelf/user_shelf_init.F90" line="43" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ice_shelf/user_shelf_init.F90" bodystart="44" bodyend="98"/>
        <references refid="namespaceuser__shelf__init_1abd99438d24c4a57aa3fbab3b067a7c81" compoundref="user__shelf__init_8F90" startline="125" endline="197">user_update_shelf_mass</references>
        <references refid="namespaceuser__shelf__init_1a04dc4958214e8b07da385f8be785d706" compoundref="user__shelf__init_8F90" startline="202" endline="209">write_user_log</references>
        <referencedby refid="namespaceuser__shelf__init_1a2e30414d0486dbf423978be7eea677bd" compoundref="user__shelf__init_8F90" startline="103" endline="120">user_init_ice_thickness</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespaceuser__shelf__init_1a2e30414d0486dbf423978be7eea677bd" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public user_shelf_init::user_init_ice_thickness</definition>
        <argsstring>(h_shelf, area_shelf_h, hmask, G, US, param_file)</argsstring>
        <name>user_init_ice_thickness</name>
        <param>
          <type>h_shelf</type>
          <defname>h_shelf</defname>
        </param>
        <param>
          <type>area_shelf_h</type>
          <defname>area_shelf_h</defname>
        </param>
        <param>
          <type>hmask</type>
          <defname>hmask</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <briefdescription>
<para>This subroutine updates the ice shelf thickness, as specified by user-provided code. </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="out">h_shelf</parametername>
</parameternamelist>
<parameterdescription>
<para>The ice shelf thickness [m]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">area_shelf_h</parametername>
</parameternamelist>
<parameterdescription>
<para>The area per cell covered by the ice shelf [L2 ~&gt; m2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">hmask</parametername>
</parameternamelist>
<parameterdescription>
<para>A mask indicating which tracer points are </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">us</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure containing unit conversion factors </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure to parse for run-time parameters </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ice_shelf/user_shelf_init.F90" line="102" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ice_shelf/user_shelf_init.F90" bodystart="103" bodyend="120"/>
        <references refid="namespaceuser__shelf__init_1abfa7467860df5279c0c9f95d79cb51cf" compoundref="user__shelf__init_8F90" startline="44" endline="98">user_initialize_shelf_mass</references>
        <referencedby refid="namespacemom__ice__shelf__initialize_1a1a45ca83d02a01108e202584a95e7527" compoundref="MOM__ice__shelf__initialize_8F90" startline="29" endline="56">mom_ice_shelf_initialize::initialize_ice_thickness</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespaceuser__shelf__init_1abd99438d24c4a57aa3fbab3b067a7c81" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public user_shelf_init::user_update_shelf_mass</definition>
        <argsstring>(mass_shelf, area_shelf_h, h_shelf, hmask, G, CS, Time, new_sim)</argsstring>
        <name>user_update_shelf_mass</name>
        <param>
          <type>mass_shelf</type>
          <defname>mass_shelf</defname>
        </param>
        <param>
          <type>area_shelf_h</type>
          <defname>area_shelf_h</defname>
        </param>
        <param>
          <type>h_shelf</type>
          <defname>h_shelf</defname>
        </param>
        <param>
          <type>hmask</type>
          <defname>hmask</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>Time</type>
          <defname>Time</defname>
        </param>
        <param>
          <type>new_sim</type>
          <defname>new_sim</defname>
        </param>
        <briefdescription>
<para>This subroutine updates the ice shelf mass, as specified by user-provided code. </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="inout">mass_shelf</parametername>
</parameternamelist>
<parameterdescription>
<para>The ice shelf mass per unit area averaged </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">area_shelf_h</parametername>
</parameternamelist>
<parameterdescription>
<para>The area per cell covered by the ice shelf [L2 ~&gt; m2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">h_shelf</parametername>
</parameternamelist>
<parameterdescription>
<para>The ice shelf thickness [Z ~&gt; m]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">hmask</parametername>
</parameternamelist>
<parameterdescription>
<para>A mask indicating which tracer points are </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to the user ice shelf control structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">time</parametername>
</parameternamelist>
<parameterdescription>
<para>The current model time </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">new_sim</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, this the start of a new run. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ice_shelf/user_shelf_init.F90" line="124" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ice_shelf/user_shelf_init.F90" bodystart="125" bodyend="197"/>
        <referencedby refid="namespaceuser__shelf__init_1abfa7467860df5279c0c9f95d79cb51cf" compoundref="user__shelf__init_8F90" startline="44" endline="98">user_initialize_shelf_mass</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespaceuser__shelf__init_1a04dc4958214e8b07da385f8be785d706" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine user_shelf_init::write_user_log</definition>
        <argsstring>(param_file)</argsstring>
        <name>write_user_log</name>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <briefdescription>
<para>This subroutine writes out the user ice shelf code version number to the model log. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure to parse for run-time parameters </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ice_shelf/user_shelf_init.F90" line="201" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ice_shelf/user_shelf_init.F90" bodystart="202" bodyend="209"/>
        <referencedby refid="namespaceuser__shelf__init_1abfa7467860df5279c0c9f95d79cb51cf" compoundref="user__shelf__init_8F90" startline="44" endline="98">user_initialize_shelf_mass</referencedby>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>This module specifies the initial values and evolving properties of the MOM6 ice shelf, using user-provided code. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/ice_shelf/user_shelf_init.F90" line="3" column="1"/>
  </compounddef>
</doxygen>
