<?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__obsolete__params" kind="namespace" language="Fortran">
    <compoundname>mom_obsolete_params</compoundname>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacemom__obsolete__params_1adeed714b8b74959c25e3acd8e40061f6" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_obsolete_params::find_obsolete_params</definition>
        <argsstring>(param_file)</argsstring>
        <name>find_obsolete_params</name>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <briefdescription>
<para>Scans input parameter file for list obsolete parameters. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>Structure containing parameter file data. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_obsolete_params.F90" line="20" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_obsolete_params.F90" bodystart="21" bodyend="97"/>
        <references refid="namespacemom__error__handler_1ad5f00a53059c72fe2332d1436c80ca71" compoundref="MOM__error__handler_8F90" startline="44" endline="48">mom_error_handler::is_root_pe</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__obsolete__params_1a6c1f3234bdde506565cc552c53dedaf8" compoundref="MOM__obsolete__params_8F90" startline="145" endline="173">obsolete_char</references>
        <references refid="namespacemom__obsolete__params_1aa0a8fe574d071d3a40ac146c2b8070f0" compoundref="MOM__obsolete__params_8F90" startline="204" endline="225">obsolete_int</references>
        <references refid="namespacemom__obsolete__params_1a0f74da6ca1e81bb5029fbdcd284d5427" compoundref="MOM__obsolete__params_8F90" startline="102" endline="140">obsolete_logical</references>
        <references refid="namespacemom__obsolete__params_1ae7343199aaed0daa5cda091cbd136c0c" compoundref="MOM__obsolete__params_8F90" startline="178" endline="199">obsolete_real</references>
        <referencedby refid="namespacemom_1a96708b16215666edbfa5b46228f3a200" compoundref="MOM_8F90" startline="1604" endline="2769">mom::initialize_mom</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__obsolete__params_1a0f74da6ca1e81bb5029fbdcd284d5427" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_obsolete_params::obsolete_logical</definition>
        <argsstring>(param_file, varname, warning_val, hint)</argsstring>
        <name>obsolete_logical</name>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>varname</type>
          <defname>varname</defname>
        </param>
        <param>
          <type>warning_val</type>
          <defname>warning_val</defname>
        </param>
        <param>
          <type>hint</type>
          <defname>hint</defname>
        </param>
        <briefdescription>
<para>Test for presence of obsolete LOGICAL in parameter file. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>Structure containing parameter file data. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">varname</parametername>
</parameternamelist>
<parameterdescription>
<para>Name of obsolete LOGICAL parameter. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">warning_val</parametername>
</parameternamelist>
<parameterdescription>
<para>An allowed value that causes a warning instead of an error. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">hint</parametername>
</parameternamelist>
<parameterdescription>
<para>A hint to the user about what to do. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_obsolete_params.F90" line="101" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_obsolete_params.F90" bodystart="102" bodyend="140"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <referencedby refid="namespacemom__obsolete__params_1adeed714b8b74959c25e3acd8e40061f6" compoundref="MOM__obsolete__params_8F90" startline="21" endline="97">find_obsolete_params</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__obsolete__params_1a6c1f3234bdde506565cc552c53dedaf8" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_obsolete_params::obsolete_char</definition>
        <argsstring>(param_file, varname, warning_val, hint)</argsstring>
        <name>obsolete_char</name>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>varname</type>
          <defname>varname</defname>
        </param>
        <param>
          <type>warning_val</type>
          <defname>warning_val</defname>
        </param>
        <param>
          <type>hint</type>
          <defname>hint</defname>
        </param>
        <briefdescription>
<para>Test for presence of obsolete STRING in parameter file. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>Structure containing parameter file data. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">varname</parametername>
</parameternamelist>
<parameterdescription>
<para>Name of obsolete STRING parameter. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">warning_val</parametername>
</parameternamelist>
<parameterdescription>
<para>An allowed value that causes a warning instead of an error. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">hint</parametername>
</parameternamelist>
<parameterdescription>
<para>A hint to the user about what to do. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_obsolete_params.F90" line="144" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_obsolete_params.F90" bodystart="145" bodyend="173"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <referencedby refid="namespacemom__obsolete__params_1adeed714b8b74959c25e3acd8e40061f6" compoundref="MOM__obsolete__params_8F90" startline="21" endline="97">find_obsolete_params</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__obsolete__params_1ae7343199aaed0daa5cda091cbd136c0c" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_obsolete_params::obsolete_real</definition>
        <argsstring>(param_file, varname, warning_val, hint)</argsstring>
        <name>obsolete_real</name>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>varname</type>
          <defname>varname</defname>
        </param>
        <param>
          <type>warning_val</type>
          <defname>warning_val</defname>
        </param>
        <param>
          <type>hint</type>
          <defname>hint</defname>
        </param>
        <briefdescription>
<para>Test for presence of obsolete REAL in parameter file. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>Structure containing parameter file data. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">varname</parametername>
</parameternamelist>
<parameterdescription>
<para>Name of obsolete REAL parameter. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">warning_val</parametername>
</parameternamelist>
<parameterdescription>
<para>An allowed value that causes a warning instead of an error. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">hint</parametername>
</parameternamelist>
<parameterdescription>
<para>A hint to the user about what to do. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_obsolete_params.F90" line="177" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_obsolete_params.F90" bodystart="178" bodyend="199"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <referencedby refid="namespacemom__obsolete__params_1adeed714b8b74959c25e3acd8e40061f6" compoundref="MOM__obsolete__params_8F90" startline="21" endline="97">find_obsolete_params</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__obsolete__params_1aa0a8fe574d071d3a40ac146c2b8070f0" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_obsolete_params::obsolete_int</definition>
        <argsstring>(param_file, varname, warning_val, hint)</argsstring>
        <name>obsolete_int</name>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>varname</type>
          <defname>varname</defname>
        </param>
        <param>
          <type>warning_val</type>
          <defname>warning_val</defname>
        </param>
        <param>
          <type>hint</type>
          <defname>hint</defname>
        </param>
        <briefdescription>
<para>Test for presence of obsolete INTEGER in parameter file. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>Structure containing parameter file data. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">varname</parametername>
</parameternamelist>
<parameterdescription>
<para>Name of obsolete INTEGER parameter. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">warning_val</parametername>
</parameternamelist>
<parameterdescription>
<para>An allowed value that causes a warning instead of an error. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">hint</parametername>
</parameternamelist>
<parameterdescription>
<para>A hint to the user about what to do. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_obsolete_params.F90" line="203" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_obsolete_params.F90" bodystart="204" bodyend="225"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <referencedby refid="namespacemom__obsolete__params_1adeed714b8b74959c25e3acd8e40061f6" compoundref="MOM__obsolete__params_8F90" startline="21" endline="97">find_obsolete_params</referencedby>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Methods for testing for, and list of, obsolete run-time parameters. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_obsolete_params.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
