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 85 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...
 
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...
 

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 89 of file MOM_diag_mediator.F90.

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

◆ handles

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

Handles to 1D axes.

Definition at line 88 of file MOM_diag_mediator.F90.

88  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 86 of file MOM_diag_mediator.F90.

86  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 114 of file MOM_diag_mediator.F90.

114  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 115 of file MOM_diag_mediator.F90.

115  integer :: id_volume = -1 !< The diag_manager id for volume to be used for cell_measure of variables with this axes_grp.

◆ 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 99 of file MOM_diag_mediator.F90.

99  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 104 of file MOM_diag_mediator.F90.

104  logical :: is_interface = .false. !< If true, indicates that this axes group is for an interface vertically-located field.

◆ 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 103 of file MOM_diag_mediator.F90.

103  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 105 of file MOM_diag_mediator.F90.

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

◆ 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 100 of file MOM_diag_mediator.F90.

100  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 101 of file MOM_diag_mediator.F90.

101  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 102 of file MOM_diag_mediator.F90.

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

◆ 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 109 of file MOM_diag_mediator.F90.

109  logical :: needs_interpolating = .false. !< If true, indicates that this axes group is for a sampled interface-located field

◆ 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 107 of file MOM_diag_mediator.F90.

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

◆ nz

integer mom_diag_mediator::axes_grp::nz = 0

Vertical dimension of diagnostic.

Definition at line 96 of file MOM_diag_mediator.F90.

96  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 87 of file MOM_diag_mediator.F90.

87  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 94 of file MOM_diag_mediator.F90.

94  character(len=9) :: v_cell_method = '' !< Default nature of data representation, if axes group includes vertical direction.

◆ 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 97 of file MOM_diag_mediator.F90.

97  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 92 of file MOM_diag_mediator.F90.

92  character(len=9) :: x_cell_method = '' !< Default nature of data representation, if axes group includes x-direction.

◆ 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 112 of file MOM_diag_mediator.F90.

112  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 93 of file MOM_diag_mediator.F90.

93  character(len=9) :: y_cell_method = '' !< Default nature of data representation, if axes group includes y-direction.

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