<?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.14">
  <compounddef id="interfacemom__file__parser_1_1read__param" kind="interface" language="Fortran" prot="public">
    <compoundname>mom_file_parser::read_param</compoundname>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="interfacemom__file__parser_1_1read__param_1a2ec3af5c2d4cf6e92e86e40a69066c0b" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_file_parser::read_param::read_param_int</definition>
        <argsstring>(CS, varname, value, fail_if_missing)</argsstring>
        <name>read_param_int</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>varname</type>
          <defname>varname</defname>
        </param>
        <param>
          <type>value</type>
          <defname>value</defname>
        </param>
        <param>
          <type>fail_if_missing</type>
          <defname>fail_if_missing</defname>
        </param>
        <briefdescription>
<para>This subroutine reads the value of an integer model parameter from a parameter file. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>The control structure for the file_parser module, it is also a structure to parse for run-time parameters</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">varname</parametername>
</parameternamelist>
<parameterdescription>
<para>The case-sensitive name of the parameter to read</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">value</parametername>
</parameternamelist>
<parameterdescription>
<para>The value of the parameter that may be read from the parameter file</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">fail_if_missing</parametername>
</parameternamelist>
<parameterdescription>
<para>If present and true, a fatal error occurs if this variable is not found in the parameter file </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_file_parser.F90" line="580" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_file_parser.F90" bodystart="581" bodyend="608"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__file__parser_1_1read__param_1a1c0ef29e19c1415b1ebe9ccfe7b2fd1f" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_file_parser::read_param::read_param_real</definition>
        <argsstring>(CS, varname, value, fail_if_missing, scale)</argsstring>
        <name>read_param_real</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>varname</type>
          <defname>varname</defname>
        </param>
        <param>
          <type>value</type>
          <defname>value</defname>
        </param>
        <param>
          <type>fail_if_missing</type>
          <defname>fail_if_missing</defname>
        </param>
        <param>
          <type>scale</type>
          <defname>scale</defname>
        </param>
        <briefdescription>
<para>This subroutine reads the value of a real model parameter from a parameter file. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>The control structure for the file_parser module, it is also a structure to parse for run-time parameters</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">varname</parametername>
</parameternamelist>
<parameterdescription>
<para>The case-sensitive name of the parameter to read</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">value</parametername>
</parameternamelist>
<parameterdescription>
<para>The value of the parameter that may be read from the parameter file</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">fail_if_missing</parametername>
</parameternamelist>
<parameterdescription>
<para>If present and true, a fatal error occurs if this variable is not found in the parameter file</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">scale</parametername>
</parameternamelist>
<parameterdescription>
<para>A scaling factor that the parameter is multiplied by before it is returned. </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_file_parser.F90" line="645" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_file_parser.F90" bodystart="646" bodyend="677"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__file__parser_1_1read__param_1ac597a6541686269074172edb615d9182" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_file_parser::read_param::read_param_logical</definition>
        <argsstring>(CS, varname, value, fail_if_missing)</argsstring>
        <name>read_param_logical</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>varname</type>
          <defname>varname</defname>
        </param>
        <param>
          <type>value</type>
          <defname>value</defname>
        </param>
        <param>
          <type>fail_if_missing</type>
          <defname>fail_if_missing</defname>
        </param>
        <briefdescription>
<para>This subroutine reads the value of a logical model parameter from a parameter file. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>The control structure for the file_parser module, it is also a structure to parse for run-time parameters</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">varname</parametername>
</parameternamelist>
<parameterdescription>
<para>The case-sensitive name of the parameter to read</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">value</parametername>
</parameternamelist>
<parameterdescription>
<para>The value of the parameter that may be read from the parameter file</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">fail_if_missing</parametername>
</parameternamelist>
<parameterdescription>
<para>If present and true, a fatal error occurs if this variable is not found in the parameter file </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_file_parser.F90" line="780" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_file_parser.F90" bodystart="781" bodyend="799"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__file__parser_1_1read__param_1aa4432bf14f3758eb45ec97e5202cd3fe" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_file_parser::read_param::read_param_char</definition>
        <argsstring>(CS, varname, value, fail_if_missing)</argsstring>
        <name>read_param_char</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>varname</type>
          <defname>varname</defname>
        </param>
        <param>
          <type>value</type>
          <defname>value</defname>
        </param>
        <param>
          <type>fail_if_missing</type>
          <defname>fail_if_missing</defname>
        </param>
        <briefdescription>
<para>This subroutine reads the value of a character string model parameter from a parameter file. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>The control structure for the file_parser module, it is also a structure to parse for run-time parameters</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">varname</parametername>
</parameternamelist>
<parameterdescription>
<para>The case-sensitive name of the parameter to read</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">value</parametername>
</parameternamelist>
<parameterdescription>
<para>The value of the parameter that may be read from the parameter file</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">fail_if_missing</parametername>
</parameternamelist>
<parameterdescription>
<para>If present and true, a fatal error occurs if this variable is not found in the parameter file </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_file_parser.F90" line="719" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_file_parser.F90" bodystart="720" bodyend="738"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__file__parser_1_1read__param_1aa8c50149ca73ac6771ca7c786d8b6a29" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_file_parser::read_param::read_param_char_array</definition>
        <argsstring>(CS, varname, value, fail_if_missing)</argsstring>
        <name>read_param_char_array</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>varname</type>
          <defname>varname</defname>
        </param>
        <param>
          <type>value</type>
          <defname>value</defname>
        </param>
        <param>
          <type>fail_if_missing</type>
          <defname>fail_if_missing</defname>
        </param>
        <briefdescription>
<para>This subroutine reads the values of an array of character string model parameters from a parameter file. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>The control structure for the file_parser module, it is also a structure to parse for run-time parameters</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">varname</parametername>
</parameternamelist>
<parameterdescription>
<para>The case-sensitive name of the parameter to read</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">value</parametername>
</parameternamelist>
<parameterdescription>
<para>The value of the parameter that may be read from the parameter file</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">fail_if_missing</parametername>
</parameternamelist>
<parameterdescription>
<para>If present and true, a fatal error occurs if this variable is not found in the parameter file </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_file_parser.F90" line="742" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_file_parser.F90" bodystart="743" bodyend="776"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__file__parser_1_1read__param_1abf7de1abb29512fb7496bd93df4f8f21" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_file_parser::read_param::read_param_time</definition>
        <argsstring>(CS, varname, value, timeunit, fail_if_missing, date_format)</argsstring>
        <name>read_param_time</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>varname</type>
          <defname>varname</defname>
        </param>
        <param>
          <type>value</type>
          <defname>value</defname>
        </param>
        <param>
          <type>timeunit</type>
          <defname>timeunit</defname>
        </param>
        <param>
          <type>fail_if_missing</type>
          <defname>fail_if_missing</defname>
        </param>
        <param>
          <type>date_format</type>
          <defname>date_format</defname>
        </param>
        <briefdescription>
<para>This subroutine reads the value of a time_type model parameter from a parameter file. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>The control structure for the file_parser module, it is also a structure to parse for run-time parameters</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">varname</parametername>
</parameternamelist>
<parameterdescription>
<para>The case-sensitive name of the parameter to read</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">value</parametername>
</parameternamelist>
<parameterdescription>
<para>The value of the parameter that may be read from the parameter file</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">timeunit</parametername>
</parameternamelist>
<parameterdescription>
<para>The number of seconds in a time unit for real-number input.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">fail_if_missing</parametername>
</parameternamelist>
<parameterdescription>
<para>If present and true, a fatal error occurs if this variable is not found in the parameter file</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">date_format</parametername>
</parameternamelist>
<parameterdescription>
<para>If present, this indicates whether this parameter was read in a date format, so that it can later be logged in the same format. </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_file_parser.F90" line="803" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_file_parser.F90" bodystart="804" bodyend="869"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__file__parser_1_1read__param_1abcb8b784ccf76a3dcb6748de0bf99c19" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_file_parser::read_param::read_param_int_array</definition>
        <argsstring>(CS, varname, value, fail_if_missing)</argsstring>
        <name>read_param_int_array</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>varname</type>
          <defname>varname</defname>
        </param>
        <param>
          <type>value</type>
          <defname>value</defname>
        </param>
        <param>
          <type>fail_if_missing</type>
          <defname>fail_if_missing</defname>
        </param>
        <briefdescription>
<para>This subroutine reads the values of an array of integer model parameters from a parameter file. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>The control structure for the file_parser module, it is also a structure to parse for run-time parameters</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">varname</parametername>
</parameternamelist>
<parameterdescription>
<para>The case-sensitive name of the parameter to read</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">value</parametername>
</parameternamelist>
<parameterdescription>
<para>The value of the parameter that may be read from the parameter file</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">fail_if_missing</parametername>
</parameternamelist>
<parameterdescription>
<para>If present and true, a fatal error occurs if this variable is not found in the parameter file </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_file_parser.F90" line="612" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_file_parser.F90" bodystart="613" bodyend="641"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__file__parser_1_1read__param_1a18df4cad513e32d9341704169dbe4cee" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_file_parser::read_param::read_param_real_array</definition>
        <argsstring>(CS, varname, value, fail_if_missing, scale)</argsstring>
        <name>read_param_real_array</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>varname</type>
          <defname>varname</defname>
        </param>
        <param>
          <type>value</type>
          <defname>value</defname>
        </param>
        <param>
          <type>fail_if_missing</type>
          <defname>fail_if_missing</defname>
        </param>
        <param>
          <type>scale</type>
          <defname>scale</defname>
        </param>
        <briefdescription>
<para>This subroutine reads the values of an array of real model parameters from a parameter file. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">cs</parametername>
</parameternamelist>
<parameterdescription>
<para>The control structure for the file_parser module, it is also a structure to parse for run-time parameters</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">varname</parametername>
</parameternamelist>
<parameterdescription>
<para>The case-sensitive name of the parameter to read</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">value</parametername>
</parameternamelist>
<parameterdescription>
<para>The value of the parameter that may be read from the parameter file</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">fail_if_missing</parametername>
</parameternamelist>
<parameterdescription>
<para>If present and true, a fatal error occurs if this variable is not found in the parameter file</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">scale</parametername>
</parameternamelist>
<parameterdescription>
<para>A scaling factor that the parameter is multiplied by before it is returned. </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_file_parser.F90" line="681" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_file_parser.F90" bodystart="682" bodyend="715"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>An overloaded interface to read various types of parameters. </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_file_parser.F90" line="90" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_file_parser.F90" bodystart="90" bodyend="93"/>
    <listofallmembers>
      <member refid="interfacemom__file__parser_1_1read__param_1aa4432bf14f3758eb45ec97e5202cd3fe" prot="private" virt="non-virtual"><scope>mom_file_parser::read_param</scope><name>read_param_char</name></member>
      <member refid="interfacemom__file__parser_1_1read__param_1aa8c50149ca73ac6771ca7c786d8b6a29" prot="private" virt="non-virtual"><scope>mom_file_parser::read_param</scope><name>read_param_char_array</name></member>
      <member refid="interfacemom__file__parser_1_1read__param_1a2ec3af5c2d4cf6e92e86e40a69066c0b" prot="private" virt="non-virtual"><scope>mom_file_parser::read_param</scope><name>read_param_int</name></member>
      <member refid="interfacemom__file__parser_1_1read__param_1abcb8b784ccf76a3dcb6748de0bf99c19" prot="private" virt="non-virtual"><scope>mom_file_parser::read_param</scope><name>read_param_int_array</name></member>
      <member refid="interfacemom__file__parser_1_1read__param_1ac597a6541686269074172edb615d9182" prot="private" virt="non-virtual"><scope>mom_file_parser::read_param</scope><name>read_param_logical</name></member>
      <member refid="interfacemom__file__parser_1_1read__param_1a1c0ef29e19c1415b1ebe9ccfe7b2fd1f" prot="private" virt="non-virtual"><scope>mom_file_parser::read_param</scope><name>read_param_real</name></member>
      <member refid="interfacemom__file__parser_1_1read__param_1a18df4cad513e32d9341704169dbe4cee" prot="private" virt="non-virtual"><scope>mom_file_parser::read_param</scope><name>read_param_real_array</name></member>
      <member refid="interfacemom__file__parser_1_1read__param_1abf7de1abb29512fb7496bd93df4f8f21" prot="private" virt="non-virtual"><scope>mom_file_parser::read_param</scope><name>read_param_time</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
