Skip to content

Commit c47f359

Browse files
committed
clarify use of horiz_only
1 parent d61df01 commit c47f359

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/usage/history.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,13 +98,17 @@ During **init** time, fields can be added to the possible field list with a call
9898
|:---------------------|-----------|-----------|------------------------------------------------|
9999
| diagnostic_name | No | string | diagnostic name for the field - will be the name in netcdf output file |
100100
| description | No | string | Description of the variable |
101-
| vdim_name | No | string | vertical dimension: 'horiz_only' for no vertical dimension; 'lev' for vertical_layer_dimension; 'ilev' for vertical_interface_dimension |
101+
| vdim_name | No | string | vertical dimension: `horiz_only` for no vertical dimension (see note below this table); 'lev' for vertical_layer_dimension; 'ilev' for vertical_interface_dimension|
102102
| avgflag | No | string | default average flag; options: 'avg', 'lst' (instantaneous), 'min', 'max', 'var' (standard deviation) |
103103
| units | No | string | variable units |
104104
| gridname | Yes | string | gridname on which the variable's data is mapped (defaults to the physics grid) |
105105
| flag_xyfill | Yes | string | fill value for variable values |
106106
| mixing_ratio | Yes | string | constituent mixing ratio type ('wet' or 'dry'); not set to anything if not passed in |
107107

108+
!!!Note "horiz_only"
109+
`horiz_only` is a variable, not a string. If you have a variable with only a horizontal dimension, include this use statement in your module: `use cam_history_support, only: horiz_only`
110+
111+
108112
Example:
109113
```
110114
call history_add_field('Q', 'water vapor mixing ratio', 'lev', 'avg', 'kg kg-1', mixing_ratio='wet')

0 commit comments

Comments
 (0)