<?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="namespacemom__marine__ice" kind="namespace" language="Fortran">
    <compoundname>mom_marine_ice</compoundname>
    <innerclass refid="structmom__marine__ice_1_1marine__ice__cs" prot="public">mom_marine_ice::marine_ice_cs</innerclass>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacemom__marine__ice_1af84733e6afc851704bbfd1051aea0487" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_marine_ice::iceberg_forces</definition>
        <argsstring>(G, forces, use_ice_shelf, sfc_state, time_step, CS)</argsstring>
        <name>iceberg_forces</name>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>forces</type>
          <defname>forces</defname>
        </param>
        <param>
          <type>use_ice_shelf</type>
          <defname>use_ice_shelf</defname>
        </param>
        <param>
          <type>sfc_state</type>
          <defname>sfc_state</defname>
        </param>
        <param>
          <type>time_step</type>
          <defname>time_step</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>add_berg_flux_to_shelf adds rigidity and ice-area coverage due to icebergs to the forces type fields, and adds ice-areal coverage and modifies various thermodynamic fluxes due to the presence of icebergs. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">g</parametername>
</parameternamelist>
<parameterdescription>
<para>The ocean&apos;s grid structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">forces</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure with the driving mechanical forces </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">sfc_state</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure containing fields that describe the surface state of the ocean. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">use_ice_shelf</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, this configuration uses ice shelves. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">time_step</parametername>
</parameternamelist>
<parameterdescription>
<para>The coupling time step [s]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Pointer to the control structure for MOM_marine_ice </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ice_shelf/MOM_marine_ice.F90" line="45" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ice_shelf/MOM_marine_ice.F90" bodystart="46" bodyend="96"/>
        <references refid="namespacemom__domains_1aa7d2122aa278771209b860dbd6788097" compoundref="MOM__domains_8F90" startline="137" endline="137">mom_domains::to_all</references>
        <referencedby refid="namespaceocean__model__mod_1a497d254b44f58fb797b9d75bc006eb60" compoundref="ocean__model__MOM_8F90" startline="424" endline="668">ocean_model_mod::update_ocean_model</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__marine__ice_1a7deb4a003d193fd5ba6614d2a683cba6" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_marine_ice::iceberg_fluxes</definition>
        <argsstring>(G, US, fluxes, use_ice_shelf, sfc_state, time_step, CS)</argsstring>
        <name>iceberg_fluxes</name>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>fluxes</type>
          <defname>fluxes</defname>
        </param>
        <param>
          <type>use_ice_shelf</type>
          <defname>use_ice_shelf</defname>
        </param>
        <param>
          <type>sfc_state</type>
          <defname>sfc_state</defname>
        </param>
        <param>
          <type>time_step</type>
          <defname>time_step</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>iceberg_fluxes adds ice-area-coverage and modifies various thermodynamic fluxes due to the presence of icebergs. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">g</parametername>
</parameternamelist>
<parameterdescription>
<para>The ocean&apos;s 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="inout">fluxes</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure with pointers to themodynamic, tracer and mass exchange forcing fields </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">sfc_state</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure containing fields that describe the surface state of the ocean. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">use_ice_shelf</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, this configuration uses ice shelves. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">time_step</parametername>
</parameternamelist>
<parameterdescription>
<para>The coupling time step [s]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Pointer to the control structure for MOM_marine_ice </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ice_shelf/MOM_marine_ice.F90" line="101" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ice_shelf/MOM_marine_ice.F90" bodystart="102" bodyend="169"/>
        <referencedby refid="namespaceocean__model__mod_1a497d254b44f58fb797b9d75bc006eb60" compoundref="ocean__model__MOM_8F90" startline="424" endline="668">ocean_model_mod::update_ocean_model</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__marine__ice_1a72f210b9737887a318aa7dd2779e8850" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_marine_ice::marine_ice_init</definition>
        <argsstring>(Time, G, param_file, diag, CS)</argsstring>
        <name>marine_ice_init</name>
        <param>
          <type>Time</type>
          <defname>Time</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>diag</type>
          <defname>diag</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>Initialize control structure for MOM_marine_ice. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">time</parametername>
</parameternamelist>
<parameterdescription>
<para>Current model time </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean grid structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>Runtime parameter handles </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">diag</parametername>
</parameternamelist>
<parameterdescription>
<para>Diagnostics control structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Pointer to the control structure for MOM_marine_ice </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/ice_shelf/MOM_marine_ice.F90" line="173" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/ice_shelf/MOM_marine_ice.F90" bodystart="174" bodyend="202"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <referencedby refid="namespaceocean__model__mod_1a51ac9bb5e227e4a3f8be94a09a77eba8" compoundref="ocean__model__MOM_8F90" startline="228" endline="413">ocean_model_mod::ocean_model_init</referencedby>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Routines incorporating the effects of marine ice (sea-ice and icebergs) into the ocean model dynamics and thermodynamics. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/ice_shelf/MOM_marine_ice.F90" line="3" column="1"/>
  </compounddef>
</doxygen>
