<?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="namespaceisomip__initialization" kind="namespace" language="Fortran">
    <compoundname>isomip_initialization</compoundname>
      <sectiondef kind="var">
      <memberdef kind="variable" id="namespaceisomip__initialization_1a17eb636ac16e051364e1a96cc860d8e8" prot="private" static="no" mutable="no">
        <type><ref refid="version__variable_8h_1acda997fe1761de4c6bca0f27dc786964" kindref="member">character</ref>(len=40)</type>
        <definition>character(len=40) isomip_initialization::mdl</definition>
        <argsstring></argsstring>
        <name>mdl</name>
        <initializer>= &quot;ISOMIP_initialization&quot;</initializer>
        <briefdescription>
<para>This module&apos;s name. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/ISOMIP_initialization.F90" line="28" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/ISOMIP_initialization.F90" bodystart="28" bodyend="28"/>
        <referencedby refid="namespaceisomip__initialization_1a5605d312795e2d4770571052da07859f" compoundref="ISOMIP__initialization_8F90" startline="425" endline="672">isomip_initialize_sponges</referencedby>
        <referencedby refid="namespaceisomip__initialization_1ac90d1dbdbf22f4cf30de1452efd29d52" compoundref="ISOMIP__initialization_8F90" startline="255" endline="418">isomip_initialize_temperature_salinity</referencedby>
        <referencedby refid="namespaceisomip__initialization_1a748a8a53677059ad0c1c88ff5d0339aa" compoundref="ISOMIP__initialization_8F90" startline="134" endline="249">isomip_initialize_thickness</referencedby>
        <referencedby refid="namespaceisomip__initialization_1a7292729944785b82fbeb51a27029b1b3" compoundref="ISOMIP__initialization_8F90" startline="45" endline="129">isomip_initialize_topography</referencedby>
      </memberdef>
      </sectiondef>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespaceisomip__initialization_1a7292729944785b82fbeb51a27029b1b3" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public isomip_initialization::isomip_initialize_topography</definition>
        <argsstring>(D, G, param_file, max_depth, US)</argsstring>
        <name>isomip_initialize_topography</name>
        <param>
          <type>D</type>
          <defname>D</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>max_depth</type>
          <defname>max_depth</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <briefdescription>
<para>Initialization of topography for the ISOMIP configuration. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>The dynamic horizontal grid type </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">d</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean bottom depth in m or Z if US is present </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>Parameter file structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">max_depth</parametername>
</parameternamelist>
<parameterdescription>
<para>Maximum model depth in the units of D </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">us</parametername>
</parameternamelist>
<parameterdescription>
<para>A dimensional unit scaling type </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/ISOMIP_initialization.F90" line="44" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/ISOMIP_initialization.F90" bodystart="45" bodyend="129"/>
        <references refid="namespaceisomip__initialization_1a17eb636ac16e051364e1a96cc860d8e8" compoundref="ISOMIP__initialization_8F90" startline="28" endline="28">mdl</references>
        <references refid="namespacemom__error__handler_1a1c462df7b61f1296407b4af51dfeceab" compoundref="MOM__error__handler_8F90" startline="53" endline="66">mom_error_handler::mom_mesg</references>
        <referencedby refid="namespacemom__fixed__initialization_1ae980c841ada6296d07df08442398e87b" compoundref="MOM__fixed__initialization_8F90" startline="175" endline="257">mom_fixed_initialization::mom_initialize_topography</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespaceisomip__initialization_1a748a8a53677059ad0c1c88ff5d0339aa" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public isomip_initialization::isomip_initialize_thickness</definition>
        <argsstring>(h, G, GV, US, param_file, tv, just_read_params)</argsstring>
        <name>isomip_initialize_thickness</name>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>tv</type>
          <defname>tv</defname>
        </param>
        <param>
          <type>just_read_params</type>
          <defname>just_read_params</defname>
        </param>
        <briefdescription>
<para>Initialization of thicknesses. </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="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>The ocean&apos;s vertical 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="out">h</parametername>
</parameternamelist>
<parameterdescription>
<para>The thickness that is being initialized [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure indicating the open file to parse for model parameter values. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">tv</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure containing pointers to any available thermodynamic fields, including the eqn. of state. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">just_read_params</parametername>
</parameternamelist>
<parameterdescription>
<para>If present and true, this call will only read parameters without changing h. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/ISOMIP_initialization.F90" line="133" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/ISOMIP_initialization.F90" bodystart="134" bodyend="249"/>
        <references refid="namespaceisomip__initialization_1a17eb636ac16e051364e1a96cc860d8e8" compoundref="ISOMIP__initialization_8F90" startline="28" endline="28">mdl</references>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <references refid="namespacemom__error__handler_1a1c462df7b61f1296407b4af51dfeceab" compoundref="MOM__error__handler_8F90" startline="53" endline="66">mom_error_handler::mom_mesg</references>
        <references refid="namespaceregrid__consts_1afa0560b2e29c73ee4427e46f9a0a97c8" compoundref="regrid__consts_8F90" startline="21" endline="21">regrid_consts::regridding_sigma_shelf_zstar</references>
      </memberdef>
      <memberdef kind="function" id="namespaceisomip__initialization_1ac90d1dbdbf22f4cf30de1452efd29d52" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public isomip_initialization::isomip_initialize_temperature_salinity</definition>
        <argsstring>(T, S, h, G, GV, US, param_file, eqn_of_state, just_read_params)</argsstring>
        <name>isomip_initialize_temperature_salinity</name>
        <param>
          <type>T</type>
          <defname>T</defname>
        </param>
        <param>
          <type>S</type>
          <defname>S</defname>
        </param>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>eqn_of_state</type>
          <defname>eqn_of_state</defname>
        </param>
        <param>
          <type>just_read_params</type>
          <defname>just_read_params</defname>
        </param>
        <briefdescription>
<para>Initial values for temperature and salinity. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean grid structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>Vertical 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="out">t</parametername>
</parameternamelist>
<parameterdescription>
<para>Potential temperature [degC] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">s</parametername>
</parameternamelist>
<parameterdescription>
<para>Salinity [ppt] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thickness [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>Parameter file 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">just_read_params</parametername>
</parameternamelist>
<parameterdescription>
<para>If present and true, this call will only read parameters without changing T &amp; S. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/ISOMIP_initialization.F90" line="253" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/ISOMIP_initialization.F90" bodystart="255" bodyend="418"/>
        <references refid="namespaceisomip__initialization_1a17eb636ac16e051364e1a96cc860d8e8" compoundref="ISOMIP__initialization_8F90" startline="28" endline="28">mdl</references>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <references refid="namespaceregrid__consts_1afa0560b2e29c73ee4427e46f9a0a97c8" compoundref="regrid__consts_8F90" startline="21" endline="21">regrid_consts::regridding_sigma_shelf_zstar</references>
        <referencedby refid="namespacemom__state__initialization_1a81503d4f1855cb185f122d6314e4f06c" compoundref="MOM__state__initialization_8F90" startline="117" endline="615">mom_state_initialization::mom_initialize_state</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespaceisomip__initialization_1a5605d312795e2d4770571052da07859f" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public isomip_initialization::isomip_initialize_sponges</definition>
        <argsstring>(G, GV, US, tv, PF, use_ALE, CSp, ACSp)</argsstring>
        <name>isomip_initialize_sponges</name>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>tv</type>
          <defname>tv</defname>
        </param>
        <param>
          <type>PF</type>
          <defname>PF</defname>
        </param>
        <param>
          <type>use_ALE</type>
          <defname>use_ALE</defname>
        </param>
        <param>
          <type>CSp</type>
          <defname>CSp</defname>
        </param>
        <param>
          <type>ACSp</type>
          <defname>ACSp</defname>
        </param>
        <briefdescription>
<para>Sets up the the inverse restoration time (Idamp), and. </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="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>The ocean&apos;s vertical 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="in">tv</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure containing pointers to any available thermodynamic fields, potential temperature and salinity or mixed layer density. Absent fields have NULL ptrs. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">pf</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure indicating the open file to parse for model parameter values. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">use_ale</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, indicates model is in ALE mode </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>csp</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer-mode sponge structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>acsp</parametername>
</parameternamelist>
<parameterdescription>
<para>ALE-mode sponge structure </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/ISOMIP_initialization.F90" line="424" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/ISOMIP_initialization.F90" bodystart="425" bodyend="672"/>
        <references refid="namespacemom__sponge_1a2c3c6a03d98c13221031af667b42428d" compoundref="MOM__sponge_8F90" startline="90" endline="187">mom_sponge::initialize_sponge</references>
        <references refid="namespaceisomip__initialization_1a17eb636ac16e051364e1a96cc860d8e8" compoundref="ISOMIP__initialization_8F90" startline="28" endline="28">mdl</references>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <references refid="namespaceregrid__consts_1afa0560b2e29c73ee4427e46f9a0a97c8" compoundref="regrid__consts_8F90" startline="21" endline="21">regrid_consts::regridding_sigma_shelf_zstar</references>
        <references refid="namespacemom__sponge_1af3da4a8b352c4130919d7bfedf1a5a3e" compoundref="MOM__sponge_8F90" startline="214" endline="270">mom_sponge::set_up_sponge_field</references>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Configures the ISOMIP test case. </para>
    </briefdescription>
    <detaileddescription>
<para>See this paper for details: <ulink url="http://www.geosci-model-dev-discuss.net/8/9859/2015/gmdd-8-9859-2015.pdf">http://www.geosci-model-dev-discuss.net/8/9859/2015/gmdd-8-9859-2015.pdf</ulink> </para>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/user/ISOMIP_initialization.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
