MOM_document.F90 File Reference

Go to the source code of this file.

Data Types
interface	mom_document::doc_param
	Document parameter values. More...
type	mom_document::doc_type
	A structure that controls where the documentation occurs, its veborsity and formatting. More...
type	mom_document::link_msg
	A linked list of the parameter documentation messages that have been issued so far. More...

Modules
module	mom_document
	The subroutines here provide hooks for document generation functions at various levels of granularity.

Functions/Subroutines
subroutine	mom_document::doc_param_none (doc, varname, desc, units)
	This subroutine handles parameter documentation with no value. More...
subroutine	mom_document::doc_param_logical (doc, varname, desc, units, val, default, layoutParam, debuggingParam)
	This subroutine handles parameter documentation for logicals. More...
subroutine	mom_document::doc_param_logical_array (doc, varname, desc, units, vals, default, layoutParam, debuggingParam)
	This subroutine handles parameter documentation for arrays of logicals. More...
subroutine	mom_document::doc_param_int (doc, varname, desc, units, val, default, layoutParam, debuggingParam)
	This subroutine handles parameter documentation for integers. More...
subroutine	mom_document::doc_param_int_array (doc, varname, desc, units, vals, default, layoutParam, debuggingParam)
	This subroutine handles parameter documentation for arrays of integers. More...
subroutine	mom_document::doc_param_real (doc, varname, desc, units, val, default, debuggingParam)
	This subroutine handles parameter documentation for reals. More...
subroutine	mom_document::doc_param_real_array (doc, varname, desc, units, vals, default, debuggingParam)
	This subroutine handles parameter documentation for arrays of reals. More...
subroutine	mom_document::doc_param_char (doc, varname, desc, units, val, default, layoutParam, debuggingParam)
	This subroutine handles parameter documentation for character strings. More...
subroutine, public	mom_document::doc_openblock (doc, blockName, desc)
	This subroutine handles documentation for opening a parameter block. More...
subroutine, public	mom_document::doc_closeblock (doc, blockName)
	This subroutine handles documentation for closing a parameter block. More...
subroutine	mom_document::doc_param_time (doc, varname, desc, units, val, default, layoutParam, debuggingParam)
	This subroutine handles parameter documentation for time-type variables. More...
subroutine	mom_document::writemessageanddesc (doc, vmesg, desc, valueWasDefault, indent, layoutParam, debuggingParam)
	This subroutine writes out the message and description to the documetation files. More...
character(len=32) function	mom_document::real_string (val)
	This function returns a string with a real formatted like '(G)'. More...
character(len=1320) function	mom_document::real_array_string (vals, 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. More...
logical function	mom_document::testformattedfloatisreal (str, val)
	This function tests whether a real value is encoded in a string. More...
character(len=24) function	mom_document::int_string (val)
	This function returns a string with an integer formatted like '(I)'. More...
character(len=24) function	mom_document::logical_string (val)
	This function returns a string with an logical formatted like '(L)'. More...
character(len=mlen) function	mom_document::define_string (doc, varName, valString, units)
	This function returns a string for formatted parameter assignment. More...
character(len=mlen) function	mom_document::undef_string (doc, varName, units)
	This function returns a string for formatted false logicals. More...
subroutine, public	mom_document::doc_module (doc, modname, desc)
	This subroutine handles the module documentation. More...
subroutine, public	mom_document::doc_subroutine (doc, modname, subname, desc)
	This subroutine handles the subroutine documentation. More...
subroutine, public	mom_document::doc_function (doc, modname, fnname, desc)
	This subroutine handles the function documentation. More...
subroutine, public	mom_document::doc_init (docFileBase, doc, minimal, complete, layout, debugging)
	Initialize the parameter documentation. More...
subroutine	mom_document::open_doc_file (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. More...
integer function	mom_document::find_unused_unit_number ()
	Find an unused unit number, returning >0 if found, and triggering a FATAL error if not. More...
subroutine, public	mom_document::doc_end (doc)
	This subroutine closes the the files controlled by doc, and sets flags in doc to indicate that parameterization is no longer permitted. More...
logical function	mom_document::mesghasbeendocumented (doc, varName, mesg)
	Returns true if documentation has already been written. More...

Variables
integer, parameter	mom_document::mlen = 1240
	Length of interface/message strings. More...
character(len=4), parameter	mom_document::string_true = 'True'
	A string for true logicals. More...
character(len=5), parameter	mom_document::string_false = 'False'
	A string for false logicals. More...