<?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.20" xml:lang="en-US">
  <compounddef id="namespacemom__get__input" kind="namespace" language="Fortran">
    <compoundname>mom_get_input</compoundname>
    <innerclass refid="structmom__get__input_1_1directories" prot="public">mom_get_input::directories</innerclass>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacemom__get__input_1a46e89b56d1317f17ccb44b3fa7694731" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_get_input::get_mom_input</definition>
        <argsstring>(param_file, dirs, check_params, default_input_filename, ensemble_num)</argsstring>
        <name>get_mom_input</name>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>dirs</type>
          <defname>dirs</defname>
        </param>
        <param>
          <type>check_params</type>
          <defname>check_params</defname>
        </param>
        <param>
          <type>default_input_filename</type>
          <defname>default_input_filename</defname>
        </param>
        <param>
          <type>ensemble_num</type>
          <defname>ensemble_num</defname>
        </param>
        <briefdescription>
<para>Get the names of the I/O directories and initialization file. Also calls the subroutine that opens run-time parameter files. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="out">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure to parse for run-time parameters. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">dirs</parametername>
</parameternamelist>
<parameterdescription>
<para>Container for paths and parameter file names. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">check_params</parametername>
</parameternamelist>
<parameterdescription>
<para>If present and False will stop error checking for run-time parameters. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">default_input_filename</parametername>
</parameternamelist>
<parameterdescription>
<para>If present, is the value assumed for input_filename if input_filename is not listed in the namelist MOM_input_nml. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ensemble_num</parametername>
</parameternamelist>
<parameterdescription>
<para>The ensemble id of the current member </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_get_input.F90" line="34" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_get_input.F90" bodystart="35" bodyend="116"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <references refid="namespacemom__file__parser_1abecae1b9386aafa17aec927af1f8c448" compoundref="MOM__file__parser_8F90" startline="117" endline="236">mom_file_parser::open_param_file</references>
        <referencedby refid="namespacemom__tracer__flow__control_1a736899f8b0b79d0e98384abf2b084880" compoundref="MOM__tracer__flow__control_8F90" startline="113" endline="133">mom_tracer_flow_control::call_tracer_flux_init</referencedby>
        <referencedby refid="namespacemom__oda__driver__mod_1aaaf67b8d0e0db3ba3dfe09e24d2b8b24" compoundref="MOM__oda__driver_8F90" startline="115" endline="303">mom_oda_driver_mod::init_oda</referencedby>
        <referencedby refid="namespacemom__ice__shelf_1a5990f9918493ff4984245eac74e5f4d9" compoundref="MOM__ice__shelf_8F90" startline="1084" endline="1638">mom_ice_shelf::initialize_ice_shelf</referencedby>
        <referencedby refid="namespacemom_1a96708b16215666edbfa5b46228f3a200" compoundref="MOM_8F90" startline="1604" endline="2769">mom::initialize_mom</referencedby>
        <referencedby refid="namespacemom__surface__forcing_1a791cb2bd2daa4fd3f036b121995bfb6c" compoundref="MOM__surface__forcing_8F90" startline="1540" endline="1961">mom_surface_forcing::surface_forcing_init</referencedby>
        <referencedby refid="namespacemom__surface__forcing__gfdl_1a25a6cb8f96867efc90dc0f4e79802c6e" compoundref="MOM__surface__forcing__gfdl_8F90" startline="1233" endline="1601">mom_surface_forcing_gfdl::surface_forcing_init</referencedby>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Reads the only Fortran name list needed to boot-strap the model. </para>
    </briefdescription>
    <detaileddescription>
<para>The name list parameters indicate which directories to use for certain types of input and output, and which files to look in for the full parsable input parameter file(s). </para>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_get_input.F90" line="6" column="1"/>
  </compounddef>
</doxygen>
