MOM6
mom_diag_mediator::axes_grp Type Reference

Detailed Description

A group of 1D axes that comprise a 1D/2D/3D mesh.

Definition at line 96 of file MOM_diag_mediator.F90.

Collaboration diagram for mom_diag_mediator::axes_grp:
[legend]

Public variables and constants

character(len=15) id
 The id string for this particular combination of handles. More...
 
integer rank
 Number of dimensions in the list of axes. More...
 
integer, dimension(:), allocatable handles
 Handles to 1D axes. More...
 
type(diag_ctrl), pointer diag_cs => null()
 Circular link back to the main diagnostics control structure (Used to avoid passing said structure into every possible call). More...
 
character(len=9) x_cell_method = ''
 Default nature of data representation, if axes group includes x-direction. More...
 
character(len=9) y_cell_method = ''
 Default nature of data representation, if axes group includes y-direction. More...
 
character(len=9) v_cell_method = ''
 Default nature of data representation, if axes group includes vertical direction. More...
 
integer nz = 0
 Vertical dimension of diagnostic. More...
 
integer vertical_coordinate_number = 0
 Index of the corresponding diag_remap_ctrl for this axis group. More...
 
logical is_h_point = .false.
 If true, indicates that this axes group is for an h-point located field. More...
 
logical is_q_point = .false.
 If true, indicates that this axes group is for a q-point located field. More...
 
logical is_u_point = .false.
 If true, indicates that this axes group is for a u-point located field. More...
 
logical is_v_point = .false.
 If true, indicates that this axes group is for a v-point located field. More...
 
logical is_layer = .false.
 If true, indicates that this axes group is for a layer vertically-located field. More...
 
logical is_interface = .false.
 If true, indicates that this axes group is for an interface vertically-located field. More...
 
logical is_native = .true.
 If true, indicates that this axes group is for a native model grid. False for any other grid. Used for rank>2. More...
 
logical needs_remapping = .false.
 If true, indicates that this axes group is for a intensive layer-located field that must be remapped to these axes. Used for rank>2. More...
 
logical needs_interpolating = .false.
 If true, indicates that this axes group is for a sampled interface-located field that must be interpolated to these axes. Used for rank>2. More...
 
integer downsample_level = 1
 If greater than 1, the factor by which this diagnostic/axes/masks be downsampled. More...
 
type(axes_grp), pointer xyave_axes => null()
 The associated 1d axes for horizontall area-averaged diagnostics. More...
 
integer id_area = -1
 The diag_manager id for area to be used for cell_measure of variables with this axes_grp. More...
 
integer id_volume = -1
 The diag_manager id for volume to be used for cell_measure of variables with this axes_grp. More...
 
real, dimension(:,:), pointer mask2d => null()
 Mask for 2d (x-y) axes. More...
 
real, dimension(:,:,:), pointer mask3d => null()
 Mask for 3d axes. More...
 
type(diag_dsamp), dimension(2:2) dsamp
 Downsample container. More...
 

Variables and constants

◆ diag_cs

type(diag_ctrl), pointer mom_diag_mediator::axes_grp::diag_cs => null()

Circular link back to the main diagnostics control structure (Used to avoid passing said structure into every possible call).

Definition at line 100 of file MOM_diag_mediator.F90.

100  type(diag_ctrl), pointer :: diag_cs => null() !< Circular link back to the main diagnostics control structure

◆ downsample_level

integer mom_diag_mediator::axes_grp::downsample_level = 1

If greater than 1, the factor by which this diagnostic/axes/masks be downsampled.

Definition at line 127 of file MOM_diag_mediator.F90.

127  integer :: downsample_level = 1 !< If greater than 1, the factor by which this diagnostic/axes/masks be downsampled

◆ dsamp

type(diag_dsamp), dimension(2: 2 ) mom_diag_mediator::axes_grp::dsamp

Downsample container.

Definition at line 137 of file MOM_diag_mediator.F90.

137  type(diag_dsamp), dimension(2:MAX_DSAMP_LEV) :: dsamp !< Downsample container

◆ handles

integer, dimension(:), allocatable mom_diag_mediator::axes_grp::handles

Handles to 1D axes.

Definition at line 99 of file MOM_diag_mediator.F90.

99  integer, dimension(:), allocatable :: handles !< Handles to 1D axes.

◆ id

character(len=15) mom_diag_mediator::axes_grp::id

The id string for this particular combination of handles.

Definition at line 97 of file MOM_diag_mediator.F90.

97  character(len=15) :: id !< The id string for this particular combination of handles.

◆ id_area

integer mom_diag_mediator::axes_grp::id_area = -1

The diag_manager id for area to be used for cell_measure of variables with this axes_grp.

Definition at line 131 of file MOM_diag_mediator.F90.

131  integer :: id_area = -1 !< The diag_manager id for area to be used for cell_measure of variables with this axes_grp.

◆ id_volume

integer mom_diag_mediator::axes_grp::id_volume = -1

The diag_manager id for volume to be used for cell_measure of variables with this axes_grp.

Definition at line 132 of file MOM_diag_mediator.F90.

132  integer :: id_volume = -1 !< The diag_manager id for volume to be used for cell_measure of variables

◆ is_h_point

logical mom_diag_mediator::axes_grp::is_h_point = .false.

If true, indicates that this axes group is for an h-point located field.

Definition at line 113 of file MOM_diag_mediator.F90.

113  logical :: is_h_point = .false. !< If true, indicates that this axes group is for an h-point located field.

◆ is_interface

logical mom_diag_mediator::axes_grp::is_interface = .false.

If true, indicates that this axes group is for an interface vertically-located field.

Definition at line 118 of file MOM_diag_mediator.F90.

118  logical :: is_interface = .false. !< If true, indicates that this axes group is for an interface

◆ is_layer

logical mom_diag_mediator::axes_grp::is_layer = .false.

If true, indicates that this axes group is for a layer vertically-located field.

Definition at line 117 of file MOM_diag_mediator.F90.

117  logical :: is_layer = .false. !< If true, indicates that this axes group is for a layer vertically-located field.

◆ is_native

logical mom_diag_mediator::axes_grp::is_native = .true.

If true, indicates that this axes group is for a native model grid. False for any other grid. Used for rank>2.

Definition at line 120 of file MOM_diag_mediator.F90.

120  logical :: is_native = .true. !< If true, indicates that this axes group is for a native model grid.

◆ is_q_point

logical mom_diag_mediator::axes_grp::is_q_point = .false.

If true, indicates that this axes group is for a q-point located field.

Definition at line 114 of file MOM_diag_mediator.F90.

114  logical :: is_q_point = .false. !< If true, indicates that this axes group is for a q-point located field.

◆ is_u_point

logical mom_diag_mediator::axes_grp::is_u_point = .false.

If true, indicates that this axes group is for a u-point located field.

Definition at line 115 of file MOM_diag_mediator.F90.

115  logical :: is_u_point = .false. !< If true, indicates that this axes group is for a u-point located field.

◆ is_v_point

logical mom_diag_mediator::axes_grp::is_v_point = .false.

If true, indicates that this axes group is for a v-point located field.

Definition at line 116 of file MOM_diag_mediator.F90.

116  logical :: is_v_point = .false. !< If true, indicates that this axes group is for a v-point located field.

◆ mask2d

real, dimension(:,:), pointer mom_diag_mediator::axes_grp::mask2d => null()

Mask for 2d (x-y) axes.

Definition at line 135 of file MOM_diag_mediator.F90.

135  real, pointer, dimension(:,:) :: mask2d => null() !< Mask for 2d (x-y) axes

◆ mask3d

real, dimension(:,:,:), pointer mom_diag_mediator::axes_grp::mask3d => null()

Mask for 3d axes.

Definition at line 136 of file MOM_diag_mediator.F90.

136  real, pointer, dimension(:,:,:) :: mask3d => null() !< Mask for 3d axes

◆ needs_interpolating

logical mom_diag_mediator::axes_grp::needs_interpolating = .false.

If true, indicates that this axes group is for a sampled interface-located field that must be interpolated to these axes. Used for rank>2.

Definition at line 124 of file MOM_diag_mediator.F90.

124  logical :: needs_interpolating = .false. !< If true, indicates that this axes group is for a sampled

◆ needs_remapping

logical mom_diag_mediator::axes_grp::needs_remapping = .false.

If true, indicates that this axes group is for a intensive layer-located field that must be remapped to these axes. Used for rank>2.

Definition at line 122 of file MOM_diag_mediator.F90.

122  logical :: needs_remapping = .false. !< If true, indicates that this axes group is for a intensive layer-located

◆ nz

integer mom_diag_mediator::axes_grp::nz = 0

Vertical dimension of diagnostic.

Definition at line 110 of file MOM_diag_mediator.F90.

110  integer :: nz = 0 !< Vertical dimension of diagnostic

◆ rank

integer mom_diag_mediator::axes_grp::rank

Number of dimensions in the list of axes.

Definition at line 98 of file MOM_diag_mediator.F90.

98  integer :: rank !< Number of dimensions in the list of axes.

◆ v_cell_method

character(len=9) mom_diag_mediator::axes_grp::v_cell_method = ''

Default nature of data representation, if axes group includes vertical direction.

Definition at line 107 of file MOM_diag_mediator.F90.

107  character(len=9) :: v_cell_method = '' !< Default nature of data representation, if axes group

◆ vertical_coordinate_number

integer mom_diag_mediator::axes_grp::vertical_coordinate_number = 0

Index of the corresponding diag_remap_ctrl for this axis group.

Definition at line 111 of file MOM_diag_mediator.F90.

111  integer :: vertical_coordinate_number = 0 !< Index of the corresponding diag_remap_ctrl for this axis group

◆ x_cell_method

character(len=9) mom_diag_mediator::axes_grp::x_cell_method = ''

Default nature of data representation, if axes group includes x-direction.

Definition at line 103 of file MOM_diag_mediator.F90.

103  character(len=9) :: x_cell_method = '' !< Default nature of data representation, if axes group

◆ xyave_axes

type(axes_grp), pointer mom_diag_mediator::axes_grp::xyave_axes => null()

The associated 1d axes for horizontall area-averaged diagnostics.

Definition at line 129 of file MOM_diag_mediator.F90.

129  type(axes_grp), pointer :: xyave_axes => null() !< The associated 1d axes for horizontall area-averaged diagnostics

◆ y_cell_method

character(len=9) mom_diag_mediator::axes_grp::y_cell_method = ''

Default nature of data representation, if axes group includes y-direction.

Definition at line 105 of file MOM_diag_mediator.F90.

105  character(len=9) :: y_cell_method = '' !< Default nature of data representation, if axes group

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