mom_document mom_document::doc_param mom_document::doc_type mom_document::link_msg integer, parameter integer, parameter mom_document::mlen mlen = 1240 Length of interface/message strings. define_string character(len=4), parameter character(len=4), parameter mom_document::string_true string_true = 'True' A string for true logicals. doc_param_logical doc_param_logical_array character(len=5), parameter character(len=5), parameter mom_document::string_false string_false = 'False' A string for false logicals. doc_param_logical doc_param_logical_array undef_string subroutine subroutine mom_document::doc_param_none (doc, varname, desc, units) doc_param_none doc doc varname varname desc desc units units This subroutine handles parameter documentation with no value. doc A pointer to a structure that controls where the documentation occurs and its formatting varname The name of the parameter being documented desc A description of the parameter being documented units The units of the parameter being documented mom_error_handler::is_root_pe mesghasbeendocumented open_doc_file writemessageanddesc subroutine subroutine mom_document::doc_param_logical (doc, varname, desc, units, val, default, layoutParam, debuggingParam, like_default) doc_param_logical doc doc varname varname desc desc units units val val default default layoutParam layoutParam debuggingParam debuggingParam like_default like_default This subroutine handles parameter documentation for logicals. doc A pointer to a structure that controls where the documentation occurs and its formatting varname The name of the parameter being documented desc A description of the parameter being documented units The units of the parameter being documented val The value of this parameter default The default value of this parameter layoutparam If present and true, this is a layout parameter. debuggingparam If present and true, this is a debugging parameter. like_default If present and true, log this parameter as though it has the default value, even if there is no default. define_string mom_error_handler::is_root_pe mesghasbeendocumented open_doc_file string_false string_true undef_string writemessageanddesc subroutine subroutine mom_document::doc_param_logical_array (doc, varname, desc, units, vals, default, layoutParam, debuggingParam, like_default) doc_param_logical_array doc doc varname varname desc desc units units vals vals default default layoutParam layoutParam debuggingParam debuggingParam like_default like_default This subroutine handles parameter documentation for arrays of logicals. doc A pointer to a structure that controls where the documentation occurs and its formatting varname The name of the parameter being documented desc A description of the parameter being documented units The units of the parameter being documented vals The array of values to record default The default value of this parameter layoutparam If present and true, this is a layout parameter. debuggingparam If present and true, this is a debugging parameter. like_default If present and true, log this parameter as though it has the default value, even if there is no default. define_string mom_error_handler::is_root_pe mesghasbeendocumented open_doc_file string_false string_true writemessageanddesc subroutine subroutine mom_document::doc_param_int (doc, varname, desc, units, val, default, layoutParam, debuggingParam, like_default) doc_param_int doc doc varname varname desc desc units units val val default default layoutParam layoutParam debuggingParam debuggingParam like_default like_default This subroutine handles parameter documentation for integers. doc A pointer to a structure that controls where the documentation occurs and its formatting varname The name of the parameter being documented desc A description of the parameter being documented units The units of the parameter being documented val The value of this parameter default The default value of this parameter layoutparam If present and true, this is a layout parameter. debuggingparam If present and true, this is a debugging parameter. like_default If present and true, log this parameter as though it has the default value, even if there is no default. define_string int_string mom_error_handler::is_root_pe mesghasbeendocumented open_doc_file writemessageanddesc subroutine subroutine mom_document::doc_param_int_array (doc, varname, desc, units, vals, default, layoutParam, debuggingParam, like_default) doc_param_int_array doc doc varname varname desc desc units units vals vals default default layoutParam layoutParam debuggingParam debuggingParam like_default like_default This subroutine handles parameter documentation for arrays of integers. doc A pointer to a structure that controls where the documentation occurs and its formatting varname The name of the parameter being documented desc A description of the parameter being documented units The units of the parameter being documented vals The array of values to record default The default value of this parameter layoutparam If present and true, this is a layout parameter. debuggingparam If present and true, this is a debugging parameter. like_default If present and true, log this parameter as though it has the default value, even if there is no default. define_string int_string mom_error_handler::is_root_pe mesghasbeendocumented open_doc_file writemessageanddesc subroutine subroutine mom_document::doc_param_real (doc, varname, desc, units, val, default, debuggingParam, like_default) doc_param_real doc doc varname varname desc desc units units val val default default debuggingParam debuggingParam like_default like_default This subroutine handles parameter documentation for reals. doc A pointer to a structure that controls where the documentation occurs and its formatting varname The name of the parameter being documented desc A description of the parameter being documented units The units of the parameter being documented val The value of this parameter default The default value of this parameter debuggingparam If present and true, this is a debugging parameter. like_default If present and true, log this parameter as though it has the default value, even if there is no default. define_string mom_error_handler::is_root_pe mesghasbeendocumented open_doc_file real_string writemessageanddesc subroutine subroutine mom_document::doc_param_real_array (doc, varname, desc, units, vals, default, debuggingParam, like_default) doc_param_real_array doc doc varname varname desc desc units units vals vals default default debuggingParam debuggingParam like_default like_default This subroutine handles parameter documentation for arrays of reals. doc A pointer to a structure that controls where the documentation occurs and its formatting varname The name of the parameter being documented desc A description of the parameter being documented units The units of the parameter being documented vals The array of values to record default The default value of this parameter debuggingparam If present and true, this is a debugging parameter. like_default If present and true, log this parameter as though it has the default value, even if there is no default. define_string mom_error_handler::is_root_pe mesghasbeendocumented open_doc_file real_array_string real_string writemessageanddesc subroutine subroutine mom_document::doc_param_char (doc, varname, desc, units, val, default, layoutParam, debuggingParam, like_default) doc_param_char doc doc varname varname desc desc units units val val default default layoutParam layoutParam debuggingParam debuggingParam like_default like_default This subroutine handles parameter documentation for character strings. doc A pointer to a structure that controls where the documentation occurs and its formatting varname The name of the parameter being documented desc A description of the parameter being documented units The units of the parameter being documented val The value of the parameter default The default value of this parameter layoutparam If present and true, this is a layout parameter. debuggingparam If present and true, this is a debugging parameter. like_default If present and true, log this parameter as though it has the default value, even if there is no default. define_string mom_error_handler::is_root_pe mesghasbeendocumented open_doc_file writemessageanddesc subroutine, public subroutine, public mom_document::doc_openblock (doc, blockName, desc) doc_openblock doc doc blockName blockName desc desc This subroutine handles documentation for opening a parameter block. doc A pointer to a structure that controls where the documentation occurs and its formatting blockname The name of the parameter block being opened desc A description of the parameter block being opened mom_error_handler::is_root_pe open_doc_file writemessageanddesc mom_file_parser::openparameterblock subroutine, public subroutine, public mom_document::doc_closeblock (doc, blockName) doc_closeblock doc doc blockName blockName This subroutine handles documentation for closing a parameter block. doc A pointer to a structure that controls where the documentation occurs and its formatting blockname The name of the parameter block being closed mom_error_handler::is_root_pe open_doc_file writemessageanddesc mom_file_parser::closeparameterblock subroutine subroutine mom_document::doc_param_time (doc, varname, desc, val, default, units, debuggingParam, like_default) doc_param_time doc doc varname varname desc desc val val default default units units debuggingParam debuggingParam like_default like_default This subroutine handles parameter documentation for time-type variables. doc A pointer to a structure that controls where the documentation occurs and its formatting varname The name of the parameter being documented desc A description of the parameter being documented val The value of the parameter default The default value of this parameter units The units of the parameter being documented debuggingparam If present and true, this is a debugging parameter. like_default If present and true, log this parameter as though it has the default value, even if there is no default. define_string mom_error_handler::is_root_pe mesghasbeendocumented open_doc_file time_string writemessageanddesc subroutine subroutine mom_document::writemessageanddesc (doc, vmesg, desc, valueWasDefault, indent, layoutParam, debuggingParam) writemessageanddesc doc doc vmesg vmesg desc desc valueWasDefault valueWasDefault indent indent layoutParam layoutParam debuggingParam debuggingParam This subroutine writes out the message and description to the documetation files. doc A pointer to a structure that controls where the documentation occurs and its formatting vmesg A message with the parameter name, units, and default value. desc A description of the parameter being documented valuewasdefault If true, this parameter has its default value indent An amount by which to indent this message layoutparam If present and true, this is a layout parameter. debuggingparam If present and true, this is a debugging parameter. doc_closeblock doc_module doc_openblock doc_param_char doc_param_int doc_param_int_array doc_param_logical doc_param_logical_array doc_param_none doc_param_real doc_param_real_array doc_param_time character(len=40) function character(len=40) function mom_document::time_string (time) time_string time time This function returns a string with a time type formatted as seconds (perhaps including a fractional number of seconds) and days. time The time type being translated int_string doc_param_time character(len=32) function character(len=32) function mom_document::real_string (val) real_string val val This function returns a string with a real formatted like '(G)'. val The value being written into a string testformattedfloatisreal doc_param_real doc_param_real_array real_array_string character(len=1320) function character(len=1320) function mom_document::real_array_string (vals, sep) real_array_string vals vals sep sep Returns a character string of a comma-separated, compact formatted, reals e.g. "1., 2., 5*3., 5.E2", that give the list of values. The output string listing vals vals The array of values to record sep The separator between successive values, int_string real_string doc_param_real_array logical function logical function mom_document::testformattedfloatisreal (str, val) testformattedfloatisreal str str val val This function tests whether a real value is encoded in a string. str The string that match val val The value being tested real_string character(len=24) function character(len=24) function mom_document::int_string (val) int_string val val This function returns a string with an integer formatted like '(I)'. val The value being written into a string doc_param_int doc_param_int_array real_array_string time_string character(len=24) function character(len=24) function mom_document::logical_string (val) logical_string val val This function returns a string with an logical formatted like '(L)'. val The value being written into a string character(len=mlen) function character(len=mlen) function mom_document::define_string (doc, varName, valString, units) define_string doc doc varName varName valString valString units units This function returns a string for formatted parameter assignment. doc A pointer to a structure that controls where the documentation occurs and its formatting varname The name of the parameter being documented valstring A string containing the value of the parameter units The units of the parameter being documented mlen doc_param_char doc_param_int doc_param_int_array doc_param_logical doc_param_logical_array doc_param_real doc_param_real_array doc_param_time character(len=mlen) function character(len=mlen) function mom_document::undef_string (doc, varName, units) undef_string doc doc varName varName units units This function returns a string for formatted false logicals. doc A pointer to a structure that controls where the documentation occurs and its formatting varname The name of the parameter being documented units The units of the parameter being documented string_false doc_param_logical subroutine, public subroutine, public mom_document::doc_module (doc, modname, desc, log_to_all, all_default, layoutMod, debuggingMod) doc_module doc doc modname modname desc desc log_to_all log_to_all all_default all_default layoutMod layoutMod debuggingMod debuggingMod This subroutine handles the module documentation. doc A pointer to a structure that controls where the documentation occurs and its formatting modname The name of the module being documented desc A description of the module being documented 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. layoutmod If present and true, this module has layout parameters. debuggingmod If present and true, this module has debugging parameters. open_doc_file writemessageanddesc subroutine, public subroutine, public mom_document::doc_subroutine (doc, modname, subname, desc) doc_subroutine doc doc modname modname subname subname desc desc This subroutine handles the subroutine documentation. doc A pointer to a structure that controls where the documentation occurs and its formatting modname The name of the module being documented subname The name of the subroutine being documented desc A description of the subroutine being documented open_doc_file subroutine, public subroutine, public mom_document::doc_function (doc, modname, fnname, desc) doc_function doc doc modname modname fnname fnname desc desc This subroutine handles the function documentation. doc A pointer to a structure that controls where the documentation occurs and its formatting modname The name of the module being documented fnname The name of the function being documented desc A description of the function being documented open_doc_file subroutine, public subroutine, public mom_document::doc_init (docFileBase, doc, minimal, complete, layout, debugging) doc_init docFileBase docFileBase doc doc minimal minimal complete complete layout layout debugging debugging Initialize the parameter documentation. docfilebase The base file name for this set of parameters, for example MOM_parameter_doc doc A pointer to a structure that controls where the documentation occurs and its formatting minimal If present and true, write out the files (.short) documenting those parameters that do not take on their default values. complete If present and true, write out the (.all) files documenting all parameters layout If present and true, write out the (.layout) files documenting the layout parameters debugging If present and true, write out the (.debugging) files documenting the debugging parameters subroutine subroutine mom_document::open_doc_file (doc) open_doc_file doc doc This subroutine allocates and populates a structure that controls where the documentation occurs and its formatting, and opens up the files controlled by this structure. doc A pointer to a structure that controls where the documentation occurs and its formatting find_unused_unit_number doc_closeblock doc_function doc_module doc_openblock doc_param_char doc_param_int doc_param_int_array doc_param_logical doc_param_logical_array doc_param_none doc_param_real doc_param_real_array doc_param_time doc_subroutine integer function integer function mom_document::find_unused_unit_number () find_unused_unit_number Find an unused unit number, returning >0 if found, and triggering a FATAL error if not. open_doc_file subroutine, public subroutine, public mom_document::doc_end (doc) doc_end doc doc This subroutine closes the the files controlled by doc, and sets flags in doc to indicate that parameterization is no longer permitted. doc A pointer to a structure that controls where the documentation occurs and its formatting logical function logical function mom_document::mesghasbeendocumented (doc, varName, mesg) mesghasbeendocumented doc doc varName varName mesg mesg Returns true if documentation has already been written. doc A pointer to a structure that controls where the documentation occurs and its formatting varname The name of the parameter being documented mesg A message with parameter values, defaults, and descriptions to compare with the message that was written previously doc_param_char doc_param_int doc_param_int_array doc_param_logical doc_param_logical_array doc_param_none doc_param_real doc_param_real_array doc_param_time The subroutines here provide hooks for document generation functions at various levels of granularity.