Detailed Description

Ocean grid type. See mom_grid for details.

Definition at line 26 of file MOM_grid.F90.

Collaboration diagram for mom_grid::ocean_grid_type:

Public variables and constants
type(mom_domain_type), pointer	domain => NULL()
	Ocean model domain. More...

type(mom_domain_type), pointer	domain_aux => NULL()
	A non-symmetric auxiliary domain type. More...

type(hor_index_type)	hi
	Horizontal index ranges. More...

type(hor_index_type)	hid2
	Horizontal index ranges for level-2-downsampling. More...

integer	isc
	The start i-index of cell centers within the computational domain. More...

integer	iec
	The end i-index of cell centers within the computational domain. More...

integer	jsc
	The start j-index of cell centers within the computational domain. More...

integer	jec
	The end j-index of cell centers within the computational domain. More...

integer	isd
	The start i-index of cell centers within the data domain. More...

integer	ied
	The end i-index of cell centers within the data domain. More...

integer	jsd
	The start j-index of cell centers within the data domain. More...

integer	jed
	The end j-index of cell centers within the data domain. More...

integer	isg
	The start i-index of cell centers within the global domain. More...

integer	ieg
	The end i-index of cell centers within the global domain. More...

integer	jsg
	The start j-index of cell centers within the global domain. More...

integer	jeg
	The end j-index of cell centers within the global domain. More...

integer	iscb
	The start i-index of cell vertices within the computational domain. More...

integer	iecb
	The end i-index of cell vertices within the computational domain. More...

integer	jscb
	The start j-index of cell vertices within the computational domain. More...

integer	jecb
	The end j-index of cell vertices within the computational domain. More...

integer	isdb
	The start i-index of cell vertices within the data domain. More...

integer	iedb
	The end i-index of cell vertices within the data domain. More...

integer	jsdb
	The start j-index of cell vertices within the data domain. More...

integer	jedb
	The end j-index of cell vertices within the data domain. More...

integer	isgb
	The start i-index of cell vertices within the global domain. More...

integer	iegb
	The end i-index of cell vertices within the global domain. More...

integer	jsgb
	The start j-index of cell vertices within the global domain. More...

integer	jegb
	The end j-index of cell vertices within the global domain. More...

integer	isd_global
	The value of isd in the global index space (decompoistion invariant). More...

integer	jsd_global
	The value of isd in the global index space (decompoistion invariant). More...

integer	idg_offset
	The offset between the corresponding global and local i-indices. More...

integer	jdg_offset
	The offset between the corresponding global and local j-indices. More...

integer	ke
	The number of layers in the vertical. More...

logical	symmetric
	True if symmetric memory is used. More...

logical	nonblocking_updates
	If true, non-blocking halo updates are allowed. The default is .false. (for now). More...

integer	first_direction
	An integer that indicates which direction is to be updated first in directionally split parts of the calculation. This can be altered during the course of the run via calls to set_first_direction. More...

real, dimension(:, :), allocatable	mask2dt
	0 for land points and 1 for ocean points on the h-grid [nondim]. More...

real, dimension(:, :), allocatable	geolatt
	The geographic latitude at q points in degrees of latitude or m. More...

real, dimension(:, :), allocatable	geolont
	The geographic longitude at q points in degrees of longitude or m. More...

real, dimension(:, :), allocatable	dxt
	dxT is delta x at h points [L ~> m]. More...

real, dimension(:, :), allocatable	idxt
	1/dxT [L-1 ~> m-1]. More...

real, dimension(:, :), allocatable	dyt
	dyT is delta y at h points [L ~> m]. More...

real, dimension(:, :), allocatable	idyt
	IdyT is 1/dyT [L-1 ~> m-1]. More...

real, dimension(:, :), allocatable	areat
	The area of an h-cell [L2 ~> m2]. More...

real, dimension(:, :), allocatable	iareat
	1/areaT [L-2 ~> m-2]. More...

real, dimension(:, :), allocatable	sin_rot
	The sine of the angular rotation between the local model grid's northward. More...

real, dimension(:, :), allocatable	cos_rot
	The cosine of the angular rotation between the local model grid's northward. More...

real, dimension(:, :), allocatable	mask2dcu
	0 for boundary points and 1 for ocean points on the u grid [nondim]. More...

real, dimension(:, :), allocatable	geolatcu
	The geographic latitude at u points in degrees of latitude or m. More...

real, dimension(:, :), allocatable	geoloncu
	The geographic longitude at u points in degrees of longitude or m. More...

real, dimension(:, :), allocatable	dxcu
	dxCu is delta x at u points [L ~> m]. More...

real, dimension(:, :), allocatable	idxcu
	1/dxCu [L-1 ~> m-1]. More...

real, dimension(:, :), allocatable	dycu
	dyCu is delta y at u points [L ~> m]. More...

real, dimension(:, :), allocatable	idycu
	1/dyCu [L-1 ~> m-1]. More...

real, dimension(:, :), allocatable	dy_cu
	The unblocked lengths of the u-faces of the h-cell [L ~> m]. More...

real, dimension(:, :), allocatable	iareacu
	The masked inverse areas of u-grid cells [L-2 ~> m-2]. More...

real, dimension(:, :), allocatable	areacu
	The areas of the u-grid cells [L2 ~> m2]. More...

real, dimension(:, :), allocatable	mask2dcv
	0 for boundary points and 1 for ocean points on the v grid [nondim]. More...

real, dimension(:, :), allocatable	geolatcv
	The geographic latitude at v points in degrees of latitude or m. More...

real, dimension(:, :), allocatable	geoloncv
	The geographic longitude at v points in degrees of longitude or m. More...

real, dimension(:, :), allocatable	dxcv
	dxCv is delta x at v points [L ~> m]. More...

real, dimension(:, :), allocatable	idxcv
	1/dxCv [L-1 ~> m-1]. More...

real, dimension(:, :), allocatable	dycv
	dyCv is delta y at v points [L ~> m]. More...

real, dimension(:, :), allocatable	idycv
	1/dyCv [L-1 ~> m-1]. More...

real, dimension(:, :), allocatable	dx_cv
	The unblocked lengths of the v-faces of the h-cell [L ~> m]. More...

real, dimension(:, :), allocatable	iareacv
	The masked inverse areas of v-grid cells [L-2 ~> m-2]. More...

real, dimension(:, :), allocatable	areacv
	The areas of the v-grid cells [L2 ~> m2]. More...

real, dimension(:, :), allocatable	mask2dbu
	0 for boundary points and 1 for ocean points on the q grid [nondim]. More...

real, dimension(:, :), allocatable	geolatbu
	The geographic latitude at q points in degrees of latitude or m. More...

real, dimension(:, :), allocatable	geolonbu
	The geographic longitude at q points in degrees of longitude or m. More...

real, dimension(:, :), allocatable	dxbu
	dxBu is delta x at q points [L ~> m]. More...

real, dimension(:, :), allocatable	idxbu
	1/dxBu [L-1 ~> m-1]. More...

real, dimension(:, :), allocatable	dybu
	dyBu is delta y at q points [L ~> m]. More...

real, dimension(:, :), allocatable	idybu
	1/dyBu [L-1 ~> m-1]. More...

real, dimension(:, :), allocatable	areabu
	areaBu is the area of a q-cell [L2 ~> m2] More...

real, dimension(:, :), allocatable	iareabu
	IareaBu = 1/areaBu [L-2 ~> m-2]. More...

real, dimension(:), pointer	gridlatt => NULL()
	The latitude of T points for the purpose of labeling the output axes. More...

real, dimension(:), pointer	gridlatb => NULL()
	The latitude of B points for the purpose of labeling the output axes. More...

real, dimension(:), pointer	gridlont => NULL()
	The longitude of T points for the purpose of labeling the output axes. More...

real, dimension(:), pointer	gridlonb => NULL()
	The longitude of B points for the purpose of labeling the output axes. More...

character(len=40)	x_axis_units
	The units that are used in labeling the x coordinate axes. More...

character(len=40)	y_axis_units
	The units that are used in labeling the y coordinate axes. More...

real, dimension(:, :), allocatable	bathyt
	Ocean bottom depth at tracer points, in depth units [Z ~> m]. More...

logical	bathymetry_at_vel
	If true, there are separate values for the basin depths at velocity points. Otherwise the effects of of topography are entirely determined from thickness points. More...

real, dimension(:, :), allocatable	dblock_u
	Topographic depths at u-points at which the flow is blocked [Z ~> m]. More...

real, dimension(:, :), allocatable	dopen_u
	Topographic depths at u-points at which the flow is open at width dy_Cu [Z ~> m]. More...

real, dimension(:, :), allocatable	dblock_v
	Topographic depths at v-points at which the flow is blocked [Z ~> m]. More...

real, dimension(:, :), allocatable	dopen_v
	Topographic depths at v-points at which the flow is open at width dx_Cv [Z ~> m]. More...

real, dimension(:, :), allocatable	coriolisbu
	The Coriolis parameter at corner points [T-1 ~> s-1]. More...

real, dimension(:, :), allocatable	df_dx
	Derivative d/dx f (Coriolis parameter) at h-points [T-1 L-1 ~> s-1 m-1]. More...

real, dimension(:, :), allocatable	df_dy
	Derivative d/dy f (Coriolis parameter) at h-points [T-1 L-1 ~> s-1 m-1]. More...

real	g_earth
	The gravitational acceleration [m2 Z-1 s-2 ~> m s-2]. More...

real	areat_global
	Global sum of h-cell area [m2]. More...

real	iareat_global
	Global sum of inverse h-cell area (1/areaT_global) [m-2]. More...

type(unit_scale_type), pointer	us => NULL()
	A dimensional unit scaling type. More...

integer	nblocks
	The number of sub-PE blocks on this PE. More...

type(hor_index_type), dimension(:), pointer	block => NULL()
	Index ranges for each block. More...

real	south_lat
	The latitude (or y-coordinate) of the first v-line. More...

real	west_lon
	The longitude (or x-coordinate) of the first u-line. More...

real	len_lat = 0.
	The latitudinal (or y-coord) extent of physical domain. More...

real	len_lon = 0.
	The longitudinal (or x-coord) extent of physical domain. More...

real	rad_earth = 6.378e6
	The radius of the planet [m]. More...

real	max_depth
	The maximum depth of the ocean in depth units [Z ~> m]. More...

Variables and constants

◆ areabu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::areabu

areaBu is the area of a q-cell [L2 ~> m2]

Definition at line 115 of file MOM_grid.F90.

◆ areacu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::areacu

The areas of the u-grid cells [L2 ~> m2].

Definition at line 91 of file MOM_grid.F90.

◆ areacv

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::areacv

The areas of the v-grid cells [L2 ~> m2].

Definition at line 103 of file MOM_grid.F90.

◆ areat

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::areat

The area of an h-cell [L2 ~> m2].

Definition at line 76 of file MOM_grid.F90.

◆ areat_global

real mom_grid::ocean_grid_type::areat_global

Global sum of h-cell area [m2].

Definition at line 160 of file MOM_grid.F90.

160 real :: areaT_global !< Global sum of h-cell area [m2]

◆ bathymetry_at_vel

logical mom_grid::ocean_grid_type::bathymetry_at_vel

If true, there are separate values for the basin depths at velocity points. Otherwise the effects of of topography are entirely determined from thickness points.

Definition at line 143 of file MOM_grid.F90.

143 logical :: bathymetry_at_vel !< If true, there are separate values for the

◆ bathyt

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::bathyt

Ocean bottom depth at tracer points, in depth units [Z ~> m].

Definition at line 140 of file MOM_grid.F90.

140 real ALLOCABLE_, dimension(NIMEM_,NJMEM_) :: &

141 bathyT !< Ocean bottom depth at tracer points, in depth units [Z ~> m].

◆ block

type(hor_index_type), dimension(:), pointer mom_grid::ocean_grid_type::block => NULL()

Index ranges for each block.

Definition at line 168 of file MOM_grid.F90.

168 type(hor_index_type), pointer :: Block(:) => null() !< Index ranges for each block

◆ coriolisbu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::coriolisbu

The Coriolis parameter at corner points [T-1 ~> s-1].

Definition at line 152 of file MOM_grid.F90.

152 real ALLOCABLE_, dimension(NIMEMB_PTR_,NJMEMB_PTR_) :: &

153 CoriolisBu !< The Coriolis parameter at corner points [T-1 ~> s-1].

◆ cos_rot

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::cos_rot

The cosine of the angular rotation between the local model grid's northward.

Definition at line 76 of file MOM_grid.F90.

◆ dblock_u

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dblock_u

Topographic depths at u-points at which the flow is blocked [Z ~> m].

Definition at line 146 of file MOM_grid.F90.

   real ALLOCABLE_, dimension(NIMEMB_PTR_,NJMEM_) :: &
     Dblock_u, &   !< Topographic depths at u-points at which the flow is blocked [Z ~> m].
     Dopen_u       !< Topographic depths at u-points at which the flow is open at width dy_Cu [Z ~> m].

◆ dblock_v

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dblock_v

Topographic depths at v-points at which the flow is blocked [Z ~> m].

Definition at line 149 of file MOM_grid.F90.

   real ALLOCABLE_, dimension(NIMEM_,NJMEMB_PTR_) :: &
     Dblock_v, &   !< Topographic depths at v-points at which the flow is blocked [Z ~> m].
     Dopen_v       !< Topographic depths at v-points at which the flow is open at width dx_Cv [Z ~> m].

◆ df_dx

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::df_dx

Derivative d/dx f (Coriolis parameter) at h-points [T-1 L-1 ~> s-1 m-1].

Definition at line 154 of file MOM_grid.F90.

   real ALLOCABLE_, dimension(NIMEM_,NJMEM_) :: &
     df_dx, &      !< Derivative d/dx f (Coriolis parameter) at h-points [T-1 L-1 ~> s-1 m-1].
     df_dy         !< Derivative d/dy f (Coriolis parameter) at h-points [T-1 L-1 ~> s-1 m-1].

◆ df_dy

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::df_dy

Derivative d/dy f (Coriolis parameter) at h-points [T-1 L-1 ~> s-1 m-1].

Definition at line 154 of file MOM_grid.F90.

◆ domain

type(mom_domain_type), pointer mom_grid::ocean_grid_type::domain => NULL()

Ocean model domain.

Definition at line 27 of file MOM_grid.F90.

27 type(MOM_domain_type), pointer :: Domain => null() !< Ocean model domain

◆ domain_aux

type(mom_domain_type), pointer mom_grid::ocean_grid_type::domain_aux => NULL()

A non-symmetric auxiliary domain type.

Definition at line 28 of file MOM_grid.F90.

28 type(MOM_domain_type), pointer :: Domain_aux => null() !< A non-symmetric auxiliary domain type.

◆ dopen_u

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dopen_u

Topographic depths at u-points at which the flow is open at width dy_Cu [Z ~> m].

Definition at line 146 of file MOM_grid.F90.

◆ dopen_v

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dopen_v

Topographic depths at v-points at which the flow is open at width dx_Cv [Z ~> m].

Definition at line 149 of file MOM_grid.F90.

◆ dx_cv

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dx_cv

The unblocked lengths of the v-faces of the h-cell [L ~> m].

Definition at line 103 of file MOM_grid.F90.

◆ dxbu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dxbu

dxBu is delta x at q points [L ~> m].

Definition at line 115 of file MOM_grid.F90.

◆ dxcu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dxcu

dxCu is delta x at u points [L ~> m].

Definition at line 91 of file MOM_grid.F90.

◆ dxcv

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dxcv

dxCv is delta x at v points [L ~> m].

Definition at line 103 of file MOM_grid.F90.

◆ dxt

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dxt

dxT is delta x at h points [L ~> m].

Definition at line 76 of file MOM_grid.F90.

◆ dy_cu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dy_cu

The unblocked lengths of the u-faces of the h-cell [L ~> m].

Definition at line 91 of file MOM_grid.F90.

◆ dybu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dybu

dyBu is delta y at q points [L ~> m].

Definition at line 115 of file MOM_grid.F90.

◆ dycu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dycu

dyCu is delta y at u points [L ~> m].

Definition at line 91 of file MOM_grid.F90.

◆ dycv

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dycv

dyCv is delta y at v points [L ~> m].

Definition at line 103 of file MOM_grid.F90.

◆ dyt

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::dyt

dyT is delta y at h points [L ~> m].

Definition at line 76 of file MOM_grid.F90.

◆ first_direction

integer mom_grid::ocean_grid_type::first_direction

An integer that indicates which direction is to be updated first in directionally split parts of the calculation. This can be altered during the course of the run via calls to set_first_direction.

Definition at line 70 of file MOM_grid.F90.

70 integer :: first_direction !< An integer that indicates which direction is

◆ g_earth

real mom_grid::ocean_grid_type::g_earth

The gravitational acceleration [m2 Z-1 s-2 ~> m s-2].

Definition at line 157 of file MOM_grid.F90.

157 real :: g_Earth !< The gravitational acceleration [m2 Z-1 s-2 ~> m s-2].

◆ geolatbu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::geolatbu

The geographic latitude at q points in degrees of latitude or m.

Definition at line 115 of file MOM_grid.F90.

◆ geolatcu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::geolatcu

The geographic latitude at u points in degrees of latitude or m.

Definition at line 91 of file MOM_grid.F90.

◆ geolatcv

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::geolatcv

The geographic latitude at v points in degrees of latitude or m.

Definition at line 103 of file MOM_grid.F90.

◆ geolatt

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::geolatt

The geographic latitude at q points in degrees of latitude or m.

Definition at line 76 of file MOM_grid.F90.

◆ geolonbu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::geolonbu

The geographic longitude at q points in degrees of longitude or m.

Definition at line 115 of file MOM_grid.F90.

◆ geoloncu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::geoloncu

The geographic longitude at u points in degrees of longitude or m.

Definition at line 91 of file MOM_grid.F90.

◆ geoloncv

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::geoloncv

The geographic longitude at v points in degrees of longitude or m.

Definition at line 103 of file MOM_grid.F90.

◆ geolont

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::geolont

The geographic longitude at q points in degrees of longitude or m.

Definition at line 76 of file MOM_grid.F90.

◆ gridlatb

real, dimension(:), pointer mom_grid::ocean_grid_type::gridlatb => NULL()

The latitude of B points for the purpose of labeling the output axes.

Definition at line 126 of file MOM_grid.F90.

◆ gridlatt

real, dimension(:), pointer mom_grid::ocean_grid_type::gridlatt => NULL()

The latitude of T points for the purpose of labeling the output axes.

Definition at line 126 of file MOM_grid.F90.

   real, pointer, dimension(:) :: &
     gridLatT => null(), & !< The latitude of T points for the purpose of labeling the output axes.
                           !! On many grids this is the same as geoLatT.
     gridlatb => null()    !< The latitude of B points for the purpose of labeling the output axes.

◆ gridlonb

real, dimension(:), pointer mom_grid::ocean_grid_type::gridlonb => NULL()

The longitude of B points for the purpose of labeling the output axes.

Definition at line 131 of file MOM_grid.F90.

◆ gridlont

real, dimension(:), pointer mom_grid::ocean_grid_type::gridlont => NULL()

The longitude of T points for the purpose of labeling the output axes.

Definition at line 131 of file MOM_grid.F90.

   real, pointer, dimension(:) :: &
     gridLonT => null(), & !< The longitude of T points for the purpose of labeling the output axes.
                           !! On many grids this is the same as geoLonT.
     gridlonb => null()    !< The longitude of B points for the purpose of labeling the output axes.

◆ hi

type(hor_index_type) mom_grid::ocean_grid_type::hi

Horizontal index ranges.

Definition at line 29 of file MOM_grid.F90.

29 type(hor_index_type) :: HI !< Horizontal index ranges

◆ hid2

type(hor_index_type) mom_grid::ocean_grid_type::hid2

Horizontal index ranges for level-2-downsampling.

Definition at line 30 of file MOM_grid.F90.

30 type(hor_index_type) :: HId2 !< Horizontal index ranges for level-2-downsampling

◆ iareabu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::iareabu

IareaBu = 1/areaBu [L-2 ~> m-2].

Definition at line 115 of file MOM_grid.F90.

◆ iareacu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::iareacu

The masked inverse areas of u-grid cells [L-2 ~> m-2].

Definition at line 91 of file MOM_grid.F90.

◆ iareacv

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::iareacv

The masked inverse areas of v-grid cells [L-2 ~> m-2].

Definition at line 103 of file MOM_grid.F90.

◆ iareat

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::iareat

1/areaT [L-2 ~> m-2].

Definition at line 76 of file MOM_grid.F90.

◆ iareat_global

real mom_grid::ocean_grid_type::iareat_global

Global sum of inverse h-cell area (1/areaT_global) [m-2].

Definition at line 161 of file MOM_grid.F90.

161 real :: IareaT_global !< Global sum of inverse h-cell area (1/areaT_global) [m-2].

◆ idg_offset

integer mom_grid::ocean_grid_type::idg_offset

The offset between the corresponding global and local i-indices.

Definition at line 64 of file MOM_grid.F90.

64 integer :: idg_offset !< The offset between the corresponding global and local i-indices.

◆ idxbu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::idxbu

1/dxBu [L-1 ~> m-1].

Definition at line 115 of file MOM_grid.F90.

◆ idxcu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::idxcu

1/dxCu [L-1 ~> m-1].

Definition at line 91 of file MOM_grid.F90.

◆ idxcv

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::idxcv

1/dxCv [L-1 ~> m-1].

Definition at line 103 of file MOM_grid.F90.

◆ idxt

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::idxt

1/dxT [L-1 ~> m-1].

Definition at line 76 of file MOM_grid.F90.

◆ idybu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::idybu

1/dyBu [L-1 ~> m-1].

Definition at line 115 of file MOM_grid.F90.

◆ idycu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::idycu

1/dyCu [L-1 ~> m-1].

Definition at line 91 of file MOM_grid.F90.

◆ idycv

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::idycv

1/dyCv [L-1 ~> m-1].

Definition at line 103 of file MOM_grid.F90.

◆ idyt

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::idyt

IdyT is 1/dyT [L-1 ~> m-1].

Definition at line 76 of file MOM_grid.F90.

◆ iec

integer mom_grid::ocean_grid_type::iec

The end i-index of cell centers within the computational domain.

Definition at line 33 of file MOM_grid.F90.

33 integer :: iec !< The end i-index of cell centers within the computational domain

◆ iecb

integer mom_grid::ocean_grid_type::iecb

The end i-index of cell vertices within the computational domain.

Definition at line 48 of file MOM_grid.F90.

48 integer :: IecB !< The end i-index of cell vertices within the computational domain

◆ ied

integer mom_grid::ocean_grid_type::ied

The end i-index of cell centers within the data domain.

Definition at line 38 of file MOM_grid.F90.

38 integer :: ied !< The end i-index of cell centers within the data domain

◆ iedb

integer mom_grid::ocean_grid_type::iedb

The end i-index of cell vertices within the data domain.

Definition at line 53 of file MOM_grid.F90.

53 integer :: IedB !< The end i-index of cell vertices within the data domain

◆ ieg

integer mom_grid::ocean_grid_type::ieg

The end i-index of cell centers within the global domain.

Definition at line 43 of file MOM_grid.F90.

43 integer :: ieg !< The end i-index of cell centers within the global domain

◆ iegb

integer mom_grid::ocean_grid_type::iegb

The end i-index of cell vertices within the global domain.

Definition at line 58 of file MOM_grid.F90.

58 integer :: IegB !< The end i-index of cell vertices within the global domain

◆ isc

integer mom_grid::ocean_grid_type::isc

The start i-index of cell centers within the computational domain.

Definition at line 32 of file MOM_grid.F90.

32 integer :: isc !< The start i-index of cell centers within the computational domain

◆ iscb

integer mom_grid::ocean_grid_type::iscb

The start i-index of cell vertices within the computational domain.

Definition at line 47 of file MOM_grid.F90.

47 integer :: IscB !< The start i-index of cell vertices within the computational domain

◆ isd

integer mom_grid::ocean_grid_type::isd

The start i-index of cell centers within the data domain.

Definition at line 37 of file MOM_grid.F90.

37 integer :: isd !< The start i-index of cell centers within the data domain

◆ isd_global

integer mom_grid::ocean_grid_type::isd_global

The value of isd in the global index space (decompoistion invariant).

Definition at line 62 of file MOM_grid.F90.

62 integer :: isd_global !< The value of isd in the global index space (decompoistion invariant).

◆ isdb

integer mom_grid::ocean_grid_type::isdb

The start i-index of cell vertices within the data domain.

Definition at line 52 of file MOM_grid.F90.

52 integer :: IsdB !< The start i-index of cell vertices within the data domain

◆ isg

integer mom_grid::ocean_grid_type::isg

The start i-index of cell centers within the global domain.

Definition at line 42 of file MOM_grid.F90.

42 integer :: isg !< The start i-index of cell centers within the global domain

◆ isgb

integer mom_grid::ocean_grid_type::isgb

The start i-index of cell vertices within the global domain.

Definition at line 57 of file MOM_grid.F90.

57 integer :: IsgB !< The start i-index of cell vertices within the global domain

◆ jdg_offset

integer mom_grid::ocean_grid_type::jdg_offset

The offset between the corresponding global and local j-indices.

Definition at line 65 of file MOM_grid.F90.

65 integer :: jdg_offset !< The offset between the corresponding global and local j-indices.

◆ jec

integer mom_grid::ocean_grid_type::jec

The end j-index of cell centers within the computational domain.

Definition at line 35 of file MOM_grid.F90.

35 integer :: jec !< The end j-index of cell centers within the computational domain

◆ jecb

integer mom_grid::ocean_grid_type::jecb

The end j-index of cell vertices within the computational domain.

Definition at line 50 of file MOM_grid.F90.

50 integer :: JecB !< The end j-index of cell vertices within the computational domain

◆ jed

integer mom_grid::ocean_grid_type::jed

The end j-index of cell centers within the data domain.

Definition at line 40 of file MOM_grid.F90.

40 integer :: jed !< The end j-index of cell centers within the data domain

◆ jedb

integer mom_grid::ocean_grid_type::jedb

The end j-index of cell vertices within the data domain.

Definition at line 55 of file MOM_grid.F90.

55 integer :: JedB !< The end j-index of cell vertices within the data domain

◆ jeg

integer mom_grid::ocean_grid_type::jeg

The end j-index of cell centers within the global domain.

Definition at line 45 of file MOM_grid.F90.

45 integer :: jeg !< The end j-index of cell centers within the global domain

◆ jegb

integer mom_grid::ocean_grid_type::jegb

The end j-index of cell vertices within the global domain.

Definition at line 60 of file MOM_grid.F90.

60 integer :: JegB !< The end j-index of cell vertices within the global domain

◆ jsc

integer mom_grid::ocean_grid_type::jsc

The start j-index of cell centers within the computational domain.

Definition at line 34 of file MOM_grid.F90.

34 integer :: jsc !< The start j-index of cell centers within the computational domain

◆ jscb

integer mom_grid::ocean_grid_type::jscb

The start j-index of cell vertices within the computational domain.

Definition at line 49 of file MOM_grid.F90.

49 integer :: JscB !< The start j-index of cell vertices within the computational domain

◆ jsd

integer mom_grid::ocean_grid_type::jsd

The start j-index of cell centers within the data domain.

Definition at line 39 of file MOM_grid.F90.

39 integer :: jsd !< The start j-index of cell centers within the data domain

◆ jsd_global

integer mom_grid::ocean_grid_type::jsd_global

The value of isd in the global index space (decompoistion invariant).

Definition at line 63 of file MOM_grid.F90.

63 integer :: jsd_global !< The value of isd in the global index space (decompoistion invariant).

◆ jsdb

integer mom_grid::ocean_grid_type::jsdb

The start j-index of cell vertices within the data domain.

Definition at line 54 of file MOM_grid.F90.

54 integer :: JsdB !< The start j-index of cell vertices within the data domain

◆ jsg

integer mom_grid::ocean_grid_type::jsg

The start j-index of cell centers within the global domain.

Definition at line 44 of file MOM_grid.F90.

44 integer :: jsg !< The start j-index of cell centers within the global domain

◆ jsgb

integer mom_grid::ocean_grid_type::jsgb

The start j-index of cell vertices within the global domain.

Definition at line 59 of file MOM_grid.F90.

59 integer :: JsgB !< The start j-index of cell vertices within the global domain

◆ ke

integer mom_grid::ocean_grid_type::ke

The number of layers in the vertical.

Definition at line 66 of file MOM_grid.F90.

66 integer :: ke !< The number of layers in the vertical.

◆ len_lat

real mom_grid::ocean_grid_type::len_lat = 0.

The latitudinal (or y-coord) extent of physical domain.

Definition at line 174 of file MOM_grid.F90.

174 real :: len_lat = 0. !< The latitudinal (or y-coord) extent of physical domain

◆ len_lon

real mom_grid::ocean_grid_type::len_lon = 0.

The longitudinal (or x-coord) extent of physical domain.

Definition at line 175 of file MOM_grid.F90.

175 real :: len_lon = 0. !< The longitudinal (or x-coord) extent of physical domain

◆ mask2dbu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::mask2dbu

0 for boundary points and 1 for ocean points on the q grid [nondim].

Definition at line 115 of file MOM_grid.F90.

   real ALLOCABLE_, dimension(NIMEMB_PTR_,NJMEMB_PTR_) :: &
     mask2dBu, &  !< 0 for boundary points and 1 for ocean points on the q grid [nondim].
     geoLatBu, &  !< The geographic latitude at q points in degrees of latitude or m.
     geoLonBu, &  !< The geographic longitude at q points in degrees of longitude or m.
     dxBu, &      !< dxBu is delta x at q points [L ~> m].
     IdxBu, &     !< 1/dxBu [L-1 ~> m-1].
     dyBu, &      !< dyBu is delta y at q points [L ~> m].
     IdyBu, &     !< 1/dyBu [L-1 ~> m-1].
     areaBu, &    !< areaBu is the area of a q-cell [L2 ~> m2]
     IareaBu      !< IareaBu = 1/areaBu [L-2 ~> m-2].

◆ mask2dcu

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::mask2dcu

0 for boundary points and 1 for ocean points on the u grid [nondim].

Definition at line 91 of file MOM_grid.F90.

   real ALLOCABLE_, dimension(NIMEMB_PTR_,NJMEM_) :: &
     mask2dCu, &  !< 0 for boundary points and 1 for ocean points on the u grid [nondim].
     geoLatCu, &  !< The geographic latitude at u points in degrees of latitude or m.
     geoLonCu, &  !< The geographic longitude at u points in degrees of longitude or m.
     dxCu, &      !< dxCu is delta x at u points [L ~> m].
     IdxCu, &     !< 1/dxCu [L-1 ~> m-1].
     dyCu, &      !< dyCu is delta y at u points [L ~> m].
     IdyCu, &     !< 1/dyCu [L-1 ~> m-1].
     dy_Cu, &     !< The unblocked lengths of the u-faces of the h-cell [L ~> m].
     IareaCu, &   !< The masked inverse areas of u-grid cells [L-2 ~> m-2].
     areaCu       !< The areas of the u-grid cells [L2 ~> m2].

◆ mask2dcv

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::mask2dcv

0 for boundary points and 1 for ocean points on the v grid [nondim].

Definition at line 103 of file MOM_grid.F90.

   real ALLOCABLE_, dimension(NIMEM_,NJMEMB_PTR_) :: &
     mask2dCv, &  !< 0 for boundary points and 1 for ocean points on the v grid [nondim].
     geoLatCv, &  !< The geographic latitude at v points in degrees of latitude or m.
     geoLonCv, &  !< The geographic longitude at v points in degrees of longitude or m.
     dxCv, &      !< dxCv is delta x at v points [L ~> m].
     IdxCv, &     !< 1/dxCv [L-1 ~> m-1].
     dyCv, &      !< dyCv is delta y at v points [L ~> m].
     IdyCv, &     !< 1/dyCv [L-1 ~> m-1].
     dx_Cv, &     !< The unblocked lengths of the v-faces of the h-cell [L ~> m].
     IareaCv, &   !< The masked inverse areas of v-grid cells [L-2 ~> m-2].
     areaCv       !< The areas of the v-grid cells [L2 ~> m2].

◆ mask2dt

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::mask2dt

0 for land points and 1 for ocean points on the h-grid [nondim].

Definition at line 76 of file MOM_grid.F90.

   real ALLOCABLE_, dimension(NIMEM_,NJMEM_) :: &
     mask2dT, &   !< 0 for land points and 1 for ocean points on the h-grid [nondim].
     geoLatT, &   !< The geographic latitude at q points in degrees of latitude or m.
     geoLonT, &   !< The geographic longitude at q points in degrees of longitude or m.
     dxT, &       !< dxT is delta x at h points [L ~> m].
     IdxT, &      !< 1/dxT [L-1 ~> m-1].
     dyT, &       !< dyT is delta y at h points [L ~> m].
     IdyT, &      !< IdyT is 1/dyT [L-1 ~> m-1].
     areaT, &     !< The area of an h-cell [L2 ~> m2].
     IareaT, &    !< 1/areaT [L-2 ~> m-2].
     sin_rot, &   !< The sine of the angular rotation between the local model grid's northward
                  !! and the true northward directions.
     cos_rot      !< The cosine of the angular rotation between the local model grid's northward

◆ max_depth

real mom_grid::ocean_grid_type::max_depth

The maximum depth of the ocean in depth units [Z ~> m].

Definition at line 177 of file MOM_grid.F90.

177 real :: max_depth !< The maximum depth of the ocean in depth units [Z ~> m].

◆ nblocks

integer mom_grid::ocean_grid_type::nblocks

The number of sub-PE blocks on this PE.

Definition at line 167 of file MOM_grid.F90.

167 integer :: nblocks !< The number of sub-PE blocks on this PE

◆ nonblocking_updates

logical mom_grid::ocean_grid_type::nonblocking_updates

If true, non-blocking halo updates are allowed. The default is .false. (for now).

Definition at line 68 of file MOM_grid.F90.

68 logical :: nonblocking_updates !< If true, non-blocking halo updates are

◆ rad_earth

real mom_grid::ocean_grid_type::rad_earth = 6.378e6

The radius of the planet [m].

Definition at line 176 of file MOM_grid.F90.

176 real :: Rad_Earth = 6.378e6 !< The radius of the planet [m].

◆ sin_rot

real, dimension( : , : ), allocatable mom_grid::ocean_grid_type::sin_rot

The sine of the angular rotation between the local model grid's northward.

Definition at line 76 of file MOM_grid.F90.

◆ south_lat

real mom_grid::ocean_grid_type::south_lat

The latitude (or y-coordinate) of the first v-line.

Definition at line 172 of file MOM_grid.F90.

172 real :: south_lat !< The latitude (or y-coordinate) of the first v-line

◆ symmetric

logical mom_grid::ocean_grid_type::symmetric

True if symmetric memory is used.

Definition at line 67 of file MOM_grid.F90.

67 logical :: symmetric !< True if symmetric memory is used.

◆ us

type(unit_scale_type), pointer mom_grid::ocean_grid_type::us => NULL()

A dimensional unit scaling type.

Definition at line 163 of file MOM_grid.F90.

163 type(unit_scale_type), pointer :: US => null() !< A dimensional unit scaling type

◆ west_lon

real mom_grid::ocean_grid_type::west_lon

The longitude (or x-coordinate) of the first u-line.

Definition at line 173 of file MOM_grid.F90.

173 real :: west_lon !< The longitude (or x-coordinate) of the first u-line

◆ x_axis_units

character(len=40) mom_grid::ocean_grid_type::x_axis_units

The units that are used in labeling the x coordinate axes.

Definition at line 136 of file MOM_grid.F90.

   character(len=40) :: &
     x_axis_units, &     !< The units that are used in labeling the x coordinate axes.
     y_axis_units        !< The units that are used in labeling the y coordinate axes.

◆ y_axis_units

character(len=40) mom_grid::ocean_grid_type::y_axis_units

The units that are used in labeling the y coordinate axes.

Definition at line 136 of file MOM_grid.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/src/core/MOM_grid.F90

Detailed Description

Public variables and constants

Variables and constants

◆ areabu

◆ areacu

◆ areacv

◆ areat

◆ areat_global

◆ bathymetry_at_vel

◆ bathyt

◆ block

◆ coriolisbu

◆ cos_rot

◆ dblock_u

◆ dblock_v

◆ df_dx

◆ df_dy

◆ domain

◆ domain_aux

◆ dopen_u

◆ dopen_v

◆ dx_cv

◆ dxbu

◆ dxcu

◆ dxcv

◆ dxt

◆ dy_cu

◆ dybu

◆ dycu

◆ dycv

◆ dyt

◆ first_direction

◆ g_earth

◆ geolatbu

◆ geolatcu

◆ geolatcv

◆ geolatt

◆ geolonbu

◆ geoloncu

◆ geoloncv

◆ geolont

◆ gridlatb

◆ gridlatt

◆ gridlonb

◆ gridlont

◆ hi

◆ hid2

◆ iareabu

◆ iareacu

◆ iareacv

◆ iareat

◆ iareat_global

◆ idg_offset

◆ idxbu

◆ idxcu

◆ idxcv

◆ idxt

◆ idybu

◆ idycu

◆ idycv

◆ idyt

◆ iec

◆ iecb

◆ ied

◆ iedb

◆ ieg

◆ iegb

◆ isc

◆ iscb

◆ isd

◆ isd_global

◆ isdb

◆ isg

◆ isgb

◆ jdg_offset

◆ jec

◆ jecb

◆ jed

◆ jedb

◆ jeg