<?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="namespacemom__obsolete__diagnostics" kind="namespace" language="Fortran">
    <compoundname>mom_obsolete_diagnostics</compoundname>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacemom__obsolete__diagnostics_1ad5e890c09abd2c650beb9ac36bbb49b4" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_obsolete_diagnostics::register_obsolete_diagnostics</definition>
        <argsstring>(param_file, diag)</argsstring>
        <name>register_obsolete_diagnostics</name>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>diag</type>
          <defname>diag</defname>
        </param>
        <briefdescription>
<para>Scan through the diag_table searching for obsolete parameters and issue informational messages and optionallly a FATAL error. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>The parameter file handle. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">diag</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure used to control diagnostics. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_obsolete_diagnostics.F90" line="22" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_obsolete_diagnostics.F90" bodystart="23" bodyend="61"/>
        <references refid="namespacemom__obsolete__diagnostics_1a137ff7cb882b715d0ccf915fef52386c" compoundref="MOM__obsolete__diagnostics_8F90" startline="67" endline="90">found_in_diagtable</references>
        <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>
      </memberdef>
      <memberdef kind="function" id="namespacemom__obsolete__diagnostics_1a137ff7cb882b715d0ccf915fef52386c" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>logical function</type>
        <definition>logical function mom_obsolete_diagnostics::found_in_diagtable</definition>
        <argsstring>(diag, varName, newVarName)</argsstring>
        <name>found_in_diagtable</name>
        <param>
          <type>diag</type>
          <defname>diag</defname>
        </param>
        <param>
          <type>varName</type>
          <defname>varName</defname>
        </param>
        <param>
          <type>newVarName</type>
          <defname>newVarName</defname>
        </param>
        <briefdescription>
<para>Fakes a register of a diagnostic to find out if an obsolete parameter appears in the diag_table. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">diag</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure used to control diagnostics. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">varname</parametername>
</parameternamelist>
<parameterdescription>
<para>The obsolete diagnostic name </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">newvarname</parametername>
</parameternamelist>
<parameterdescription>
<para>The valid name of this diagnostic </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_obsolete_diagnostics.F90" line="66" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_obsolete_diagnostics.F90" bodystart="67" bodyend="90"/>
        <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>
        <referencedby refid="namespacemom__obsolete__diagnostics_1ad5e890c09abd2c650beb9ac36bbb49b4" compoundref="MOM__obsolete__diagnostics_8F90" startline="23" endline="61">register_obsolete_diagnostics</referencedby>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Provides a mechanism for recording diagnostic variables that are no longer valid, along with their replacement name if appropriate. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/diagnostics/MOM_obsolete_diagnostics.F90" line="3" column="1"/>
  </compounddef>
</doxygen>
