Detailed Description

A structure that controls where the documentation occurs, its veborsity and formatting.

Definition at line 28 of file MOM_document.F90.

Collaboration diagram for mom_document::doc_type:

Public variables and constants
integer	unitall = -1
	The open unit number for docFileBase + .all. More...

integer	unitshort = -1
	The open unit number for docFileBase + .short. More...

integer	unitlayout = -1
	The open unit number for docFileBase + .layout. More...

integer	unitdebugging = -1
	The open unit number for docFileBase + .debugging. More...

logical	filesareopen = .false.
	True if any files were successfully opened. More...

character(len=mlen)	docfilebase = ''
	The basename of the files where run-time parameters, settings and defaults are documented. More...

logical	complete = .true.
	If true, document all parameters. More...

logical	minimal = .true.
	If true, document non-default parameters. More...

logical	layout = .true.
	If true, document layout parameters. More...

logical	debugging = .true.
	If true, document debugging parameters. More...

logical	definesyntax = .false.
	If true, use '#def' syntax instead of a=b syntax. More...

logical	warnonconflicts = .false.
	Cause a WARNING error if defaults differ. More...

integer	commentcolumn = 32
	Number of spaces before the comment marker. More...

integer	max_line_len = 112
	The maximum length of message lines. More...

type(link_msg), pointer	chain_msg => NULL()
	Database of messages. More...

character(len=240)	blockprefix = ''
	The full name of the current block. More...

Variables and constants

◆ blockprefix

character(len=240) mom_document::doc_type::blockprefix = ''

The full name of the current block.

Definition at line 45 of file MOM_document.F90.

45 character(len=240) :: blockPrefix = '' !< The full name of the current block.

◆ chain_msg

type(link_msg), pointer mom_document::doc_type::chain_msg => NULL()

Database of messages.

Definition at line 44 of file MOM_document.F90.

44 type(link_msg), pointer :: chain_msg => null() !< Database of messages

◆ commentcolumn

integer mom_document::doc_type::commentcolumn = 32

Number of spaces before the comment marker.

Definition at line 42 of file MOM_document.F90.

42 integer :: commentColumn = 32 !< Number of spaces before the comment marker.

◆ complete

logical mom_document::doc_type::complete = .true.

If true, document all parameters.

Definition at line 36 of file MOM_document.F90.

36 logical :: complete = .true. !< If true, document all parameters.

◆ debugging

logical mom_document::doc_type::debugging = .true.

If true, document debugging parameters.

Definition at line 39 of file MOM_document.F90.

39 logical :: debugging = .true. !< If true, document debugging parameters.

◆ definesyntax

logical mom_document::doc_type::definesyntax = .false.

If true, use '#def' syntax instead of a=b syntax.

Definition at line 40 of file MOM_document.F90.

40 logical :: defineSyntax = .false. !< If true, use '\#def' syntax instead of a=b syntax

◆ docfilebase

character(len=mlen) mom_document::doc_type::docfilebase = ''

The basename of the files where run-time parameters, settings and defaults are documented.

Definition at line 34 of file MOM_document.F90.

34 character(len=mLen) :: docFileBase = '' !< The basename of the files where run-time

◆ filesareopen

logical mom_document::doc_type::filesareopen = .false.

True if any files were successfully opened.

Definition at line 33 of file MOM_document.F90.

33 logical :: filesAreOpen = .false. !< True if any files were successfully opened.

◆ layout

logical mom_document::doc_type::layout = .true.

If true, document layout parameters.

Definition at line 38 of file MOM_document.F90.

38 logical :: layout = .true. !< If true, document layout parameters.

◆ max_line_len

integer mom_document::doc_type::max_line_len = 112

The maximum length of message lines.

Definition at line 43 of file MOM_document.F90.

43 integer :: max_line_len = 112 !< The maximum length of message lines.

◆ minimal

logical mom_document::doc_type::minimal = .true.

If true, document non-default parameters.

Definition at line 37 of file MOM_document.F90.

37 logical :: minimal = .true. !< If true, document non-default parameters.

◆ unitall

integer mom_document::doc_type::unitall = -1

The open unit number for docFileBase + .all.

Definition at line 29 of file MOM_document.F90.

29 integer :: unitAll = -1 !< The open unit number for docFileBase + .all.

◆ unitdebugging

integer mom_document::doc_type::unitdebugging = -1

The open unit number for docFileBase + .debugging.

Definition at line 32 of file MOM_document.F90.

32 integer :: unitDebugging = -1 !< The open unit number for docFileBase + .debugging.

◆ unitlayout

integer mom_document::doc_type::unitlayout = -1

The open unit number for docFileBase + .layout.

Definition at line 31 of file MOM_document.F90.

31 integer :: unitLayout = -1 !< The open unit number for docFileBase + .layout.

◆ unitshort

integer mom_document::doc_type::unitshort = -1

The open unit number for docFileBase + .short.

Definition at line 30 of file MOM_document.F90.

30 integer :: unitShort = -1 !< The open unit number for docFileBase + .short.

◆ warnonconflicts

logical mom_document::doc_type::warnonconflicts = .false.

Cause a WARNING error if defaults differ.

Definition at line 41 of file MOM_document.F90.

41 logical :: warnOnConflicts = .false. !< Cause a WARNING error if defaults differ.

The documentation for this type was generated from the following file:

/glade/work/altuntas/cesm.sandboxes/cesm2_2_alpha_X_mom/components/mom/MOM6/src/framework/MOM_document.F90