mom_file_parser::get_param subroutine subroutine mom_file_parser::get_param::get_param_int (CS, modulename, varname, value, desc, units, default, fail_if_missing, do_not_read, do_not_log, static_value, layoutParam, debuggingParam) get_param_int CS CS modulename modulename varname varname value value desc desc units units default default fail_if_missing fail_if_missing do_not_read do_not_read do_not_log do_not_log static_value static_value layoutParam layoutParam debuggingParam debuggingParam This subroutine reads the value of an integer model parameter from a parameter file and logs it in documentation files. cs The control structure for the file_parser module, it is also a structure to parse for run-time parameters modulename The name of the calling module varname The case-sensitive name of the parameter to read value The value of the parameter that may be read from the parameter file and logged desc A description of this variable; if not present, this parameter is not written to a doc file units The units of this parameter default The default value of the parameter static_value If this parameter is static, it takes this value, which can be compared for consistency with what is in the parameter file. fail_if_missing If present and true, a fatal error occurs if this variable is not found in the parameter file do_not_read If present and true, do not read a value for this parameter, although it might be logged. do_not_log If present and true, do not log this parameter to the documentation files layoutparam If present and true, this parameter is logged in the layout parameter file debuggingparam If present and true, this parameter is logged in the debugging parameter file subroutine subroutine mom_file_parser::get_param::get_param_real (CS, modulename, varname, value, desc, units, default, fail_if_missing, do_not_read, do_not_log, static_value, debuggingParam, scale, unscaled) get_param_real CS CS modulename modulename varname varname value value desc desc units units default default fail_if_missing fail_if_missing do_not_read do_not_read do_not_log do_not_log static_value static_value debuggingParam debuggingParam scale scale unscaled unscaled This subroutine reads the value of a real model parameter from a parameter file and logs it in documentation files. cs The control structure for the file_parser module, it is also a structure to parse for run-time parameters modulename The name of the calling module varname The case-sensitive name of the parameter to read value The value of the parameter that may be read from the parameter file and logged desc A description of this variable; if not present, this parameter is not written to a doc file units The units of this parameter default The default value of the parameter static_value If this parameter is static, it takes this value, which can be compared for consistency with what is in the parameter file. fail_if_missing If present and true, a fatal error occurs if this variable is not found in the parameter file do_not_read If present and true, do not read a value for this parameter, although it might be logged. do_not_log If present and true, do not log this parameter to the documentation files debuggingparam If present and true, this parameter is logged in the debugging parameter file scale A scaling factor that the parameter is multiplied by before it is returned. unscaled The value of the parameter that would be returned without any multiplication by a scaling factor. subroutine subroutine mom_file_parser::get_param::get_param_logical (CS, modulename, varname, value, desc, units, default, fail_if_missing, do_not_read, do_not_log, static_value, layoutParam, debuggingParam) get_param_logical CS CS modulename modulename varname varname value value desc desc units units default default fail_if_missing fail_if_missing do_not_read do_not_read do_not_log do_not_log static_value static_value layoutParam layoutParam debuggingParam debuggingParam This subroutine reads the value of a logical model parameter from a parameter file and logs it in documentation files. cs The control structure for the file_parser module, it is also a structure to parse for run-time parameters modulename The name of the calling module varname The case-sensitive name of the parameter to read value The value of the parameter that may be read from the parameter file and logged desc A description of this variable; if not present, this parameter is not written to a doc file units The units of this parameter default The default value of the parameter static_value If this parameter is static, it takes this value, which can be compared for consistency with what is in the parameter file. fail_if_missing If present and true, a fatal error occurs if this variable is not found in the parameter file do_not_read If present and true, do not read a value for this parameter, although it might be logged. do_not_log If present and true, do not log this parameter to the documentation files layoutparam If present and true, this parameter is logged in the layout parameter file debuggingparam If present and true, this parameter is logged in the debugging parameter file subroutine subroutine mom_file_parser::get_param::get_param_char (CS, modulename, varname, value, desc, units, default, fail_if_missing, do_not_read, do_not_log, static_value, layoutParam, debuggingParam) get_param_char CS CS modulename modulename varname varname value value desc desc units units default default fail_if_missing fail_if_missing do_not_read do_not_read do_not_log do_not_log static_value static_value layoutParam layoutParam debuggingParam debuggingParam This subroutine reads the value of a character string model parameter from a parameter file and logs it in documentation files. cs The control structure for the file_parser module, it is also a structure to parse for run-time parameters modulename The name of the calling module varname The case-sensitive name of the parameter to read value The value of the parameter that may be read from the parameter file and logged desc A description of this variable; if not present, this parameter is not written to a doc file units The units of this parameter default The default value of the parameter static_value If this parameter is static, it takes this value, which can be compared for consistency with what is in the parameter file. fail_if_missing If present and true, a fatal error occurs if this variable is not found in the parameter file do_not_read If present and true, do not read a value for this parameter, although it might be logged. do_not_log If present and true, do not log this parameter to the documentation files layoutparam If present and true, this parameter is logged in the layout parameter file debuggingparam If present and true, this parameter is logged in the debugging parameter file subroutine subroutine mom_file_parser::get_param::get_param_char_array (CS, modulename, varname, value, desc, units, default, fail_if_missing, do_not_read, do_not_log, static_value) get_param_char_array CS CS modulename modulename varname varname value value desc desc units units default default fail_if_missing fail_if_missing do_not_read do_not_read do_not_log do_not_log static_value static_value This subroutine reads the values of an array of character string model parameters from a parameter file and logs them in documentation files. cs The control structure for the file_parser module, it is also a structure to parse for run-time parameters modulename The name of the calling module varname The case-sensitive name of the parameter to read value The value of the parameter that may be read from the parameter file and logged desc A description of this variable; if not present, this parameter is not written to a doc file units The units of this parameter default The default value of the parameter static_value If this parameter is static, it takes this value, which can be compared for consistency with what is in the parameter file. fail_if_missing If present and true, a fatal error occurs if this variable is not found in the parameter file do_not_read If present and true, do not read a value for this parameter, although it might be logged. do_not_log If present and true, do not log this parameter to the documentation files subroutine subroutine mom_file_parser::get_param::get_param_time (CS, modulename, varname, value, desc, units, default, fail_if_missing, do_not_read, do_not_log, timeunit, static_value, layoutParam, debuggingParam, log_as_date) get_param_time CS CS modulename modulename varname varname value value desc desc units units default default fail_if_missing fail_if_missing do_not_read do_not_read do_not_log do_not_log timeunit timeunit static_value static_value layoutParam layoutParam debuggingParam debuggingParam log_as_date log_as_date This subroutine reads the value of a time-type model parameter from a parameter file and logs it in documentation files. cs The control structure for the file_parser module, it is also a structure to parse for run-time parameters modulename The name of the calling module varname The case-sensitive name of the parameter to read value The value of the parameter that may be read from the parameter file and logged desc A description of this variable; if not present, this parameter is not written to a doc file units The units of this parameter default The default value of the parameter static_value If this parameter is static, it takes this value, which can be compared for consistency with what is in the parameter file. fail_if_missing If present and true, a fatal error occurs if this variable is not found in the parameter file do_not_read If present and true, do not read a value for this parameter, although it might be logged. do_not_log If present and true, do not log this parameter to the documentation files timeunit The number of seconds in a time unit for real-number input to be translated to a time. layoutparam If present and true, this parameter is logged in the layout parameter file debuggingparam If present and true, this parameter is logged in the debugging parameter file log_as_date If true, log the time_type in date format. The default is false. subroutine subroutine mom_file_parser::get_param::get_param_int_array (CS, modulename, varname, value, desc, units, default, fail_if_missing, do_not_read, do_not_log, static_value, layoutParam, debuggingParam) get_param_int_array CS CS modulename modulename varname varname value value desc desc units units default default fail_if_missing fail_if_missing do_not_read do_not_read do_not_log do_not_log static_value static_value layoutParam layoutParam debuggingParam debuggingParam This subroutine reads the values of an array of integer model parameters from a parameter file and logs them in documentation files. cs The control structure for the file_parser module, it is also a structure to parse for run-time parameters modulename The name of the calling module varname The case-sensitive name of the parameter to read value The value of the parameter that may be reset from the parameter file desc A description of this variable; if not present, this parameter is not written to a doc file units The units of this parameter default The default value of the parameter static_value If this parameter is static, it takes this value, which can be compared for consistency with what is in the parameter file. fail_if_missing If present and true, a fatal error occurs if this variable is not found in the parameter file do_not_read If present and true, do not read a value for this parameter, although it might be logged. do_not_log If present and true, do not log this parameter to the documentation files layoutparam If present and true, this parameter is logged in the layout parameter file debuggingparam If present and true, this parameter is logged in the debugging parameter file subroutine subroutine mom_file_parser::get_param::get_param_real_array (CS, modulename, varname, value, desc, units, default, fail_if_missing, do_not_read, do_not_log, debuggingParam, static_value, scale, unscaled) get_param_real_array CS CS modulename modulename varname varname value value desc desc units units default default fail_if_missing fail_if_missing do_not_read do_not_read do_not_log do_not_log debuggingParam debuggingParam static_value static_value scale scale unscaled unscaled This subroutine reads the values of an array of real model parameters from a parameter file and logs them in documentation files. cs The control structure for the file_parser module, it is also a structure to parse for run-time parameters modulename The name of the calling module varname The case-sensitive name of the parameter to read value The value of the parameter that may be read from the parameter file and logged desc A description of this variable; if not present, this parameter is not written to a doc file units The units of this parameter default The default value of the parameter static_value If this parameter is static, it takes this value, which can be compared for consistency with what is in the parameter file. fail_if_missing If present and true, a fatal error occurs if this variable is not found in the parameter file do_not_read If present and true, do not read a value for this parameter, although it might be logged. do_not_log If present and true, do not log this parameter to the documentation files debuggingparam If present and true, this parameter is logged in the debugging parameter file scale A scaling factor that the parameter is multiplied by before it is returned. unscaled The value of the parameter that would be returned without any multiplication by a scaling factor. An overloaded interface to read and log the values of various types of parameters. mom_file_parser::get_paramget_param_char mom_file_parser::get_paramget_param_char_array mom_file_parser::get_paramget_param_int mom_file_parser::get_paramget_param_int_array mom_file_parser::get_paramget_param_logical mom_file_parser::get_paramget_param_real mom_file_parser::get_paramget_param_real_array mom_file_parser::get_paramget_param_time