MOM_file_parser.F90 File Reference

Go to the source code of this file.

Data Types
type	mom_file_parser::file_data_type
	The valid lines extracted from an input parameter file without comments. More...
type	mom_file_parser::link_parameter
	A link in the list of variables that have already had override warnings issued. More...
type	mom_file_parser::parameter_block
	Specify the active parameter block. More...
type	mom_file_parser::param_file_type
	A structure that can be parsed to read and document run-time parameters. More...
interface	mom_file_parser::read_param
	An overloaded interface to read various types of parameters. More...
interface	mom_file_parser::log_param
	An overloaded interface to log the values of various types of parameters. More...
interface	mom_file_parser::get_param
	An overloaded interface to read and log the values of various types of parameters. More...
interface	mom_file_parser::log_version
	An overloaded interface to log version information about modules. More...

Modules
module	mom_file_parser
	The MOM6 facility to parse input files for runtime parameters.

Variables
integer, parameter, public	mom_file_parser::max_param_files = 5
	Maximum number of parameter files. More...
integer, parameter	mom_file_parser::input_str_length = 320
	Maximum line length in parameter file. More...
integer, parameter	mom_file_parser::filename_length = 200
	Maximum number of characters in file names. More...
logical	mom_file_parser::all_pes_read = .false.
	If true, all PEs read the input files TODO: Eliminate this parameter. More...
logical, parameter	mom_file_parser::report_unused_default = .false.
	Default values for parameters. More...
logical, parameter	mom_file_parser::unused_params_fatal_default = .false.
	Default values for parameters. More...
logical, parameter	mom_file_parser::log_to_stdout_default = .false.
	Default values for parameters. More...
logical, parameter	mom_file_parser::complete_doc_default = .true.
	Default values for parameters. More...
logical, parameter	mom_file_parser::minimal_doc_default = .true.
	Default values for parameters. More...
subroutine, public	mom_file_parser::open_param_file (filename, CS, checkable, component, doc_file_dir)
	Make the contents of a parameter input file availalble in a param_file_type. More...
subroutine, public	mom_file_parser::close_param_file (CS, quiet_close, 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. More...
subroutine	mom_file_parser::populate_param_data (iounit, filename, 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. More...
logical function	mom_file_parser::openmultilinecomment (string)
	Return True if a /* appears on this line without a closing */. More...
logical function	mom_file_parser::closemultilinecomment (string)
	Return True if a */ appears on this line. More...
integer function	mom_file_parser::lastnoncommentindex (string)
	Find position of last character before any comments, As marked by "!", "//", or "/*" following F90, C++, or C syntax. More...
integer function	mom_file_parser::lastnoncommentnonblank (string)
	Find position of last non-blank character before any comments. More...
character(len=len(string)) function	mom_file_parser::replacetabs (string)
	Returns a string with tabs replaced by a blank. More...
character(len=len(string)) function	mom_file_parser::removecomments (string)
	Trims comments and leading blanks from string. More...
character(len=len(string)+16) function	mom_file_parser::simplifywhitespace (string)
	Constructs a string with all repeated whitespace replaced with single blanks and insert white space where it helps delineate tokens (e.g. around =) More...
subroutine	mom_file_parser::read_param_int (CS, varname, value, fail_if_missing)
	This subroutine reads the value of an integer model parameter from a parameter file. More...
subroutine	mom_file_parser::read_param_int_array (CS, varname, value, fail_if_missing)
	This subroutine reads the values of an array of integer model parameters from a parameter file. More...
subroutine	mom_file_parser::read_param_real (CS, varname, value, fail_if_missing, scale)
	This subroutine reads the value of a real model parameter from a parameter file. More...
subroutine	mom_file_parser::read_param_real_array (CS, varname, value, fail_if_missing, scale)
	This subroutine reads the values of an array of real model parameters from a parameter file. More...
subroutine	mom_file_parser::read_param_char (CS, varname, value, fail_if_missing)
	This subroutine reads the value of a character string model parameter from a parameter file. More...
subroutine	mom_file_parser::read_param_char_array (CS, varname, value, fail_if_missing)
	This subroutine reads the values of an array of character string model parameters from a parameter file. More...
subroutine	mom_file_parser::read_param_logical (CS, varname, value, fail_if_missing)
	This subroutine reads the value of a logical model parameter from a parameter file. More...
subroutine	mom_file_parser::read_param_time (CS, varname, value, timeunit, fail_if_missing, date_format)
	This subroutine reads the value of a time_type model parameter from a parameter file. More...
character(len=input_str_length) function	mom_file_parser::strip_quotes (val_str)
	This function removes single and double quotes from a character string. More...
subroutine	mom_file_parser::get_variable_line (CS, varname, found, defined, value_string, 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. More...
subroutine	mom_file_parser::flag_line_as_read (line_used, count)
	Record that a line has been used to set a parameter. More...
logical function	mom_file_parser::overridewarninghasbeenissued (chain, varName)
	Returns true if an override warning has been issued for the variable varName. More...
subroutine	mom_file_parser::log_version_cs (CS, modulename, version, desc)
	Log the version of a module to a log file and/or stdout, and/or to the parameter documentation file. More...
subroutine	mom_file_parser::log_version_plain (modulename, version)
	Log the version of a module to a log file and/or stdout. More...
subroutine	mom_file_parser::log_param_int (CS, modulename, varname, value, desc, units, default, layoutParam, debuggingParam)
	Log the name and value of an integer model parameter in documentation files. More...
subroutine	mom_file_parser::log_param_int_array (CS, modulename, varname, value, desc, units, default, layoutParam, debuggingParam)
	Log the name and values of an array of integer model parameter in documentation files. More...
subroutine	mom_file_parser::log_param_real (CS, modulename, varname, value, desc, units, default, debuggingParam)
	Log the name and value of a real model parameter in documentation files. More...
subroutine	mom_file_parser::log_param_real_array (CS, modulename, varname, value, desc, units, default, debuggingParam)
	Log the name and values of an array of real model parameter in documentation files. More...
subroutine	mom_file_parser::log_param_logical (CS, modulename, varname, value, desc, units, default, layoutParam, debuggingParam)
	Log the name and value of a logical model parameter in documentation files. More...
subroutine	mom_file_parser::log_param_char (CS, modulename, varname, value, desc, units, default, layoutParam, debuggingParam)
	Log the name and value of a character string model parameter in documentation files. More...
subroutine	mom_file_parser::log_param_time (CS, modulename, varname, value, desc, units, default, timeunit, layoutParam, debuggingParam, log_date)
	This subroutine writes the value of a time-type parameter to a log file, along with its name and the module it came from. More...
character(len=40) function	mom_file_parser::convert_date_to_string (date)
	This function converts a date into a string, valid with ticks and for dates up to year 99,999,999. More...
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)
	This subroutine reads the value of an integer model parameter from a parameter file and logs it in documentation files. More...
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)
	This subroutine reads the values of an array of integer model parameters from a parameter file and logs them in documentation files. More...
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)
	This subroutine reads the value of a real model parameter from a parameter file and logs it in documentation files. More...
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)
	This subroutine reads the values of an array of real model parameters from a parameter file and logs them in documentation files. More...
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)
	This subroutine reads the value of a character string model parameter from a parameter file and logs it in documentation files. More...
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)
	This subroutine reads the values of an array of character string model parameters from a parameter file and logs them in documentation files. More...
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)
	This subroutine reads the value of a logical model parameter from a parameter file and logs it in documentation files. More...
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)
	This subroutine reads the value of a time-type model parameter from a parameter file and logs it in documentation files. More...
subroutine, public	mom_file_parser::clearparameterblock (CS)
	Resets the parameter block name to blank. More...
subroutine, public	mom_file_parser::openparameterblock (CS, blockName, desc)
	Tags blockName onto the end of the active parameter block name. More...
subroutine, public	mom_file_parser::closeparameterblock (CS)
	Remove the lowest level of recursion from the active block name. More...
character(len=len(oldblockname)+40) function	mom_file_parser::pushblocklevel (oldblockName, newBlockName)
	Extends block name (deeper level of parameter block) More...
character(len=len(oldblockname)+40) function	mom_file_parser::popblocklevel (oldblockName)
	Truncates block name (shallower level of parameter block) More...