MOM6
Private variables and constants | List of all members
mom_diag_mediator::diag_type Type Reference

Detailed Description

This type is used to represent a diagnostic at the diag_mediator level.

There can be both 'primary' and 'seconday' diagnostics. The primaries reside in the diag_csdiags array. They have an id which is an index into this array. The secondaries are 'variations' on the primary diagnostic. For example the CMOR diagnostics are secondary. The secondary diagnostics are kept in a list with the primary diagnostic as the head.

Definition at line 179 of file MOM_diag_mediator.F90.

Collaboration diagram for mom_diag_mediator::diag_type:
[legend]

Private variables and constants

logical in_use
 True if this entry is being used. More...
 
integer fms_diag_id
 Underlying FMS diag_manager id. More...
 
integer fms_xyave_diag_id = -1
 For a horizontally area-averaged diagnostic. More...
 
integer downsample_diag_id = -1
 For a horizontally area-downsampled diagnostic. More...
 
character(64) debug_str = ''
 For FATAL errors and debugging. More...
 
type(axes_grp), pointer axes => null()
 The axis group for this diagnostic. More...
 
type(diag_type), pointer next => null()
 Pointer to the next diagnostic. More...
 
real conversion_factor = 0.
 A factor to multiply data by before posting to FMS, if non-zero. More...
 
logical v_extensive = .false.
 True for vertically extensive fields (vertically integrated). False for intensive (concentrations). More...
 
integer xyz_method = 0
 A 3 digit integer encoding the diagnostics cell method It can be used to determine the downsample algorithm. More...
 

Variables and constants

◆ axes

type(axes_grp), pointer mom_diag_mediator::diag_type::axes => null()
private

The axis group for this diagnostic.

Definition at line 185 of file MOM_diag_mediator.F90.

185  type(axes_grp), pointer :: axes => null() !< The axis group for this diagnostic

◆ conversion_factor

real mom_diag_mediator::diag_type::conversion_factor = 0.
private

A factor to multiply data by before posting to FMS, if non-zero.

Definition at line 187 of file MOM_diag_mediator.F90.

187  real :: conversion_factor = 0. !< A factor to multiply data by before posting to FMS, if non-zero.

◆ debug_str

character(64) mom_diag_mediator::diag_type::debug_str = ''
private

For FATAL errors and debugging.

Definition at line 184 of file MOM_diag_mediator.F90.

184  character(64) :: debug_str = '' !< For FATAL errors and debugging.

◆ downsample_diag_id

integer mom_diag_mediator::diag_type::downsample_diag_id = -1
private

For a horizontally area-downsampled diagnostic.

Definition at line 183 of file MOM_diag_mediator.F90.

183  integer :: downsample_diag_id = -1 !< For a horizontally area-downsampled diagnostic.

◆ fms_diag_id

integer mom_diag_mediator::diag_type::fms_diag_id
private

Underlying FMS diag_manager id.

Definition at line 181 of file MOM_diag_mediator.F90.

181  integer :: fms_diag_id !< Underlying FMS diag_manager id.

◆ fms_xyave_diag_id

integer mom_diag_mediator::diag_type::fms_xyave_diag_id = -1
private

For a horizontally area-averaged diagnostic.

Definition at line 182 of file MOM_diag_mediator.F90.

182  integer :: fms_xyave_diag_id = -1 !< For a horizontally area-averaged diagnostic.

◆ in_use

logical mom_diag_mediator::diag_type::in_use
private

True if this entry is being used.

Definition at line 180 of file MOM_diag_mediator.F90.

180  logical :: in_use !< True if this entry is being used.

◆ next

type(diag_type), pointer mom_diag_mediator::diag_type::next => null()
private

Pointer to the next diagnostic.

Definition at line 186 of file MOM_diag_mediator.F90.

186  type(diag_type), pointer :: next => null() !< Pointer to the next diagnostic

◆ v_extensive

logical mom_diag_mediator::diag_type::v_extensive = .false.
private

True for vertically extensive fields (vertically integrated). False for intensive (concentrations).

Definition at line 188 of file MOM_diag_mediator.F90.

188  logical :: v_extensive = .false. !< True for vertically extensive fields (vertically integrated).

◆ xyz_method

integer mom_diag_mediator::diag_type::xyz_method = 0
private

A 3 digit integer encoding the diagnostics cell method It can be used to determine the downsample algorithm.

Definition at line 190 of file MOM_diag_mediator.F90.

190  integer :: xyz_method = 0 !< A 3 digit integer encoding the diagnostics cell method
The documentation for this type was generated from the following file: