MOM output diagnostics - Revision history

S.wales at 04:16, 12 December 2019

2019-12-12T04:16:19Z

A.heerdegen: Reformatted from error ridden automatic translation

2019-11-28T03:58:06Z

Reformatted from error ridden automatic translation

Marshallward: Imported from Wikispaces

2012-07-19T07:17:39Z

Imported from Wikispaces

New page

MOM output is managed through the FMS diagnostics manager, and configured using the diag_table}} file. This page describes the format of {{diag_table records and how to manage output diagnostic in MOM.

= diag_table =

diag_table configuration files contain two types of records:

* Files: NetCDF output files containing MOM4 output
* Fields: Individual data fields (such as velocity or temperature) to be saved.

== Output file specification ==

diag_table files begin with output file records. An example output file is shown below:
<syntaxhighlight lang=fortran>
"ocean_snap", 5, "days", 1, "days", "Time"
</syntaxhighlight>
Each field is discussed below (in order of appearance)

* "ocean_snap"}}: The filename of a target netCDF output file. A {{.nc extension will be appended to the filename.
* 5, "days": The output frequency for variables in this file, followed by units. Standard calendar units can be used (days, hours, etc.).
* 1, "days": Output time axis unit of measurement (with units).
* "Time": Time axis variable name in the netCDF file.

Output frequency and other time-related information is associated with individual files. For this reason, variables with similar output rates should generally be grouped together in the same file.

== Field specification ==

Example field record:
<syntaxhighlight lang=fortran>
"ocean_model", "u", "u", "ocean_snap", "all", .false., "none", 2
</syntaxhighlight>
* "ocean_model"}}: MOM4 module containing the diagnostic variable. This is typically attributed to a particular submodel, such as {{"ocean_model"}} or {{"ice_model".
* "u", "u": The MOM4 registered variable name, and the output netCDF variable name, respectively. The first must match the variable name in the MOM4 source code, but the second can be renamed by the user.
* "ocean_snap"}}: The output file (defined in the {{diag_table file record) which will store this variable.
* "all"}}: The sampling rate of the variable. {{"all" means that the variable is sampled for every value on the time axis (as specified in the file record).
* .false.}}: Time averaging between output times. {{.true.}} saves the time-averaged values between time sampling rates, while {{.false. returns snapshots of the fields at each point on the time axis.
* "none"}}: Optional arguments, usually defined in MOM4. {{"none" denotes no optional arguments.
* 2: Output data type. Four formats are supported:
** 1: Double-precision (64-bit) floating point
** 2: Single-precision (32-bit) floating point
** 4: 16-bit integer packed variables (typically used for long-term archival)
** 8: 8-bit integer-packed variables (untested)

= Creating new variables =

To create new variables for output not included in the default version requires a modification of the MOM4 source code.

← Older revision		Revision as of 04:16, 12 December 2019
Line 1:		Line 1:
		+	[[Category: MOM]]

	MOM output is managed through the FMS diagnostics manager, and configured using the <tt>diag_table</tt> file. This page describes the format of <tt>diag_table</tt> records and how to manage output diagnostic in MOM.		MOM output is managed through the FMS diagnostics manager, and configured using the <tt>diag_table</tt> file. This page describes the format of <tt>diag_table</tt> records and how to manage output diagnostic in MOM.

@@ Line 1: / Line 1: @@
-MOM output is managed through the FMS diagnostics manager, and configured using the <span style="font-family:monospace">diag_table}} file. This page describes the format of {{diag_table</span> records and how to manage output diagnostic in MOM.
 = diag_table =
-<span style="font-family:monospace">diag_table</span> configuration files contain two types of records:
+<tt>diag_table</tt> configuration files contain two types of records:
-* Files: NetCDF output files containing MOM4 output
+*Files: NetCDF output files containing MOM4 output
-* Fields: Individual data fields (such as velocity or temperature) to be saved.
+*Fields: Individual data fields (such as velocity or temperature) to be saved.
 == Output file specification ==
-<span style="font-family:monospace">diag_table</span> files begin with output file records. An example output file is shown below:
+<tt>diag_table</tt> files begin with output file records. An example output file is shown below:
-<syntaxhighlight lang=fortran>
-"ocean_snap", 5, "days", 1, "days", "Time"
+<code>"ocean_snap", 5, "days", 1, "days", "Time"</code>
-</syntaxhighlight>
 Each field is discussed below (in order of appearance)
-* <span style="font-family:monospace">"ocean_snap"}}: The filename of a target netCDF output file. A {{.nc</span> extension will be appended to the filename.
+*"ocean_snap": The filename of a target netCDF output file. A <tt>.nc</tt> extension will be appended to the filename.
-* <span style="font-family:monospace">5, "days"</span>: The output frequency for variables in this file, followed by units. Standard calendar units can be used (days, hours, etc.).
+*5, "days": The output frequency for variables in this file, followed by units. Standard calendar units can be used (days, hours, etc.).
-* <span style="font-family:monospace">1, "days"</span>: Output time axis unit of measurement (with units).
+*1, "days": Output time axis unit of measurement (with units).
-* <span style="font-family:monospace">"Time"</span>: Time axis variable name in the netCDF file.
+*"Time": Time axis variable name in the netCDF file.
 Output frequency and other time-related information is associated with individual files. For this reason, variables with similar output rates should generally be grouped together in the same file.
@@ Line 26: / Line 27: @@
 Example field record:
-<syntaxhighlight lang=fortran>
-"ocean_model", "u", "u", "ocean_snap", "all", .false., "none", 2
+<code>"ocean_model", "u", "u", "ocean_snap", "all", .false., "none", 2</code>
-</syntaxhighlight>
-* <span style="font-family:monospace">"ocean_model"}}: MOM4 module containing the diagnostic variable. This is typically attributed to a particular submodel, such as {{"ocean_model"}} or {{"ice_model"</span>.
+*"ocean_model": MOM5 module containing the diagnostic variable. This is typically attributed to a particular submodel, such as "ocean model" or "ice_model".
-* <span style="font-family:monospace">"u", "u"</span>: The MOM4 registered variable name, and the output netCDF variable name, respectively. The first must match the variable name in the MOM4 source code, but the second can be renamed by the user.
+*"u", "u": The MOM5 registered variable name, and the output netCDF variable name, respectively. The first must match the variable name in the MOM5 source code, but the second can be renamed by the user.
-* <span style="font-family:monospace">"ocean_snap"}}: The output file (defined in the {{diag_table</span> file record) which will store this variable.
+*"ocean_snap": The output file (defined in the <tt>diag_table</tt> file record) which will store this variable.
-* <span style="font-family:monospace">"all"}}: The sampling rate of the variable. {{"all"</span> means that the variable is sampled for every value on the time axis (as specified in the file record).
+*"all": The sampling rate of the variable. "all" means that the variable is sampled for every value on the time axis (as specified in the file record).
-* <span style="font-family:monospace">.false.}}: Time averaging between output times. {{.true.}} saves the time-averaged values between time sampling rates, while {{.false.</span> returns snapshots of the fields at each point on the time axis.
+*.false.: Time averaging between output times. .true. saves the time-averaged values between time sampling rates, while .false. returns snapshots of the fields at each point on the time axis.
-* <span style="font-family:monospace">"none"}}: Optional arguments, usually defined in MOM4. {{"none"</span> denotes no optional arguments.
+*"none": Optional arguments, usually defined in MOM5. "none" denotes no optional arguments.
-* <span style="font-family:monospace">2</span>: Output data type. Four formats are supported:
+*2: Output data type.
-** <span style="font-family:monospace">1</span>: Double-precision (64-bit) floating point
-** <span style="font-family:monospace">2</span>: Single-precision (32-bit) floating point
+Four output data types are supported:
-** <span style="font-family:monospace">4</span>: 16-bit integer packed variables (typically used for long-term archival)
-** <span style="font-family:monospace">8</span>: 8-bit integer-packed variables (untested)
+*1: Double-precision (64-bit) floating point
 = Creating new variables =
 To create new variables for output not included in the default version requires a modification of the MOM4 source code.