mom_file_parser module reference

The MOM6 facility to parse input files for runtime parameters.

Data Types

`file_line_type`	A simple type to allow lines in an array to be allocated with variable sizes.
`file_data_type`	The valid lines extracted from an input parameter file without comments.
`link_parameter`	A link in the list of variables that have already had override warnings issued.
`parameter_block`	Specify the active parameter block.
`param_file_type`	A structure that can be parsed to read and document run-time parameters.

Functions/Subroutines

`open_param_file()`	Make the contents of a parameter input file available in a `param_file_type()`.
`close_param_file()`	Close any open input files and deallocate memory associated with this `param_file_type()`.
`populate_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.
`openmultilinecomment()`	Return True if a /* appears on this line without a closing */.
`closemultilinecomment()`	Return True if a */ appears on this line.
`lastnoncommentindex()`	Find position of last character before any comments, As marked by "!", "//", or "/*" following F90, C++, or C syntax.
`lastnoncommentnonblank()`	Find position of last non-blank character before any comments.
`replacetabs()`	Returns a string with tabs replaced by a blank.
`removecomments()`	Trims comments and leading blanks from string.
`simplifywhitespace()`	Constructs a string with all repeated white space replaced with single blanks and insert white space where it helps delineate tokens (e.g.
`read_param_int()`	This subroutine reads the value of an integer model parameter from a parameter file.
`read_param_int_array()`	This subroutine reads the values of an array of integer model parameters from a parameter file.
`read_param_real()`	This subroutine reads the value of a real model parameter from a parameter file.
`read_param_real_array()`	This subroutine reads the values of an array of real model parameters from a parameter file.
`read_param_char()`	This subroutine reads the value of a character string model parameter from a parameter file.
`read_param_char_array()`	This subroutine reads the values of an array of character string model parameters from a parameter file.
`read_param_logical()`	This subroutine reads the value of a logical model parameter from a parameter file.
`read_param_time()`	This subroutine reads the value of a time_type model parameter from a parameter file.
`strip_quotes()`	This function removes single and double quotes from a character string.
`max_input_line_length()`	This function returns the maximum number of characters in any input lines after they have been combined by any line continuation.
`get_variable_line()`	This subroutine extracts the contents of lines in the `param_file_type()` that refer to a named parameter.
`flag_line_as_read()`	Record that a line has been used to set a parameter.
`overridewarninghasbeenissued()`	Returns true if an override warning has been issued for the variable varName.
`log_version_cs()`	Log the version of a module to a log file and/or stdout, and/or to the parameter documentation file.
`log_version_plain()`	Log the version of a module to a log file and/or stdout.
`log_param_int()`	Log the name and value of an integer model parameter in documentation files.
`log_param_int_array()`	Log the name and values of an array of integer model parameter in documentation files.
`log_param_real()`	Log the name and value of a real model parameter in documentation files.
`log_param_real_array()`	Log the name and values of an array of real model parameter in documentation files.
`log_param_logical()`	Log the name and value of a logical model parameter in documentation files.
`log_param_char()`	Log the name and value of a character string model parameter in documentation files.
`log_param_time()`	This subroutine writes the value of a time-type parameter to a log file, along with its name and the module it came from.
`convert_date_to_string()`	This function converts a date into a string, valid with ticks and for dates up to year 99,999,999.
`get_param_int()`	This subroutine reads the value of an integer model parameter from a parameter file and logs it in documentation files.
`get_param_int_array()`	This subroutine reads the values of an array of integer model parameters from a parameter file and logs them in documentation files.
`get_param_real()`	This subroutine reads the value of a real model parameter from a parameter file and logs it in documentation files.
`get_param_real_array()`	This subroutine reads the values of an array of real model parameters from a parameter file and logs them in documentation files.
`get_param_char()`	This subroutine reads the value of a character string model parameter from a parameter file and logs it in documentation files.
`get_param_char_array()`	This subroutine reads the values of an array of character string model parameters from a parameter file and logs them in documentation files.
`get_param_logical()`	This subroutine reads the value of a logical model parameter from a parameter file and logs it in documentation files.
`get_param_time()`	This subroutine reads the value of a time-type model parameter from a parameter file and logs it in documentation files.
`archaic_param_name_message()`	Issue error messages or warnings about the use of an archaic parameter name.
`clearparameterblock()`	Resets the parameter block name to blank.
`openparameterblock()`	Tags blockName onto the end of the active parameter block name.
`closeparameterblock()`	Remove the lowest level of recursion from the active block name.
`pushblocklevel()`	Extends block name (deeper level of parameter block)
`popblocklevel()`	Truncates block name (shallower level of parameter block)

Detailed Description

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.

Type Documentation

type mom_file_parser/file_line_type

A simple type to allow lines in an array to be allocated with variable sizes.

Type fields:

% line :: character(len=:), allocatable, private An allocatable line with content.

mom_file_parser module reference

Data Types

Functions/Subroutines

Detailed Description

Type Documentation

Function/Subroutine Documentation