mom_file_parser::log_param subroutine subroutine mom_file_parser::log_param::log_param_int (CS, modulename, varname, value, desc, units, default, layoutParam, debuggingParam, like_default) log_param_int CS CS modulename modulename varname varname value value desc desc units units default default layoutParam layoutParam debuggingParam debuggingParam like_default like_default Log the name and value of an integer model parameter 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 module using this parameter varname The name of the parameter to log value The value of the parameter to log 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 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 like_default If present and true, log this parameter as though it has the default value, even if there is no default. subroutine subroutine mom_file_parser::log_param::log_param_real (CS, modulename, varname, value, desc, units, default, debuggingParam, like_default) log_param_real CS CS modulename modulename varname varname value value desc desc units units default default debuggingParam debuggingParam like_default like_default Log the name and value of a real model parameter 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 name of the parameter to log value The value of the parameter to log 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 debuggingparam If present and true, this parameter is logged in the debugging parameter file like_default If present and true, log this parameter as though it has the default value, even if there is no default. subroutine subroutine mom_file_parser::log_param::log_param_logical (CS, modulename, varname, value, desc, units, default, layoutParam, debuggingParam, like_default) log_param_logical CS CS modulename modulename varname varname value value desc desc units units default default layoutParam layoutParam debuggingParam debuggingParam like_default like_default Log the name and value of a logical model parameter 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 name of the parameter to log value The value of the parameter to log 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 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 like_default If present and true, log this parameter as though it has the default value, even if there is no default. subroutine subroutine mom_file_parser::log_param::log_param_char (CS, modulename, varname, value, desc, units, default, layoutParam, debuggingParam, like_default) log_param_char CS CS modulename modulename varname varname value value desc desc units units default default layoutParam layoutParam debuggingParam debuggingParam like_default like_default Log the name and value of a character string model parameter 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 name of the parameter to log value The value of the parameter to log 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 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 like_default If present and true, log this parameter as though it has the default value, even if there is no default. subroutine subroutine mom_file_parser::log_param::log_param_time (CS, modulename, varname, value, desc, units, default, timeunit, layoutParam, debuggingParam, log_date, like_default) log_param_time CS CS modulename modulename varname varname value value desc desc units units default default timeunit timeunit layoutParam layoutParam debuggingParam debuggingParam log_date log_date like_default like_default This subroutine writes the value of a time-type parameter to a log file, along with its name and the module it came from. 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 name of the parameter to log value The value of the parameter to log 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 timeunit The number of seconds in a time unit for real-number output. log_date If true, log the time_type in date format. If missing the default is false. 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 like_default If present and true, log this parameter as though it has the default value, even if there is no default. subroutine subroutine mom_file_parser::log_param::log_param_int_array (CS, modulename, varname, value, desc, units, default, layoutParam, debuggingParam, like_default) log_param_int_array CS CS modulename modulename varname varname value value desc desc units units default default layoutParam layoutParam debuggingParam debuggingParam like_default like_default Log the name and values of an array of integer model parameter 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 module using this parameter varname The name of the parameter to log value The value of the parameter to log 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 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 like_default If present and true, log this parameter as though it has the default value, even if there is no default. subroutine subroutine mom_file_parser::log_param::log_param_real_array (CS, modulename, varname, value, desc, units, default, debuggingParam, like_default) log_param_real_array CS CS modulename modulename varname varname value value desc desc units units default default debuggingParam debuggingParam like_default like_default Log the name and values of an array of real model parameter 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 name of the parameter to log value The value of the parameter to log 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 debuggingparam If present and true, this parameter is logged in the debugging parameter file like_default If present and true, log this parameter as though it has the default value, even if there is no default. An overloaded interface to log the values of various types of parameters. mom_file_parser::log_paramlog_param_char mom_file_parser::log_paramlog_param_int mom_file_parser::log_paramlog_param_int_array mom_file_parser::log_paramlog_param_logical mom_file_parser::log_paramlog_param_real mom_file_parser::log_paramlog_param_real_array mom_file_parser::log_paramlog_param_time