Detailed Description

This type is used for communication with other components via the FMS coupler. The element names and types can be changed only with great deliberation, hence the persistnce of things like the cutsy element name "avg_kount".

Definition at line 88 of file mom_ocean_model_mct.F90.

Collaboration diagram for mom_ocean_model_mct::ocean_public_type:

[legend]

Public variables and constants
type(domain2d)	domain
	The domain for the surface fields. More...

logical	is_ocean_pe
	.true. on processors that run the ocean model. More...

character(len=32)	instance_name = ''
	A name that can be used to identify this instance of an ocean model, for example in ensembles when writing messages. More...

integer, dimension(:), pointer	pelist => NULL()
	The list of ocean PEs. More...

logical, dimension(:,:), pointer	maskmap =>NULL()
	A pointer to an array indicating which logical processors are actually used for the ocean code. The other logical processors would be all land points and are not assigned to actual processors. This need not be assigned if all logical processors are used. More...

integer	stagger = -999
	The staggering relative to the tracer points points of the two velocity components. Valid entries include AGRID, BGRID_NE, CGRID_NE, BGRID_SW, and CGRID_SW, corresponding to the community-standard Arakawa notation. (These are named integers taken from mpp_parameter_mod.) Following MOM5, stagger is BGRID_NE by default when the ocean is initialized, but here it is set to -999 so that a global max across ocean and non-ocean processors can be used to determine its value. More...

real, dimension(:,:), pointer	t_surf => NULL()
	SST on t-cell (degrees Kelvin) More...

real, dimension(:,:), pointer	s_surf => NULL()
	SSS on t-cell (psu) More...

real, dimension(:,:), pointer	u_surf => NULL()
	i-velocity at the locations indicated by stagger, m/s. More...

real, dimension(:,:), pointer	v_surf => NULL()
	j-velocity at the locations indicated by stagger, m/s. More...

real, dimension(:,:), pointer	sea_lev => NULL()
	Sea level in m after correction for surface pressure,. More...

real, dimension(:,:), pointer	frazil =>NULL()
	Accumulated heating (in Joules/m^2) from frazil. More...

real, dimension(:,:), pointer	melt_potential => NULL()
	Instantaneous heat used to melt sea ice (in J/m^2) More...

real, dimension(:,:), pointer	area => NULL()
	cell area of the ocean surface, in m2. More...

real, dimension(:,:), pointer	obld => NULL()
	Ocean boundary layer depth, in m. More...

type(coupler_2d_bc_type)	fields
	A structure that may contain named arrays of tracer-related surface fields. More...

integer	avg_kount
	A count of contributions to running sums, used externally by the FMS coupler for accumulating averages of this type. More...

integer, dimension(2)	axes = 0
	Axis numbers that are available for I/O using this surface data. More...

Variables and constants

◆ area

real, dimension(:,:), pointer mom_ocean_model_mct::ocean_public_type::area => NULL()

cell area of the ocean surface, in m2.

Definition at line 110 of file mom_ocean_model_mct.F90.

◆ avg_kount

integer mom_ocean_model_mct::ocean_public_type::avg_kount

A count of contributions to running sums, used externally by the FMS coupler for accumulating averages of this type.

Definition at line 124 of file mom_ocean_model_mct.F90.

124 integer :: avg_kount !< A count of contributions to running

◆ axes

integer, dimension(2) mom_ocean_model_mct::ocean_public_type::axes = 0

Axis numbers that are available for I/O using this surface data.

Definition at line 127 of file mom_ocean_model_mct.F90.

127 integer, dimension(2) :: axes = 0 !< Axis numbers that are available

◆ domain

type(domain2d) mom_ocean_model_mct::ocean_public_type::domain

The domain for the surface fields.

Definition at line 89 of file mom_ocean_model_mct.F90.

89 type(domain2d) :: Domain !< The domain for the surface fields.

◆ fields

type(coupler_2d_bc_type) mom_ocean_model_mct::ocean_public_type::fields

A structure that may contain named arrays of tracer-related surface fields.

Definition at line 122 of file mom_ocean_model_mct.F90.

122 type(coupler_2d_bc_type) :: fields !< A structure that may contain named

◆ frazil

real, dimension(:,:), pointer mom_ocean_model_mct::ocean_public_type::frazil =>NULL()

Accumulated heating (in Joules/m^2) from frazil.

Definition at line 110 of file mom_ocean_model_mct.F90.

◆ instance_name

character(len=32) mom_ocean_model_mct::ocean_public_type::instance_name = ''

A name that can be used to identify this instance of an ocean model, for example in ensembles when writing messages.

Definition at line 91 of file mom_ocean_model_mct.F90.

91 character(len=32) :: instance_name = '' !< A name that can be used to identify

◆ is_ocean_pe

logical mom_ocean_model_mct::ocean_public_type::is_ocean_pe

.true. on processors that run the ocean model.

Definition at line 90 of file mom_ocean_model_mct.F90.

90 logical :: is_ocean_pe !< .true. on processors that run the ocean model.

◆ maskmap

logical, dimension(:,:), pointer mom_ocean_model_mct::ocean_public_type::maskmap =>NULL()

A pointer to an array indicating which logical processors are actually used for the ocean code. The other logical processors would be all land points and are not assigned to actual processors. This need not be assigned if all logical processors are used.

Definition at line 95 of file mom_ocean_model_mct.F90.

95 logical, pointer, dimension(:,:) :: maskmap =>null() !< A pointer to an array

◆ melt_potential

real, dimension(:,:), pointer mom_ocean_model_mct::ocean_public_type::melt_potential => NULL()

Instantaneous heat used to melt sea ice (in J/m^2)

Definition at line 110 of file mom_ocean_model_mct.F90.

◆ obld

real, dimension(:,:), pointer mom_ocean_model_mct::ocean_public_type::obld => NULL()

Ocean boundary layer depth, in m.

Definition at line 110 of file mom_ocean_model_mct.F90.

◆ pelist

integer, dimension(:), pointer mom_ocean_model_mct::ocean_public_type::pelist => NULL()

The list of ocean PEs.

Definition at line 94 of file mom_ocean_model_mct.F90.

94 integer, pointer, dimension(:) :: pelist => null() !< The list of ocean PEs.

◆ s_surf

real, dimension(:,:), pointer mom_ocean_model_mct::ocean_public_type::s_surf => NULL()

SSS on t-cell (psu)

Definition at line 110 of file mom_ocean_model_mct.F90.

◆ sea_lev

real, dimension(:,:), pointer mom_ocean_model_mct::ocean_public_type::sea_lev => NULL()

Sea level in m after correction for surface pressure,.

Definition at line 110 of file mom_ocean_model_mct.F90.

◆ stagger

integer mom_ocean_model_mct::ocean_public_type::stagger = -999

The staggering relative to the tracer points points of the two velocity components. Valid entries include AGRID, BGRID_NE, CGRID_NE, BGRID_SW, and CGRID_SW, corresponding to the community-standard Arakawa notation. (These are named integers taken from mpp_parameter_mod.) Following MOM5, stagger is BGRID_NE by default when the ocean is initialized, but here it is set to -999 so that a global max across ocean and non-ocean processors can be used to determine its value.

Definition at line 101 of file mom_ocean_model_mct.F90.

101 integer :: stagger = -999 !< The staggering relative to the tracer points

◆ t_surf

real, dimension(:,:), pointer mom_ocean_model_mct::ocean_public_type::t_surf => NULL()

SST on t-cell (degrees Kelvin)

Definition at line 110 of file mom_ocean_model_mct.F90.

   real, pointer, dimension(:,:)  :: &
     t_surf => null(), &  !< SST on t-cell (degrees Kelvin)
     s_surf => null(), &  !< SSS on t-cell (psu)
     u_surf => null(), &  !< i-velocity at the locations indicated by stagger, m/s.
     v_surf => null(), &  !< j-velocity at the locations indicated by stagger, m/s.
     sea_lev => null(), & !< Sea level in m after correction for surface pressure,
                          !! i.e. dzt(1) + eta_t + patm/rho0/grav (m)
     frazil =>null(), &   !< Accumulated heating (in Joules/m^2) from frazil
                          !! formation in the ocean.
     melt_potential => null(), & !< Instantaneous heat used to melt sea ice (in J/m^2)
     area => null(), &    !< cell area of the ocean surface, in m2.
     obld => null()       !< Ocean boundary layer depth, in m.

◆ u_surf

real, dimension(:,:), pointer mom_ocean_model_mct::ocean_public_type::u_surf => NULL()

i-velocity at the locations indicated by stagger, m/s.

Definition at line 110 of file mom_ocean_model_mct.F90.

◆ v_surf

real, dimension(:,:), pointer mom_ocean_model_mct::ocean_public_type::v_surf => NULL()

j-velocity at the locations indicated by stagger, m/s.

Definition at line 110 of file mom_ocean_model_mct.F90.

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

/glade/work/altuntas/cesm.sandboxes/cesm2_2_alpha_X_mom/components/mom/MOM6/config_src/mct_driver/mom_ocean_model_mct.F90

Detailed Description

Public variables and constants

Variables and constants

◆ area

◆ avg_kount

◆ axes

◆ domain

◆ fields

◆ frazil

◆ instance_name

◆ is_ocean_pe

◆ maskmap

◆ melt_potential

◆ obld

◆ pelist

◆ s_surf

◆ sea_lev

◆ stagger

◆ t_surf

◆ u_surf

◆ v_surf