mom_file_parser mom_file_parser::file_data_type mom_file_parser::get_param mom_file_parser::link_parameter mom_file_parser::log_param mom_file_parser::log_version mom_file_parser::param_file_type mom_file_parser::parameter_block mom_file_parser::read_param logical, parameter logical, parameter mom_file_parser::report_unused_default report_unused_default = .true. Default values for parameters. close_param_file logical, parameter logical, parameter mom_file_parser::unused_params_fatal_default unused_params_fatal_default = .false. Default values for parameters. close_param_file logical, parameter logical, parameter mom_file_parser::log_to_stdout_default log_to_stdout_default = .false. Default values for parameters. close_param_file logical, parameter logical, parameter mom_file_parser::complete_doc_default complete_doc_default = .true. Default values for parameters. close_param_file open_param_file logical, parameter logical, parameter mom_file_parser::minimal_doc_default minimal_doc_default = .true. Default values for parameters. close_param_file open_param_file integer, parameter, public integer, parameter, public mom_file_parser::max_param_files max_param_files = 5 Maximum number of parameter files. integer, parameter integer, parameter mom_file_parser::input_str_length input_str_length = 320 Maximum line length in parameter file. get_variable_line populate_param_data integer, parameter integer, parameter mom_file_parser::filename_length filename_length = 200 Maximum number of characters in file names. logical logical mom_file_parser::all_pes_read all_pes_read = .false. If true, all PEs read the input files TODO: Eliminate this parameter. close_param_file open_param_file populate_param_data subroutine, public subroutine, public mom_file_parser::open_param_file (filename, CS, checkable, component, doc_file_dir) open_param_file filename filename CS CS checkable checkable component component doc_file_dir doc_file_dir Make the contents of a parameter input file availalble in a param_file_type. filename An input file name, optionally with the full path cs The control structure for the file_parser module, it is also a structure to parse for run-time parameters checkable If this is false, it disables checks of this file for unused parameters. The default is True. component If present, this component name is used to generate parameter documentation file names; the default is"MOM" doc_file_dir An optional directory in which to write out the documentation files. The default is effectively './'. all_pes_read complete_doc_default mom_error_handler::is_root_pe minimal_doc_default populate_param_data mom_get_input::get_mom_input subroutine, public subroutine, public mom_file_parser::close_param_file (CS, quiet_close, component) close_param_file CS CS quiet_close quiet_close component component Close any open input files and deallocate memory associated with this param_file_type. To use this type again, open_param_file would have to be called again. cs The control structure for the file_parser module, it is also a structure to parse for run-time parameters quiet_close if present and true, do not do any logging with this call. component If present, this component name is used to generate parameter documentation file names all_pes_read complete_doc_default mom_error_handler::is_root_pe log_to_stdout_default minimal_doc_default report_unused_default unused_params_fatal_default mom_tracer_flow_control::call_tracer_flux_init mom_main ocean_model_mod::ocean_model_init subroutine subroutine mom_file_parser::populate_param_data (iounit, filename, param_data) populate_param_data iounit iounit filename filename param_data param_data Read the contents of a parameter input file, and store the contents in a file_data_type after removing comments and simplifying white space. iounit The IO unit number that is open for filename filename An input file name, optionally with the full path param_data A list of the input lines that set parameters after comments have been stripped out. all_pes_read closemultilinecomment input_str_length mom_error_handler::is_root_pe lastnoncommentnonblank openmultilinecomment removecomments replacetabs simplifywhitespace open_param_file logical function logical function mom_file_parser::openmultilinecomment (string) openmultilinecomment string string Return True if a /* appears on this line without a closing */. string The input string to process lastnoncommentindex populate_param_data logical function logical function mom_file_parser::closemultilinecomment (string) closemultilinecomment string string Return True if a */ appears on this line. string The input string to process populate_param_data integer function integer function mom_file_parser::lastnoncommentindex (string) lastnoncommentindex string string Find position of last character before any comments, As marked by "!", "//", or "/*" following F90, C++, or C syntax. string The input string to process lastnoncommentnonblank openmultilinecomment integer function integer function mom_file_parser::lastnoncommentnonblank (string) lastnoncommentnonblank string string Find position of last non-blank character before any comments. string The input string to process lastnoncommentindex populate_param_data removecomments character(len=len(string)) function character(len=len(string)) function mom_file_parser::replacetabs (string) replacetabs string string Returns a string with tabs replaced by a blank. string The input string to process populate_param_data character(len=len(string)) function character(len=len(string)) function mom_file_parser::removecomments (string) removecomments string string Trims comments and leading blanks from string. string The input string to process lastnoncommentnonblank populate_param_data character(len=len(string)+16) function character(len=len(string)+16) function mom_file_parser::simplifywhitespace (string) simplifywhitespace string string Constructs a string with all repeated whitespace replaced with single blanks and insert white space where it helps delineate tokens (e.g. around =) string A string to modify to simpify white space mom_error_handler::is_root_pe populate_param_data subroutine subroutine mom_file_parser::read_param_int (CS, varname, value, fail_if_missing) read_param_int CS CS varname varname value value fail_if_missing fail_if_missing This subroutine reads the value of an integer model parameter from a parameter file. cs The control structure for the file_parser module, it is also a structure to parse for run-time parameters varname The case-sensitive name of the parameter to read value The value of the parameter that may be read from the parameter file fail_if_missing If present and true, a fatal error occurs if this variable is not found in the parameter file get_variable_line get_param_int subroutine subroutine mom_file_parser::read_param_int_array (CS, varname, value, fail_if_missing) read_param_int_array CS CS varname varname value value fail_if_missing fail_if_missing This subroutine reads the values of an array of integer model parameters from a parameter file. cs The control structure for the file_parser module, it is also a structure to parse for run-time parameters varname The case-sensitive name of the parameter to read value The value of the parameter that may be read from the parameter file fail_if_missing If present and true, a fatal error occurs if this variable is not found in the parameter file get_variable_line get_param_int_array subroutine subroutine mom_file_parser::read_param_real (CS, varname, value, fail_if_missing, scale) read_param_real CS CS varname varname value value fail_if_missing fail_if_missing scale scale This subroutine reads the value of a real model parameter from a parameter file. cs The control structure for the file_parser module, it is also a structure to parse for run-time parameters varname The case-sensitive name of the parameter to read value The value of the parameter that may be read from the parameter file fail_if_missing If present and true, a fatal error occurs if this variable is not found in the parameter file scale A scaling factor that the parameter is multiplied by before it is returned. get_variable_line get_param_real subroutine subroutine mom_file_parser::read_param_real_array (CS, varname, value, fail_if_missing, scale) read_param_real_array CS CS varname varname value value fail_if_missing fail_if_missing scale scale This subroutine reads the values of an array of real model parameters from a parameter file. cs The control structure for the file_parser module, it is also a structure to parse for run-time parameters varname The case-sensitive name of the parameter to read value The value of the parameter that may be read from the parameter file fail_if_missing If present and true, a fatal error occurs if this variable is not found in the parameter file scale A scaling factor that the parameter is multiplied by before it is returned. get_variable_line get_param_real_array subroutine subroutine mom_file_parser::read_param_char (CS, varname, value, fail_if_missing) read_param_char CS CS varname varname value value fail_if_missing fail_if_missing This subroutine reads the value of a character string model parameter from a parameter file. cs The control structure for the file_parser module, it is also a structure to parse for run-time parameters varname The case-sensitive name of the parameter to read value The value of the parameter that may be read from the parameter file fail_if_missing If present and true, a fatal error occurs if this variable is not found in the parameter file get_variable_line strip_quotes get_param_char subroutine subroutine mom_file_parser::read_param_char_array (CS, varname, value, fail_if_missing) read_param_char_array CS CS varname varname value value fail_if_missing fail_if_missing This subroutine reads the values of an array of character string model parameters from a parameter file. cs The control structure for the file_parser module, it is also a structure to parse for run-time parameters varname The case-sensitive name of the parameter to read value The value of the parameter that may be read from the parameter file fail_if_missing If present and true, a fatal error occurs if this variable is not found in the parameter file get_variable_line strip_quotes get_param_char_array subroutine subroutine mom_file_parser::read_param_logical (CS, varname, value, fail_if_missing) read_param_logical CS CS varname varname value value fail_if_missing fail_if_missing This subroutine reads the value of a logical model parameter from a parameter file. cs The control structure for the file_parser module, it is also a structure to parse for run-time parameters varname The case-sensitive name of the parameter to read value The value of the parameter that may be read from the parameter file fail_if_missing If present and true, a fatal error occurs if this variable is not found in the parameter file get_variable_line get_param_logical subroutine subroutine mom_file_parser::read_param_time (CS, varname, value, timeunit, fail_if_missing, date_format) read_param_time CS CS varname varname value value timeunit timeunit fail_if_missing fail_if_missing date_format date_format This subroutine reads the value of a time_type model parameter from a parameter file. cs The control structure for the file_parser module, it is also a structure to parse for run-time parameters varname The case-sensitive name of the parameter to read value The value of the parameter that may be read from the parameter file timeunit The number of seconds in a time unit for real-number input. fail_if_missing If present and true, a fatal error occurs if this variable is not found in the parameter file date_format If present, this indicates whether this parameter was read in a date format, so that it can later be logged in the same format. get_variable_line mom_time_manager::real_to_time get_param_time character(len=input_str_length) function character(len=input_str_length) function mom_file_parser::strip_quotes (val_str) strip_quotes val_str val_str This function removes single and double quotes from a character string. val_str The character string to work on read_param_char read_param_char_array subroutine subroutine mom_file_parser::get_variable_line (CS, varname, found, defined, value_string, paramIsLogical) get_variable_line CS CS varname varname found found defined defined value_string value_string paramIsLogical paramIsLogical This subtoutine extracts the contents of lines in the param_file_type that refer to a named parameter. The value_string that is returned must be interepreted in a way that depends on the type of this variable. cs The control structure for the file_parser module, it is also a structure to parse for run-time parameters varname The case-sensitive name of the parameter to read found If true, this parameter has been found in CS defined If true, this parameter is set (or true) in the CS value_string A string that encodes the new value paramislogical If true, this is a logical parameter that can be simply defined without parsing a value_string. flag_line_as_read input_str_length mom_error_handler::is_root_pe overridewarninghasbeenissued popblocklevel pushblocklevel read_param_char read_param_char_array read_param_int read_param_int_array read_param_logical read_param_real read_param_real_array read_param_time subroutine subroutine mom_file_parser::flag_line_as_read (line_used, count) flag_line_as_read line_used line_used count count Record that a line has been used to set a parameter. line_used A structure indicating which lines have been read count The parameter on this line number has been read get_variable_line logical function logical function mom_file_parser::overridewarninghasbeenissued (chain, varName) overridewarninghasbeenissued chain chain varName varName Returns true if an override warning has been issued for the variable varName. chain The linked list of variables that have already had override warnings issued varname The name of the variable being queried for warnings get_variable_line subroutine subroutine mom_file_parser::log_version_cs (CS, modulename, version, desc, log_to_all, all_default, layout, debugging) log_version_cs CS CS modulename modulename version version desc desc log_to_all log_to_all all_default all_default layout layout debugging debugging Log the version of a module to a log file and/or stdout, and/or to the parameter documentation file. cs File parser type modulename Name of calling module version Version string of module desc Module description log_to_all If present and true, log this parameter to the ..._doc.all files, even if this module also has layout or debugging parameters. all_default If true, all parameters take their default values. layout If present and true, this module has layout parameters. debugging If present and true, this module has debugging parameters. mom_error_handler::is_root_pe subroutine subroutine mom_file_parser::log_version_plain (modulename, version) log_version_plain modulename modulename version version Log the version of a module to a log file and/or stdout. modulename Name of calling module version Version string of module mom_error_handler::is_root_pe subroutine subroutine mom_file_parser::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. mom_error_handler::is_root_pe get_param_int subroutine subroutine mom_file_parser::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. mom_error_handler::is_root_pe get_param_int_array subroutine subroutine mom_file_parser::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. mom_error_handler::is_root_pe mom_string_functions::left_real get_param_real subroutine subroutine mom_file_parser::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. mom_error_handler::is_root_pe mom_string_functions::left_reals get_param_real_array subroutine subroutine mom_file_parser::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. mom_error_handler::is_root_pe get_param_logical subroutine subroutine mom_file_parser::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. mom_error_handler::is_root_pe get_param_char get_param_char_array subroutine subroutine mom_file_parser::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. convert_date_to_string mom_error_handler::is_root_pe get_param_time character(len=40) function character(len=40) function mom_file_parser::convert_date_to_string (date) convert_date_to_string date date This function converts a date into a string, valid with ticks and for dates up to year 99,999,999. date The date to be translated into a string. A date string in a format like YYYY-MM-DD HH:MM:SS.sss log_param_time subroutine subroutine mom_file_parser::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 log_param_int read_param_int subroutine subroutine mom_file_parser::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 log_param_int_array read_param_int_array subroutine subroutine mom_file_parser::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. log_param_real read_param_real subroutine subroutine mom_file_parser::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. log_param_real_array read_param_real_array subroutine subroutine mom_file_parser::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 log_param_char read_param_char subroutine subroutine mom_file_parser::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 log_param_char read_param_char_array subroutine subroutine mom_file_parser::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 log_param_logical read_param_logical subroutine subroutine mom_file_parser::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. log_param_time read_param_time subroutine, public subroutine, public mom_file_parser::clearparameterblock (CS) clearparameterblock CS CS Resets the parameter block name to blank. cs The control structure for the file_parser module, it is also a structure to parse for run-time parameters mom_error_handler::is_root_pe subroutine, public subroutine, public mom_file_parser::openparameterblock (CS, blockName, desc) openparameterblock CS CS blockName blockName desc desc Tags blockName onto the end of the active parameter block name. cs The control structure for the file_parser module, it is also a structure to parse for run-time parameters blockname The name of a parameter block being added desc A description of the parameter block being added mom_document::doc_openblock mom_error_handler::is_root_pe pushblocklevel baroclinic_zone_initialization::bcz_params mom_cvmix_kpp::kpp_init subroutine, public subroutine, public mom_file_parser::closeparameterblock (CS) closeparameterblock CS CS Remove the lowest level of recursion from the active block name. cs The control structure for the file_parser module, it is also a structure to parse for run-time parameters mom_document::doc_closeblock mom_error_handler::is_root_pe popblocklevel baroclinic_zone_initialization::bcz_params mom_cvmix_kpp::kpp_init character(len=len(oldblockname)+40) function character(len=len(oldblockname)+40) function mom_file_parser::pushblocklevel (oldblockName, newBlockName) pushblocklevel oldblockName oldblockName newBlockName newBlockName Extends block name (deeper level of parameter block) oldblockname A sequence of hierarchical parameter block names newblockname A new block name to add to the end of the sequence get_variable_line openparameterblock character(len=len(oldblockname)+40) function character(len=len(oldblockname)+40) function mom_file_parser::popblocklevel (oldblockName) popblocklevel oldblockName oldblockName Truncates block name (shallower level of parameter block) oldblockname A sequence of hierarchical parameter block names mom_error_handler::is_root_pe closeparameterblock get_variable_line The MOM6 facility to parse input files for runtime parameters. By Robert Hallberg and Alistair Adcroft, updated 9/2013.The subroutines here parse a set of input files for the value a named parameter and sets that parameter at run time. Currently these files use use one of several formats: #define VAR ! To set the logical VAR to true. VAR = True ! To set the logical VAR to true. #undef VAR ! To set the logical VAR to false. VAR = False ! To set the logical VAR to false. #define VAR 999 ! To set the real or integer VAR to 999. VAR = 999 ! To set the real or integer VAR to 999. #override VAR = 888 ! To override a previously set value. VAR = 1.1, 2.2, 3.3 ! To set an array of real values.